ホーム › System.Pipes › GetNamedPipeClientSessionId

GetNamedPipeClientSessionId

関数

名前付きパイプクライアントのセッションIDを取得する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL GetNamedPipeClientSessionId(
    HANDLE Pipe,
    DWORD* ClientSessionId
);

パラメーター

名前	型	方向
Pipe	HANDLE	in
ClientSessionId	DWORD*	out

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL GetNamedPipeClientSessionId(
    HANDLE Pipe,
    DWORD* ClientSessionId
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetNamedPipeClientSessionId(
    IntPtr Pipe,   // HANDLE
    out uint ClientSessionId   // DWORD* out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetNamedPipeClientSessionId(
    Pipe As IntPtr,   ' HANDLE
    <Out> ByRef ClientSessionId As UInteger   ' DWORD* out
) As Boolean
End Function

' Pipe : HANDLE
' ClientSessionId : DWORD* out
Declare PtrSafe Function GetNamedPipeClientSessionId Lib "kernel32" ( _
    ByVal Pipe As LongPtr, _
    ByRef ClientSessionId As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetNamedPipeClientSessionId = ctypes.windll.kernel32.GetNamedPipeClientSessionId
GetNamedPipeClientSessionId.restype = wintypes.BOOL
GetNamedPipeClientSessionId.argtypes = [
    wintypes.HANDLE,  # Pipe : HANDLE
    ctypes.POINTER(wintypes.DWORD),  # ClientSessionId : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetNamedPipeClientSessionId = Fiddle::Function.new(
  lib['GetNamedPipeClientSessionId'],
  [
    Fiddle::TYPE_VOIDP,  # Pipe : HANDLE
    Fiddle::TYPE_VOIDP,  # ClientSessionId : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetNamedPipeClientSessionId(
        Pipe: *mut core::ffi::c_void,  // HANDLE
        ClientSessionId: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool GetNamedPipeClientSessionId(IntPtr Pipe, out uint ClientSessionId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetNamedPipeClientSessionId' -Namespace Win32 -PassThru
# $api::GetNamedPipeClientSessionId(Pipe, ClientSessionId)

#uselib "KERNEL32.dll"
#func global GetNamedPipeClientSessionId "GetNamedPipeClientSessionId" sptr, sptr
; GetNamedPipeClientSessionId Pipe, varptr(ClientSessionId)   ; 戻り値は stat
; Pipe : HANDLE -> "sptr"
; ClientSessionId : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetNamedPipeClientSessionId "GetNamedPipeClientSessionId" sptr, var
; res = GetNamedPipeClientSessionId(Pipe, ClientSessionId)
; Pipe : HANDLE -> "sptr"
; ClientSessionId : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetNamedPipeClientSessionId "GetNamedPipeClientSessionId" sptr, sptr
; res = GetNamedPipeClientSessionId(Pipe, varptr(ClientSessionId))
; Pipe : HANDLE -> "sptr"
; ClientSessionId : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL GetNamedPipeClientSessionId(HANDLE Pipe, DWORD* ClientSessionId)
#uselib "KERNEL32.dll"
#cfunc global GetNamedPipeClientSessionId "GetNamedPipeClientSessionId" intptr, var
; res = GetNamedPipeClientSessionId(Pipe, ClientSessionId)
; Pipe : HANDLE -> "intptr"
; ClientSessionId : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL GetNamedPipeClientSessionId(HANDLE Pipe, DWORD* ClientSessionId)
#uselib "KERNEL32.dll"
#cfunc global GetNamedPipeClientSessionId "GetNamedPipeClientSessionId" intptr, intptr
; res = GetNamedPipeClientSessionId(Pipe, varptr(ClientSessionId))
; Pipe : HANDLE -> "intptr"
; ClientSessionId : DWORD* out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetNamedPipeClientSessionId = kernel32.NewProc("GetNamedPipeClientSessionId")
)

// Pipe (HANDLE), ClientSessionId (DWORD* out)
r1, _, err := procGetNamedPipeClientSessionId.Call(
	uintptr(Pipe),
	uintptr(ClientSessionId),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function GetNamedPipeClientSessionId(
  Pipe: THandle;   // HANDLE
  ClientSessionId: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetNamedPipeClientSessionId';

result := DllCall("KERNEL32\GetNamedPipeClientSessionId"
    , "Ptr", Pipe   ; HANDLE
    , "Ptr", ClientSessionId   ; DWORD* out
    , "Int")   ; return: BOOL

●GetNamedPipeClientSessionId(Pipe, ClientSessionId) = DLL("KERNEL32.dll", "bool GetNamedPipeClientSessionId(void*, void*)")
# 呼び出し: GetNamedPipeClientSessionId(Pipe, ClientSessionId)
# Pipe : HANDLE -> "void*"
# ClientSessionId : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。