CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CLC_ErrorCode Input_GetName ( CPHOBJECT const  hInput,
CPCHAR8 const **const  putf8Name 
)

Get the input name.

Parameters
[in]hInputInput handle
[out]putf8NamePointer to string pointer filled with the input name string.
Returns
Standard CHAILink Client return code. See CLC_ErrorCode enumeration.
Remarks
If succeeded, the string pointed to by *putf8Name is valid until the next CHAILink call. The string must be copied in order to maintain it locally.
Warning
This function can only be called in CopperLan context. This means in the pseudo task CPDoProcess(), in notification handlers or in asynchronous return handlers and not in SystemDoProcess() for instance.