2.1.4.1.6 DisconnectNamedPipe

1 Description
2 Syntax
3 Parameters
4 Return
5 Examples
6 Remark
7 See Also
8 Header to Include
9 Reference

Description

Disconnects the server end of a named pipe instance from a client process.

Syntax

BOOL DisconnectNamedPipe( HANDLE hNamedPipe )

Parameters

hNamedPipe: [input] A handle to an instance of a named pipe. This handle must be created by the CreateNamedPipe function.

Return

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Examples

Remark

If the client end of the named pipe is open, the DisconnectNamedPipe function forces that end of the named pipe closed. The client receives an error the next time it attempts to access the pipe. A client that is forced off a pipe by DisconnectNamedPipe must still use the CloseHandle function to close its end of the pipe.

The pipe exists as long as a server or client process has an open handle to the pipe.