GetNamedPipeServerSessionId function (Windows)

Switch View :
ScriptFree
GetNamedPipeServerSessionId function

Applies to: desktop apps only

Retrieves the server session identifier for the specified named pipe.

Syntax

BOOL WINAPI GetNamedPipeServerSessionId(
  __in   HANDLE Pipe,
  __out  PULONG ServerSessionId
);

Parameters

Pipe [in]

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

ServerSessionId [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.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Header

Winbase.h (include Windows.h)

Library

Kernel32.lib

DLL

Kernel32.dll

See also

CreateNamedPipe
GetNamedPipeClientSessionId
Pipe Functions
Pipes Overview

 

 

Send comments about this topic to Microsoft

Build date: 2/3/2012