Library | Module

Interface IpfcExternalDataSlot



Description

Represents a single data item stored in external data
Direct Parent Classes:
IpfcObject



Property Summary

PropertyClassas IpfcExternalDataClass
Class to which slot belongs
PropertyIdas Long
Unique identifier assigned by Creo Parametric
PropertyNameas String [readonly, optional]
Slot name. Slots created using Creo Parametric TOOLKIT may not have a separate name.
PropertyValueas IpfcExternalData
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 IpfcXBadExternalDataexception will result.



Method Summary

SubDelete ()
Deletes the external data slot
FunctionIsValid () as Boolean
Returns true if the slot exists and can be accessed, false if it has been deleted.



Property Detail


PropertyClassas IpfcExternalDataClass

Class to which slot belongs

Exceptions thrown (but not limited to):

IpfcXBadExternalData - Slot is no longer valid






PropertyIdas Long

Unique identifier assigned by Creo Parametric

Exceptions thrown (but not limited to):

IpfcXBadExternalData - Slot is no longer valid






PropertyNameas String [readonly, optional]

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

Exceptions thrown (but not limited to):

IpfcXBadExternalData - Slot is no longer valid






PropertyValueas IpfcExternalData

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 IpfcXBadExternalDataexception will result.

Exceptions thrown (but not limited to):

IpfcXExternalDataTKError - The function failed.

IpfcXExternalDataInvalidObject - The model or class name is invalid.

IpfcXExternalDataBadKeyByFlag - The 'key by flag' is invalid.

IpfcXExternalDataSlotNotFound - The slot was not found.

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

IpfcXExternalDataBadDataArgs - The data type or data size is invalid.

IpfcXExternalDataEmptySlot - No data exists in the slot.

IpfcXBadExternalData - Slot is no longer valid







Method Detail


SubDelete ()

Deletes the external data slot

Permanently deletes the slot and the data it contains.

Exceptions thrown (but not limited to):

IpfcXExternalDataTKError - The function failed.

IpfcXExternalDataInvalidObject - The model or class name is invalid.

IpfcXExternalDataBadKeyByFlag - The 'key by flag' is invalid.

IpfcXExternalDataSlotNotFound - The slot was not found.

IpfcXBadExternalData - Slot is no longer valid





FunctionIsValid () as Boolean

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