SanStdAnnotationSetPlacementGet

Description

Provides the placement information for the given Std-Annotation Set within the model/drawing.

In case of a solid model, the function provides the list of combined state names, that own the Std-Annotation Set.

In case of a drawing, the indices of the corresponding drawing sheets are provided.

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.
set_name	Required	wchar_t*	Identifier of the Std-Annotation Set. Example: “std_anno_1234”.

Output arguments

Label	Value Type	Value
result	wchar_t*	Solid model: Concatenated list of combined state names. ‘\n’ is used as delimiter between each identifier. Example: “General\nInspection”. Drawing: Concatenated list of sheet indices. ‘\n’ is used as delimiter between each identifier. Example: “1\n3\n4” means sheet 1, 3 and 4.
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	Std-Annotation Set not found within the model/drawing.
PRO_TK_GENERAL_ERROR	Miscellaneous error. Check output argument array for further information.