Function ProDrawingDtlsymdefRetrieve
Description
Retrieve a symbol definition from a location relative to the directory set for the configuration option: "pro_symbol_dir". If this configuration option is not set, then the relative path is with respect to the working directory.
Replacement in Object TOOLKIT: |
Synopsis
#include <ProDtlsymdef.h>
ProDrawingDtlsymdefRetrieve | |
( ProMdl model /* (In) The drawing handle. */ ProPath filepath /* (In) The path to the file with a symbol definition. If this is NULL, then the symbol definition is located in the designated directory. */ 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. BRO_B_FALSE- Do not load new definition if the same symbol exist in the drawing. */ ProDtlsymdef* symdef /* (Out) Retrieved symbol definition. */ ) |
Returns
The function successfully retrieved the symbol definition. | |
Bad one or more input arguments. | |
Can't retrieve the symbol definition. | |
The specified symbol does not exist. | |
The specified symbol exist but was not retrieved. |
Sample Code References
User Guide References