Class pfcExternalDataClass
Description
A class that represents a named "bin" for external data so other applications will not use the data by mistake. An application usually needs one class.
Direct Parent Classes:
User Guide References:
Introduction to External Data:pfcExternalDataClass, Storing External Data:pfcExternalDataClass, Retrieving External Data:pfcExternalDataClass
Property Summary
/* readonly */ string | |
Unique name of the class for this model | |
/* readonly */ pfcExternalDataAccess | |
ExternalDataAccess object to which the class belongs |
Method Summary
CreateSlot (string Name) | |
Creates a new slot for the external data class | |
void | Delete () |
Deletes the external data class from the model | |
boolean | IsValid () |
Returns true if the class is valid and can be accessed, false if it has been deleted or it cannot be accessed. | |
ListSlots () | |
Lists all the slots available for the class |
Property Detail
/* readonly */ string | Name |
Unique name of the class for this model
Exceptions thrown (but not limited to):
pfcXBadExternalData - Class is no longer valid
/* readonly */ pfcExternalDataAccess | Parent |
ExternalDataAccess object to which the class belongs
Exceptions thrown (but not limited to):
pfcXBadExternalData - Class is no longer valid
Method Detail
CreateSlot | (string Name) |
Creates a new slot for the external data class
Exceptions thrown (but not limited to):
pfcXExternalDataTKError - The function failed.
pfcXExternalDataInvalidObject - The specified model or class name is invalid.
pfcXExternalDataClassOrSlotExists - The specified slot already exists in the specified class.
pfcXExternalDataNamesTooLong - The specified slot or class name exceeds the length PRO_NAME_SIZE.
pfcXBadExternalData - Class is no longer valid
Parameters:
Name
The unique name for the slot. This name cannot begin with a number.
Returns:
The new external data slot
User Guide References:
void | Delete | () |
Deletes the external data class from the model
Deletes permanenly the class and all its slots.
Exceptions thrown (but not limited to):
pfcXExternalDataTKError - The function failed.
pfcXExternalDataInvalidObject - The specified model or class name is invalid.
pfcXBadExternalData - Class is no longer valid
boolean | IsValid | () |
Returns true if the class is valid and can be accessed, false if it has been deleted or it cannot be accessed.
Returns:
The class status
ListSlots | () |
Lists all the slots available for the class
Note that slots created by Creo Parametric TOOLKIT applications may not have cutomized names, just numbers.
Exceptions thrown (but not limited to):
pfcXExternalDataTKError - The function failed.
pfcXExternalDataInvalidObject - The model is invalid.
pfcXExternalDataBadDataArgs - The slot ids and/or slot names are invalid.
pfcXBadExternalData - Class is no longer valid
Returns:
Sequence of external data slots
User Guide References: