CIP Visual Basic.NET documentation for interface "IpfcCheckoutOptions"

Interface IpfcCheckoutOptions

Description

This class describes checkout options.

Property Summary


`Property`	`Dependency`	`as IpfcServerDependency [optional]`
	Specifies the dependency rule while checking out dependents of the object that is selected for checkout.

`Property`	`Download`	`as Boolean [optional]`
	Specifies the checkout type as download or link. Download specifies that the object content is downloaded and checked out while link specifies that only the metadata is downloaded and checked out.

`Property`	`IncludeInstances`	`as IpfcServerIncludeInstances [optional]`
	Specifies the rule while including instances from the family table during checkout.

`Property`	`Readonly`	`as Boolean [optional]`
	Specifies the checkout type as a read-only checkout. This option is applicable only if the checkout type is link.

`Property`	`SelectedIncludes`	`as Istringseq [optional]`
	Sequence of URL's to the selected includes, if include option = SERVER_INCLUDE_SELECTED. Can be `null`

`Property`	`Version`	`as String [optional]`
	Specifies the version of the object that is checked out.

Method Summary


`Function`	`CCpfcCheckoutOptions.Create () as IpfcCheckoutOptions`
	Creates a new `IpfcCheckoutOptions` object.

Property Detail

Property Dependency as IpfcServerDependency [optional]

Specifies the dependency rule while checking out dependents of the object that is selected for checkout.

Property Download as Boolean [optional]

Specifies the checkout type as download or link. Download specifies that the object content is downloaded and checked out while link specifies that only the metadata is downloaded and checked out.

Property IncludeInstances as IpfcServerIncludeInstances [optional]

Specifies the rule while including instances from the family table during checkout.

Property Readonly as Boolean [optional]

Specifies the checkout type as a read-only checkout. This option is applicable only if the checkout type is link.

Property SelectedIncludes as Istringseq [optional]

Sequence of URL's to the selected includes, if include option = SERVER_INCLUDE_SELECTED. Can be null

Property Version as String [optional]

Specifies the version of the object that is checked out.

Method Detail

Function CCpfcCheckoutOptions.Create () as IpfcCheckoutOptions

Creates a new IpfcCheckoutOptions object.

Returns:: The new object.