Win32 API 日本語リファレンス
ホームSystem.Pipes › GetNamedPipeClientComputerNameW

GetNamedPipeClientComputerNameW

関数
名前付きパイプクライアントのコンピューター名を取得する。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL GetNamedPipeClientComputerNameW(
    HANDLE Pipe,
    LPWSTR ClientComputerName,
    DWORD ClientComputerNameLength
);

パラメーター

名前方向説明
PipeHANDLEinクライアントのコンピューター名を取得する名前付きパイプのハンドルを指定する。
ClientComputerNameLPWSTRoutクライアントのコンピューター名(Unicode)を受け取るバッファ。
ClientComputerNameLengthDWORDinClientComputerNameバッファのサイズ(バイト)を指定する。

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL GetNamedPipeClientComputerNameW(
    HANDLE Pipe,
    LPWSTR ClientComputerName,
    DWORD ClientComputerNameLength
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool GetNamedPipeClientComputerNameW(
    IntPtr Pipe,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder ClientComputerName,   // LPWSTR out
    uint ClientComputerNameLength   // DWORD
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetNamedPipeClientComputerNameW(
    Pipe As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> ClientComputerName As System.Text.StringBuilder,   ' LPWSTR out
    ClientComputerNameLength As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' Pipe : HANDLE
' ClientComputerName : LPWSTR out
' ClientComputerNameLength : DWORD
Declare PtrSafe Function GetNamedPipeClientComputerNameW Lib "kernel32" ( _
    ByVal Pipe As LongPtr, _
    ByVal ClientComputerName As LongPtr, _
    ByVal ClientComputerNameLength As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetNamedPipeClientComputerNameW = ctypes.windll.kernel32.GetNamedPipeClientComputerNameW
GetNamedPipeClientComputerNameW.restype = wintypes.BOOL
GetNamedPipeClientComputerNameW.argtypes = [
    wintypes.HANDLE,  # Pipe : HANDLE
    wintypes.LPWSTR,  # ClientComputerName : LPWSTR out
    wintypes.DWORD,  # ClientComputerNameLength : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetNamedPipeClientComputerNameW = Fiddle::Function.new(
  lib['GetNamedPipeClientComputerNameW'],
  [
    Fiddle::TYPE_VOIDP,  # Pipe : HANDLE
    Fiddle::TYPE_VOIDP,  # ClientComputerName : LPWSTR out
    -Fiddle::TYPE_INT,  # ClientComputerNameLength : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn GetNamedPipeClientComputerNameW(
        Pipe: *mut core::ffi::c_void,  // HANDLE
        ClientComputerName: *mut u16,  // LPWSTR out
        ClientComputerNameLength: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode)]
public static extern bool GetNamedPipeClientComputerNameW(IntPtr Pipe, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder ClientComputerName, uint ClientComputerNameLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetNamedPipeClientComputerNameW' -Namespace Win32 -PassThru
# $api::GetNamedPipeClientComputerNameW(Pipe, ClientComputerName, ClientComputerNameLength)
#uselib "KERNEL32.dll"
#func global GetNamedPipeClientComputerNameW "GetNamedPipeClientComputerNameW" wptr, wptr, wptr
; GetNamedPipeClientComputerNameW Pipe, varptr(ClientComputerName), ClientComputerNameLength   ; 戻り値は stat
; Pipe : HANDLE -> "wptr"
; ClientComputerName : LPWSTR out -> "wptr"
; ClientComputerNameLength : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetNamedPipeClientComputerNameW "GetNamedPipeClientComputerNameW" sptr, var, int
; res = GetNamedPipeClientComputerNameW(Pipe, ClientComputerName, ClientComputerNameLength)
; Pipe : HANDLE -> "sptr"
; ClientComputerName : LPWSTR out -> "var"
; ClientComputerNameLength : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetNamedPipeClientComputerNameW(HANDLE Pipe, LPWSTR ClientComputerName, DWORD ClientComputerNameLength)
#uselib "KERNEL32.dll"
#cfunc global GetNamedPipeClientComputerNameW "GetNamedPipeClientComputerNameW" intptr, var, int
; res = GetNamedPipeClientComputerNameW(Pipe, ClientComputerName, ClientComputerNameLength)
; Pipe : HANDLE -> "intptr"
; ClientComputerName : LPWSTR out -> "var"
; ClientComputerNameLength : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetNamedPipeClientComputerNameW = kernel32.NewProc("GetNamedPipeClientComputerNameW")
)

// Pipe (HANDLE), ClientComputerName (LPWSTR out), ClientComputerNameLength (DWORD)
r1, _, err := procGetNamedPipeClientComputerNameW.Call(
	uintptr(Pipe),
	uintptr(ClientComputerName),
	uintptr(ClientComputerNameLength),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function GetNamedPipeClientComputerNameW(
  Pipe: THandle;   // HANDLE
  ClientComputerName: PWideChar;   // LPWSTR out
  ClientComputerNameLength: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetNamedPipeClientComputerNameW';
result := DllCall("KERNEL32\GetNamedPipeClientComputerNameW"
    , "Ptr", Pipe   ; HANDLE
    , "Ptr", ClientComputerName   ; LPWSTR out
    , "UInt", ClientComputerNameLength   ; DWORD
    , "Int")   ; return: BOOL
●GetNamedPipeClientComputerNameW(Pipe, ClientComputerName, ClientComputerNameLength) = DLL("KERNEL32.dll", "bool GetNamedPipeClientComputerNameW(void*, char*, dword)")
# 呼び出し: GetNamedPipeClientComputerNameW(Pipe, ClientComputerName, ClientComputerNameLength)
# Pipe : HANDLE -> "void*"
# ClientComputerName : LPWSTR out -> "char*"
# ClientComputerNameLength : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn GetNamedPipeClientComputerNameW(
    Pipe: ?*anyopaque, // HANDLE
    ClientComputerName: [*c]u16, // LPWSTR out
    ClientComputerNameLength: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetNamedPipeClientComputerNameW(
    Pipe: pointer,  # HANDLE
    ClientComputerName: ptr uint16,  # LPWSTR out
    ClientComputerNameLength: uint32  # DWORD
): int32 {.importc: "GetNamedPipeClientComputerNameW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int GetNamedPipeClientComputerNameW(
    void* Pipe,   // HANDLE
    wchar* ClientComputerName,   // LPWSTR out
    uint ClientComputerNameLength   // DWORD
);
ccall((:GetNamedPipeClientComputerNameW, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{UInt16}, UInt32),
      Pipe, ClientComputerName, ClientComputerNameLength)
# Pipe : HANDLE -> Ptr{Cvoid}
# ClientComputerName : LPWSTR out -> Ptr{UInt16}
# ClientComputerNameLength : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetNamedPipeClientComputerNameW(
    void* Pipe,
    uint16_t* ClientComputerName,
    uint32_t ClientComputerNameLength);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetNamedPipeClientComputerNameW(Pipe, ClientComputerName, ClientComputerNameLength)
-- Pipe : HANDLE
-- ClientComputerName : LPWSTR out
-- ClientComputerNameLength : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetNamedPipeClientComputerNameW = lib.func('__stdcall', 'GetNamedPipeClientComputerNameW', 'int32_t', ['void *', 'uint16_t *', 'uint32_t']);
// GetNamedPipeClientComputerNameW(Pipe, ClientComputerName, ClientComputerNameLength)
// Pipe : HANDLE -> 'void *'
// ClientComputerName : LPWSTR out -> 'uint16_t *'
// ClientComputerNameLength : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetNamedPipeClientComputerNameW: { parameters: ["pointer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.GetNamedPipeClientComputerNameW(Pipe, ClientComputerName, ClientComputerNameLength)
// Pipe : HANDLE -> "pointer"
// ClientComputerName : LPWSTR out -> "buffer"
// ClientComputerNameLength : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetNamedPipeClientComputerNameW(
    void* Pipe,
    uint16_t* ClientComputerName,
    uint32_t ClientComputerNameLength);
C, "KERNEL32.dll");
// $ffi->GetNamedPipeClientComputerNameW(Pipe, ClientComputerName, ClientComputerNameLength);
// Pipe : HANDLE
// ClientComputerName : LPWSTR out
// ClientComputerNameLength : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.UNICODE_OPTIONS);
    boolean GetNamedPipeClientComputerNameW(
        Pointer Pipe,   // HANDLE
        char[] ClientComputerName,   // LPWSTR out
        int ClientComputerNameLength   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun GetNamedPipeClientComputerNameW = GetNamedPipeClientComputerNameW(
    Pipe : Void*,   # HANDLE
    ClientComputerName : UInt16*,   # LPWSTR out
    ClientComputerNameLength : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetNamedPipeClientComputerNameWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Uint32);
typedef GetNamedPipeClientComputerNameWDart = int Function(Pointer<Void>, Pointer<Utf16>, int);
final GetNamedPipeClientComputerNameW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetNamedPipeClientComputerNameWNative, GetNamedPipeClientComputerNameWDart>('GetNamedPipeClientComputerNameW');
// Pipe : HANDLE -> Pointer<Void>
// ClientComputerName : LPWSTR out -> Pointer<Utf16>
// ClientComputerNameLength : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetNamedPipeClientComputerNameW(
  Pipe: THandle;   // HANDLE
  ClientComputerName: PWideChar;   // LPWSTR out
  ClientComputerNameLength: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetNamedPipeClientComputerNameW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetNamedPipeClientComputerNameW"
  c_GetNamedPipeClientComputerNameW :: Ptr () -> CWString -> Word32 -> IO CInt
-- Pipe : HANDLE -> Ptr ()
-- ClientComputerName : LPWSTR out -> CWString
-- ClientComputerNameLength : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getnamedpipeclientcomputernamew =
  foreign "GetNamedPipeClientComputerNameW"
    ((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* Pipe : HANDLE -> (ptr void) *)
(* ClientComputerName : LPWSTR out -> (ptr uint16_t) *)
(* ClientComputerNameLength : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetNamedPipeClientComputerNameW" get-named-pipe-client-computer-name-w :convention :stdcall) :int32
  (pipe :pointer)   ; HANDLE
  (client-computer-name :pointer)   ; LPWSTR out
  (client-computer-name-length :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetNamedPipeClientComputerNameW = Win32::API::More->new('KERNEL32',
    'BOOL GetNamedPipeClientComputerNameW(HANDLE Pipe, LPWSTR ClientComputerName, DWORD ClientComputerNameLength)');
# my $ret = $GetNamedPipeClientComputerNameW->Call($Pipe, $ClientComputerName, $ClientComputerNameLength);
# Pipe : HANDLE -> HANDLE
# ClientComputerName : LPWSTR out -> LPWSTR
# ClientComputerNameLength : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い