Category Features, Object ProUdfdata

Function ProUdfdataInstancenamesGet


Description
Obtains an array of the instance names that may be used when placing this UDF.
Synopsis
#include <ProUdf.h>
ProErrorProUdfdataInstancenamesGet(
ProUdfdata data
/* (In)
The UDF data.
*/
ProName** instance_names
/* (Out)
ProArray of instance names available in this UDF. Free this array using ProArrayFree().
*/
)
Returns
PRO_TK_NO_ERRORThe function succeeded.
PRO_TK_BAD_INPUTSOne or more input arguments was invalid.
PRO_TK_E_NOT_FOUNDThis UDF does not have stored instances.
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_NO_LICENSENo license is available for this function.

Manual References:

  1. Core: Features: Instance Names

Sample Code References:

  1. pt_udf_examples ( PTUDFExDashboardUtils.c )