CIP JavaScript documentation for class " pfcExternalDataSlot"

Class pfcExternalDataSlot

Description

Represents a single data item stored in external data

Direct Parent Classes:: pfcObject

Property Summary


`/* readonly */ pfcExternalDataClass`	`Class`
	Class to which slot belongs

`/* readonly */ number`	`Id`
	Unique identifier assigned by Creo Parametric

`/* readonly / / optional */ string`	`Name`
	Slot name. Slots created using Creo Parametric TOOLKIT may not have a separate name.

`pfcExternalData`	`Value`
	The value (integer, double, or string) stored in the slot. Stream-type slots created byCreo Parametric TOOLKIT cannot be accessed by this attribute and an `pfcXBadExternalData`exception will result.

Method Summary


`void`	`Delete ()`
	Deletes the external data slot

`boolean`	`IsValid ()`
	Returns true if the slot exists and can be accessed, false if it has been deleted.

Property Detail

/* readonly */ pfcExternalDataClass Class

Class to which slot belongs

Exceptions thrown (but not limited to):

pfcXBadExternalData - Slot is no longer valid

/* readonly */ number Id

Unique identifier assigned by Creo Parametric

Exceptions thrown (but not limited to):

pfcXBadExternalData - Slot is no longer valid

/* readonly */ /* optional */ string Name

Slot name. Slots created using Creo Parametric TOOLKIT may not have a separate name.

Exceptions thrown (but not limited to):

pfcXBadExternalData - Slot is no longer valid

pfcExternalData Value

The value (integer, double, or string) stored in the slot. Stream-type slots created byCreo Parametric TOOLKIT cannot be accessed by this attribute and an pfcXBadExternalDataexception will result.

Exceptions thrown (but not limited to):

pfcXExternalDataTKError - The function failed.

pfcXExternalDataInvalidObject - The model or class name is invalid.

pfcXExternalDataBadKeyByFlag - The 'key by flag' is invalid.

pfcXExternalDataSlotNotFound - The slot was not found.

pfcXExternalDataStreamTooLarge - The stream data size is greater than 524288 bytes.

pfcXExternalDataBadDataArgs - The data type or data size is invalid.

pfcXExternalDataEmptySlot - No data exists in the slot.

pfcXBadExternalData - Slot is no longer valid

Method Detail

void Delete ()

Deletes the external data slot

Permanently deletes the slot and the data it contains.

Exceptions thrown (but not limited to):

pfcXExternalDataTKError - The function failed.

pfcXExternalDataInvalidObject - The model or class name is invalid.

pfcXExternalDataBadKeyByFlag - The 'key by flag' is invalid.

pfcXExternalDataSlotNotFound - The slot was not found.

pfcXBadExternalData - Slot is no longer valid

boolean IsValid ()

Returns true if the slot exists and can be accessed, false if it has been deleted.

Returns:: The status of the slot