Category Features, Object ProUdf

Function ProUdfDimensionNameGet


Description
Retrieves the dimension name in a user-defined feature (UDF). This is the symbol of the dimension in the original model at the time the group was created. It is the same in all UDFs made from the same group. This symbol is needed when placing a new instance of the UDF using Creo Parametric TOOLKIT.

If you want the unique dimension symbol, use ProDimensionSymbolGet.
Replacement in Object TOOLKIT: pfcUDFDimension::UDFDimensionName
Synopsis
#include <ProUdf.h>
ProErrorProUdfDimensionNameGet(
ProGroup* udf
/* (In)
The UDF group.
*/
ProDimension* dimension
/* (In)
The dimension.
*/
ProLine name
/* (Out)
The symbol for the dimension in the UDF reference model.
*/
)
Returns
PRO_TK_NO_ERRORThe function succeeded.
PRO_TK_BAD_INPUTSOne or more input arguments was invalid.
PRO_TK_BAD_CONTEXTThe group is not a UDF.
OtherThe visit was terminated by an error from the visit function

Manual References:

  1. Pro/DEVELOP to Creo Toolkit Function Mapping: Equivalent Pro/DEVELOP Functions
  2. Core: Features: Group Information
  3. Core: Features: Variable Dimensions and Pattern Parameters