Category Features, Object ProUdfreference

Function ProUdfreferenceAlloc


Description
Allocate and set a ProUdfreference structure which describes a reference for a UDF
Synopsis
#include <ProUdf.h>
ProErrorProUdfreferenceAlloc(
ProLine prompt
/* (In)
The prompt defined for the reference in the UDF
*/
ProSelection ref_item
/* (In)
The item to be referenced. Allowed to be NULL only if this is a Annotation Element reference which will be left as incomplete after UDF placement
*/
ProBoolean external
/* (In)
Whether the reference is to an item which is referenced though a parent assembly of the solid owning the UDF
*/
ProUdfreference* reference
/* (Out)
The allocated ProUdfreference structure
*/
)
Returns
PRO_TK_NO_ERRORThe function succeeded.
PRO_TK_BAD_INPUTSOne or more input arguments was invalid.
PRO_TK_INVALID_TYPEThe selected item is an embedded datum and cannot be used as UDF reference.
See Also
ProUdfdataReferenceAdd

Manual References:

  1. Core: Features: UDF References
  2. Core: Features: UDF References

Sample Code References:

  1. pt_udf_examples ( PTUDFExUDFPlacementDashboard.c )