CIP C++ documentation for class "pfcCheckinOptions"

Class pfcCheckinOptions

# include <pfcServer.h> class pfcCheckinOptions : public virtual pfcUploadBaseOptions { xdeclare(pfcCheckinOptions) ... }; This is a COMPACT class.

Description

This class describes checkin options.

Manual References:: Windchill Connectivity APIs: CheckIn

Method Summary


`static pfcCheckinOptions_ptr`	`Create ()`
	Creates a new `pfcCheckinOptions` object.

`optional xstring`	`GetBaselineLifecycle ()`
`void`	`SetBaselineLifecycle (optional xrstring value)`
	Specifies the name of the lifecycle.

`optional xstring`	`GetBaselineLocation ()`
`void`	`SetBaselineLocation (optional xrstring value)`
	Specifies the location of the baseline.

`optional xstring`	`GetBaselineName ()`
`void`	`SetBaselineName (optional xrstring value)`
	Specifies the name of the baseline.`null` means not to create any baseline

`optional xstring`	`GetBaselineNumber ()`
`void`	`SetBaselineNumber (optional xrstring value)`
	Specifies the number of the baseline.

`optional xbool`	`GetKeepCheckedout ()`
`void`	`SetKeepCheckedout (optional xbool value)`
	Specifies the checked out status of the object .If the value specified is true, then the contents of the selected object are checked in to the Windchill server and automatically checked out again for further modification.

Methods Inherited from Class pfcUploadBaseOptions:: GetDefaultFolder, SetDefaultFolder, GetNonDefaultFolderAssignments, SetNonDefaultFolderAssignments, GetAutoresolveOption, SetAutoresolveOption

Method Detail

`optional xstring`	`GetBaselineName`	`()`
`void`	`SetBaselineName`	`(optional xrstring value)`

Specifies the name of the baseline.null means not to create any baseline

Manual References:: Windchill Connectivity APIs: CheckIn

`optional xstring`	`GetBaselineNumber`	`()`
`void`	`SetBaselineNumber`	`(optional xrstring value)`

Specifies the number of the baseline.

Manual References:: Windchill Connectivity APIs: CheckIn

`optional xstring`	`GetBaselineLocation`	`()`
`void`	`SetBaselineLocation`	`(optional xrstring value)`

Specifies the location of the baseline.

Manual References:: Windchill Connectivity APIs: CheckIn

`optional xstring`	`GetBaselineLifecycle`	`()`
`void`	`SetBaselineLifecycle`	`(optional xrstring value)`

Specifies the name of the lifecycle.

Manual References:: Windchill Connectivity APIs: CheckIn

`optional xbool`	`GetKeepCheckedout`	`()`
`void`	`SetKeepCheckedout`	`(optional xbool value)`

Specifies the checked out status of the object .If the value specified is true, then the contents of the selected object are checked in to the Windchill server and automatically checked out again for further modification.

Manual References:: Windchill Connectivity APIs: CheckIn

static pfcCheckinOptions_ptr Create ()

Creates a new pfcCheckinOptions object.

Manual References:: Windchill Connectivity APIs: CheckIn, Windchill Connectivity APIs: CheckIn

Returns:: The new object.