CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CLC_ErrorCode Pipe_GetPipeInfo ( CPHOBJECT const  hPipe,
CPPIPEINFO *const  pPipeInfo 
)

Get pipe Informations.

This functions replace various "getters" in IPipe

Parameters
[in]hPipePipe handle
[out]pPipeInfoPointer to a structure filled with pipe informations (see CPPIPEINFO structure for details).
Returns
Standard CHAILink Client return code. See CLC_ErrorCode enumeration.
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.