Category Features, Object ProUdfdata

Function ProUdfdataVarparamsGet


Description
Obtains an array of available variant parameters or annotation values that may be set when placing this UDF.

NOTE: Handles obtained from this function call are not automatically assigned to the UDF for placment. In order to place the UDF with a user-defined variant parameter or annotation value, you must use ProUdfdataVarparamAdd.
Synopsis
#include <ProUdf.h>
ProErrorProUdfdataVarparamsGet(
ProUdfdata data
/* (In)
The UDF data
*/
ProUdfvarparam** variant_params
/* (Out)
ProArray of variant items that may be set upon placement of this UDF. Free this using ProUdfvarparamProarrayFree().
*/
)
Returns
PRO_TK_NO_ERRORThe function succeeded.
PRO_TK_BAD_INPUTSOne or more input arguments was invalid.
PRO_TK_BAD_CONTEXTCannot access the UDF data because the name and path have not been set.
PRO_TK_CANT_OPENCannot access the UDF .gph file at the path specified.
PRO_TK_E_NOT_FOUNDThis UDF does not have any variable items.
PRO_TK_NO_LICENSENo license is available for this function.

Manual References:

  1. Core: Features: Variable Parameters
  2. Core: Features: Variable Parameters

Sample Code References:

  1. pt_udf_examples ( PTUDFExDashboardUtils.c )