CIP Visual Basic.NET documentation for interface "IpfcExternalDataAccess"

Interface IpfcExternalDataAccess

Description

Object that represents a conduit to the external data stored in the Creo Parametric file.

To make the external data available for the next session of Creo Parametric save the model.

Direct Parent Classes:: IpfcChild

Method Summary


`Function`	`CreateClass (Name as String) as IpfcExternalDataClass`
	Creates a class in the model's external data.

`Function`	`IsValid () as Boolean`
	Returns true if this object is still valid for this model, false if access has been terminated

`Function`	`ListClasses () as IpfcExternalDataClasses`
	Lists all of the external data classes for the model

`Sub`	`LoadAll ()`
	Loads all of the model's external data into memory.

`Sub`	`ReleaseDataBuffer (data as IpfcExternalData)`
	Frees the memory allocated for data buffer.

Method Detail

Function CreateClass (Name as String) as IpfcExternalDataClass

Creates a class in the model's external data.

Exceptions thrown (but not limited to):

IpfcXExternalDataTKError - The function failed.

IpfcXExternalDataInvalidObject - The specified model or class name is invalid.

IpfcXExternalDataClassOrSlotExists - The specified class name already exists.

IpfcXExternalDataNamesTooLong - The specified class name exceeds the length 32.

IpfcXBadExternalData - Data access object is no longer valid

Parameters:

Name: Name for the class. This must be unique, and typically reflects the name and/or purpose ofthe application.

Returns:: Object representing the new external data class.

Function IsValid () as Boolean

Returns true if this object is still valid for this model, false if access has been terminated

Returns:: The status

Function ListClasses () as IpfcExternalDataClasses

Lists all of the external data classes for the model

Exceptions thrown (but not limited to):

IpfcXExternalDataTKError - The function failed.

IpfcXExternalDataInvalidObject - The specified model is invalid.

IpfcXBadExternalData - Data access object is no longer valid

Returns:: Sequence of class objects.

Sub LoadAll ()

Loads all of the model's external data into memory.

Using this method can improve the performance of reading the model data.

Exceptions thrown (but not limited to):

IpfcXExternalDataTKError - The function failed.

IpfcXExternalDataInvalidObject - The specified model is invalid.

IpfcXBadExternalData - Data access object is no longer valid

Sub ReleaseDataBuffer (data as IpfcExternalData)

Frees the memory allocated for data buffer.

Parameters:

data