CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CLC_ErrorCode Pipe_RemoveConnectionByIndex ( CPHOBJECT const  hPipe,
CPUINT16 const  wConnectionIndex 
)

Remove a connection by index.

Parameters
[in]hPipePipe handle
[in]wConnectionIndexIndex of the connection to be removed.
Returns
Standard CHAILink Client return code. See CLC_ErrorCode enumeration. /remark CAUTION: calling this method implicitly flush before performing the action.
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.