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.
Replacement in Object TOOLKIT: |
Synopsis
#include <ProUdf.h>
ProUdfdataVarparamsGet | |
( 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
The function succeeded. | |
One or more input arguments was invalid. | |
Cannot access the UDF data because the name and path have not been set. | |
Cannot access the UDF .gph file at the path specified. | |
This UDF does not have any variable items. | |
No license is available for this function. |
Sample Code References