Category Parameters and relations, Object ProParameter

Function ProParameterDescriptionGet


Description
Obtains the parameter's description .
Replacement in Object TOOLKIT: pfcParameter::Description
Synopsis
#include <ProParameter.h>
ProErrorProParameterDescriptionGet(
ProParameter* param
/* (In)
The parameter.
*/
wchar_t** description
/* (Out)
The parameter description.
*/
)
Returns
PRO_TK_NO_ERRORThe function succeeded.
PRO_TK_BAD_INPUTSOne or more input arguments was invalid.
PRO_TK_E_NOT_FOUNDThe parameter's description is not set.

Manual References:

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

Sample Code References:

  1. pt_udf_examples ( PTUDFExParamInfo.c )