Category Creo Parametric TOOLKIT fundamentals, Object ProExtdata

Function ProExtdataSlotRead


Description
Reads the data from the specified slot.
Replacement in Object TOOLKIT: pfcExternalDataSlot::Value
Synopsis
#include <ProExtdata.h>
ProExtdataErrProExtdataSlotRead(
ProExtdataSlot* p_extslot
/* (In)
The handle to the data slot.
*/
int key_by_flag
/* (In)
The key-by flag -- either KEY_BY_ID or KEY_BY_NAME.
*/
int* data_type
/* (Out)
The data type. The valid types are PRO_INTEGER_TYPE, PRO_DOUBLE_TYPE, PRO_WIDE_STRING_TYPE, PRO_STREAM_TYPE, PRO_CHAPTER_TYPE. PRO_CHAPTER_TYPE behaves similar to PRO_STREAM_TYPE but has no data length limit.
*/
int* data_size
/* (Out)
The size of the data. This argument applies to PRO_STREAM_TYPE only.
*/
void** r_p_data
/* (Out)
The returned data handle.
*/
)
Returns
PROEXTDATA_TK_NO_ERRORThe function successfully read data from the specified slot.
PROEXTDATA_TK_ERRORThe function failed.
PROEXTDATA_TK_INVALID_OBJ_OR_CLASSThe specified model or class name is invalid.
PROEXTDATA_TK_BAD_KEY_BY_FLAGThe specified key_by_flag is invalid.
PROEXTDATA_TK_SLOT_NOT_FOUNDThe specified slot was not found.
PROEXTDATA_TK_BAD_DATA_ARGSThe data_size is NULL.
PROEXTDATA_TK_EMPTY_SLOTNo data exists in the slot.

Manual References:

  1. Pro/DEVELOP to Creo Parametric TOOLKIT Function Mapping: Equivalent Pro/DEVELOP Functions
  2. Core: External Data: Retrieving External Data
  3. Core: External Data: Retrieving External Data

Sample Code References:

  1. pt_examples ( TestAnalysis.c )
  2. pt_examples ( TestGenedata.c )
  3. pt_examples ( TestGenedata.c )
  4. pt_userguide ( UgExtAnalysisSurfcsys.c )