Category Parameters and relations, Object ProParameter

Function ProParameterValueWithUnitsGet


Description
Retrieves the value and units of the specified ProParameter.
Replacement in Object TOOLKIT: wfcWParameter::GetValueWithUnits
Synopsis
#include <ProParameter.h>
ProErrorProParameterValueWithUnitsGet(
ProParameter* param
/* (In)
The handle to the parameter to query
*/
ProParamvalue* proval
/* (Out)
The value currently held in the ProParameter The value is assumed to be in the specified units. Pass units as NULL to get value in units of owner model
*/
ProUnititem* units
/* (Out)
The units in which the value is expressed. Pass NULL if unit is not required. If none found, an empty string will be returned.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully retrieved the information. Parameter could be unitless.
PRO_TK_E_NOT_FOUNDThe owner was not found.
PRO_TK_BAD_INPUTSOne or more arguments was invalid.
PRO_TK_GENERAL_ERRORThe parameter was not found, or the function could not perform the action.

Manual References:

  1. Pro/DEVELOP to Creo Toolkit Function Mapping: Equivalent Pro/DEVELOP Functions
  2. Assembly: Data Sharing Features: Accessing Properties of Variant Features
  3. Core: Parameters: Accessing Parameters
  4. Core: Parameters: Accessing Parameters

Sample Code References:

  1. pt_af_examples ( PTAFExampleUtils.c )
  2. pt_af_examples ( PTAFExampleUtils.c )
  3. pt_af_examples ( PTMfgTemplateBOM.c )
  4. pt_examples ( TestParams.c )
  5. pt_examples ( TestParams.c )
  6. pt_mfg_proctable ( PTMfgProcTable.c )
  7. pt_userguide ( UgModelCheck.c )
  8. pt_userguide ( UgWeld.c )
  9. pt_wc_server ( PTWCServerAddInstance.c )
  10. pt_wc_server ( PTWCServerAddInstance.c )