GetNamedPipeClientSessionId function

Retrieves the client session identifier for the specified named pipe.

Syntax


BOOL WINAPI GetNamedPipeClientSessionId(
  _In_  HANDLE Pipe,
  _Out_ PULONG ClientSessionId
);

Parameters

Pipe [in]

A handle to an instance of a named pipe. This handle must be created by the CreateNamedPipe function.

ClientSessionId [out]

The session identifier.

Return value

If the function succeeds, the return value is nonzero.

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

Remarks

Windows 10, version 1709:  Pipes are only supported within an app-container; ie, from one UWP process to another UWP process that's part of the same app. Also, named pipes must use the syntax "\\.\pipe\LOCAL\" for the pipe name.

Requirements

Minimum supported client

Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 [desktop apps | Windows Store apps]

Header

Winbase.h (include Windows.h)

Library

Kernel32.lib

DLL

Kernel32.dll

See also

CreateNamedPipe
GetNamedPipeServerSessionId
Pipe Functions
Pipes Overview

 

 

Show: