Category Solids and parts, Object ProSolid

Function ProSolidDtlsymdefRetrieve


Description
Retrieve a symbol definition.
Licensing Requirement
TOOLKIT for 3D Drawings
Synopsis
#include <ProDtlsymdef.h>
ProErrorProSolidDtlsymdefRetrieve(
ProSolid solid
/* (In)
The solid model handle.
*/
ProDtlsymdefSource location
/* (In)
The location to search for the symbol definition file.
*/
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. Pass PRO_VALUE_UNUSED to get the latest version.
*/
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
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. Annotations: Annotation Features and Annotations: Surface Finish Annotations
  2. Annotations: Annotation Features and Annotations: Locating and Collecting 3D Symbols and Symbol Definitions
  3. Annotations: Annotation Features and Annotations: Locating and Collecting 3D Symbols and Symbol Definitions