pipt_descriptor

This function retrieves the descriptor attribute for a point.

Note: Starting with PI-API 1.4.0 this function has been deprecated in favor of  pipt_descriptorx,  which supports descriptors greater than 26 characters long.

C format

int32 pipt_descriptor(

int32 pt,

char PIPTR * descriptor,

int32 len );

Returns

>0

System error

0

Success

-1

Point does not exist

 

Arguments

pt (passed)

Point number

descriptor (returned)

Descriptor buffer.

len (passed)

Length of the descriptor character buffer being passed

Usage Notes

If the passed descriptor buffer is not large enough to hold the full descriptor, the function will truncate and null-terminate the returned string and return success (0).

Enabling Operational Intelligence