CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CLC_ErrorCode LocalDevice_GetPipeFromID ( CPHOBJECT const  hLocalDevice,
CPUINT16 const  wPipeID,
CPHOBJECT *const  phPipe 
)

Get the specified Pipe.

Parameters
[in]hLocalDeviceHandle to the local device.
[in]wPipeIDrequested Pipe ID
[out]phPipePointer to the handle to the requested pipe, or CPHOBJECT_NULL if no pipe with the specified ID.
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.