Category Drawings and detail, Object ProDrawing

Function ProDrawingSystemDtlsymdefRetrieve


Description
Retrieve a symbol definition from the system symbol directory to the specified drawing.
Synopsis
#include <ProDtlsymdef.h>
ProErrorProDrawingSystemDtlsymdefRetrieve(
ProMdl model
/* (In)
The drawing handle.
*/
ProPath filepath
/* (In)
The path to the file with a symbol definition. This path is a relative path to the user symbol directory which is defined as either the value of the configuration option 'pro_symbol_dir' or the Creo Parametric working directory if 'pro_symbol_dir' is not set.
*/
ProName filename
/* (In)
The name of the symbol definition file.
*/
int version
/* (In)
The version of the symbol definition file. Use PRO_VALUE_UNUSED to retrieve the latest version of the symbol definition file.
*/
ProBoolean update
/* (In)
Update flag. PRO_B_TRUE- Update the existing symbol definition unconditionally. PRO_B_FALSE- Do not load new definition if the same symbol exist in the drawing.
*/
ProDtlsymdef* symdef
/* (Out)
Retrieved symbol definition.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully retrieved the symbol definition.
PRO_TK_BAD_INPUTSBad one or more input arguments.
PRO_TK_GENERAL_ERRORCan't retrieve the symbol definition.
PRO_TK_E_NOT_FOUNDThe specified symbol does not exist.
PRO_TK_E_FOUNDThe specified symbol exist but was not retrieved.

Manual References:

  1. Drawings: Retrieving a Symbol Definition from Disk