SanStdAnnotationUserProfileImport

Description

Import Std-Annotation Sets via User Profile (XML) into model/drawing. The symbol stack will be updated.

If a Std-Annotation Set is already created in a model/drawing, several blocks that are contained in the User Profile but not in the drawing/model will be added to the existing symbol stack. In this case the placement (i.e. drawing sheets or rather combined states) is not changed.

Synopsis

Input arguments

Label	Use	Value Type	Value
Model Arguments	Optional	—	Input arguments to initialize the model handle to be operated. If not provided, model of active window is used.
file_path	Required	wchar_t*	Full file path of the User Profile ending with extension “.xml”. Reading access is required.
placement	Optional	wchar_t*	Concatenated list of Std-Annotation Set names combined with the placement information that defines wherein to create the Set. The Std-Annotation Set names are the auto-created identifiers, that can be found by editing a Set definition via the Configuration dialog. Value format: <Set identifier>\|<placement data>\n<Set identifier>\|<placement data>\n<Set identifier>\|<placement data>... Use ‘\n’ as delimiter to separate the various Std-Annotation Sets and their placement data. The Std-Annotation Set identifiers have to be separated from the placement data by a ‘\|’. Refer to the chapter Placement Patterns on how to build the rule string that defines to which drawing sheets (2D) or rather combined states (3D) an imported Std-Annotation Set shall be assigned. Model type dependent examples: Drawing: std_anno_1234\|1;3\nstd_anno_5678\|2 Solid: std_anno_1234\|INSPECT;GENERAL\nstd_anno_5678\|MANUFACTURING If no placement information is provided for a Set, then the default settings from the configuration are used. If a Set is imported that has already been created in the drawing/model, then the provided placement data is ignored to maintain the existing placement.

Output arguments

Label	Value Type	Value
Error Information	—	Error information in case of return value PRO_TK_GENERAL_ERROR.

Returns

PRO_TK_NO_ERROR	The function succeeded.
PRO_TK_BAD_INPUTS	One or more input argument is invalid.
PRO_TK_E_NOT_FOUND	One or more Std-Annotation Sets contained in the User Profile was not found within the configuration.
PRO_TK_CANT_ACCESS	No reading access to provided file path.
PRO_TK_GENERAL_ERROR	Miscellaneous error. Check output argument array for further information.