Category Parameters and relations, Object ProParameter

Function ProParameterWithUnitsCreate


Description
Adds the specified parameter to the database and initializes the handle. The parameter will be created with units.
Replacement in Object TOOLKIT: pfcParameterOwner::CreateParamWithUnits
Synopsis
#include <ProParameter.h>
ProErrorProParameterWithUnitsCreate(
ProModelitem* owner
/* (In)
The owner (a model item or solid)
*/
ProName name
/* (In)
The name of the ProParameter
*/
ProParamvalue* proval
/* (In)
The initial data the ProParameter will hold.
*/
ProUnititem* units
/* (In)
The units assigned to this parameter. To create a parameter without units, pass NULL.
*/
ProParameter* param
/* (Out)
The handle to create and initialize
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully added the parameter.
PRO_TK_BAD_INPUTSOne or more of the input arguments are invalid.
PRO_TK_BAD_CONTEXTThe owner is nonexistent.
PRO_TK_E_FOUNDThe specified parameter already exists.
PRO_TK_GENERAL_ERRORThe function could not add the parameter to the database.
PRO_TK_NOT_VALIDThe specified parameter is invalid.
See Also
ProParameterCreate

Manual References:

  1. Core: Parameters: Accessing Parameters
  2. Core: Parameters: Accessing Parameters

Sample Code References:

  1. pt_userguide ( UgGeomSurfArea.c )
  2. pt_userguide ( UgMaterial.c )
  3. pt_userguide ( UgParamFeatLabel.c )