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

WdsCliInitializeLog

関数
クライアント情報を指定してWDSセッションのログを初期化する。
DLLWDSCLIENTAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT WdsCliInitializeLog(
    HANDLE hSession,
    CPU_ARCHITECTURE ulClientArchitecture,
    LPWSTR pwszClientId,
    LPWSTR pwszClientAddress
);

パラメーター

名前方向説明
hSessionHANDLEinログを初期化する対象のWDSセッションハンドル。
ulClientArchitectureCPU_ARCHITECTUREinクライアントのCPUアーキテクチャを示すCPU_ARCHITECTURE値。
pwszClientIdLPWSTRinクライアントを識別する文字列(Unicode)。
pwszClientAddressLPWSTRinクライアントのアドレスを示す文字列(Unicode)。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WdsCliInitializeLog(
    HANDLE hSession,
    CPU_ARCHITECTURE ulClientArchitecture,
    LPWSTR pwszClientId,
    LPWSTR pwszClientAddress
);
[DllImport("WDSCLIENTAPI.dll", ExactSpelling = true)]
static extern int WdsCliInitializeLog(
    IntPtr hSession,   // HANDLE
    uint ulClientArchitecture,   // CPU_ARCHITECTURE
    [MarshalAs(UnmanagedType.LPWStr)] string pwszClientId,   // LPWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string pwszClientAddress   // LPWSTR
);
<DllImport("WDSCLIENTAPI.dll", ExactSpelling:=True)>
Public Shared Function WdsCliInitializeLog(
    hSession As IntPtr,   ' HANDLE
    ulClientArchitecture As UInteger,   ' CPU_ARCHITECTURE
    <MarshalAs(UnmanagedType.LPWStr)> pwszClientId As String,   ' LPWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pwszClientAddress As String   ' LPWSTR
) As Integer
End Function
' hSession : HANDLE
' ulClientArchitecture : CPU_ARCHITECTURE
' pwszClientId : LPWSTR
' pwszClientAddress : LPWSTR
Declare PtrSafe Function WdsCliInitializeLog Lib "wdsclientapi" ( _
    ByVal hSession As LongPtr, _
    ByVal ulClientArchitecture As Long, _
    ByVal pwszClientId As LongPtr, _
    ByVal pwszClientAddress As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WdsCliInitializeLog = ctypes.windll.wdsclientapi.WdsCliInitializeLog
WdsCliInitializeLog.restype = ctypes.c_int
WdsCliInitializeLog.argtypes = [
    wintypes.HANDLE,  # hSession : HANDLE
    wintypes.DWORD,  # ulClientArchitecture : CPU_ARCHITECTURE
    wintypes.LPCWSTR,  # pwszClientId : LPWSTR
    wintypes.LPCWSTR,  # pwszClientAddress : LPWSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WDSCLIENTAPI.dll')
WdsCliInitializeLog = Fiddle::Function.new(
  lib['WdsCliInitializeLog'],
  [
    Fiddle::TYPE_VOIDP,  # hSession : HANDLE
    -Fiddle::TYPE_INT,  # ulClientArchitecture : CPU_ARCHITECTURE
    Fiddle::TYPE_VOIDP,  # pwszClientId : LPWSTR
    Fiddle::TYPE_VOIDP,  # pwszClientAddress : LPWSTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "wdsclientapi")]
extern "system" {
    fn WdsCliInitializeLog(
        hSession: *mut core::ffi::c_void,  // HANDLE
        ulClientArchitecture: u32,  // CPU_ARCHITECTURE
        pwszClientId: *mut u16,  // LPWSTR
        pwszClientAddress: *mut u16  // LPWSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WDSCLIENTAPI.dll")]
public static extern int WdsCliInitializeLog(IntPtr hSession, uint ulClientArchitecture, [MarshalAs(UnmanagedType.LPWStr)] string pwszClientId, [MarshalAs(UnmanagedType.LPWStr)] string pwszClientAddress);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WDSCLIENTAPI_WdsCliInitializeLog' -Namespace Win32 -PassThru
# $api::WdsCliInitializeLog(hSession, ulClientArchitecture, pwszClientId, pwszClientAddress)
#uselib "WDSCLIENTAPI.dll"
#func global WdsCliInitializeLog "WdsCliInitializeLog" sptr, sptr, sptr, sptr
; WdsCliInitializeLog hSession, ulClientArchitecture, pwszClientId, pwszClientAddress   ; 戻り値は stat
; hSession : HANDLE -> "sptr"
; ulClientArchitecture : CPU_ARCHITECTURE -> "sptr"
; pwszClientId : LPWSTR -> "sptr"
; pwszClientAddress : LPWSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WDSCLIENTAPI.dll"
#cfunc global WdsCliInitializeLog "WdsCliInitializeLog" sptr, int, wstr, wstr
; res = WdsCliInitializeLog(hSession, ulClientArchitecture, pwszClientId, pwszClientAddress)
; hSession : HANDLE -> "sptr"
; ulClientArchitecture : CPU_ARCHITECTURE -> "int"
; pwszClientId : LPWSTR -> "wstr"
; pwszClientAddress : LPWSTR -> "wstr"
; HRESULT WdsCliInitializeLog(HANDLE hSession, CPU_ARCHITECTURE ulClientArchitecture, LPWSTR pwszClientId, LPWSTR pwszClientAddress)
#uselib "WDSCLIENTAPI.dll"
#cfunc global WdsCliInitializeLog "WdsCliInitializeLog" intptr, int, wstr, wstr
; res = WdsCliInitializeLog(hSession, ulClientArchitecture, pwszClientId, pwszClientAddress)
; hSession : HANDLE -> "intptr"
; ulClientArchitecture : CPU_ARCHITECTURE -> "int"
; pwszClientId : LPWSTR -> "wstr"
; pwszClientAddress : LPWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wdsclientapi = windows.NewLazySystemDLL("WDSCLIENTAPI.dll")
	procWdsCliInitializeLog = wdsclientapi.NewProc("WdsCliInitializeLog")
)

// hSession (HANDLE), ulClientArchitecture (CPU_ARCHITECTURE), pwszClientId (LPWSTR), pwszClientAddress (LPWSTR)
r1, _, err := procWdsCliInitializeLog.Call(
	uintptr(hSession),
	uintptr(ulClientArchitecture),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pwszClientId))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pwszClientAddress))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function WdsCliInitializeLog(
  hSession: THandle;   // HANDLE
  ulClientArchitecture: DWORD;   // CPU_ARCHITECTURE
  pwszClientId: PWideChar;   // LPWSTR
  pwszClientAddress: PWideChar   // LPWSTR
): Integer; stdcall;
  external 'WDSCLIENTAPI.dll' name 'WdsCliInitializeLog';
result := DllCall("WDSCLIENTAPI\WdsCliInitializeLog"
    , "Ptr", hSession   ; HANDLE
    , "UInt", ulClientArchitecture   ; CPU_ARCHITECTURE
    , "WStr", pwszClientId   ; LPWSTR
    , "WStr", pwszClientAddress   ; LPWSTR
    , "Int")   ; return: HRESULT
●WdsCliInitializeLog(hSession, ulClientArchitecture, pwszClientId, pwszClientAddress) = DLL("WDSCLIENTAPI.dll", "int WdsCliInitializeLog(void*, dword, char*, char*)")
# 呼び出し: WdsCliInitializeLog(hSession, ulClientArchitecture, pwszClientId, pwszClientAddress)
# hSession : HANDLE -> "void*"
# ulClientArchitecture : CPU_ARCHITECTURE -> "dword"
# pwszClientId : LPWSTR -> "char*"
# pwszClientAddress : LPWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wdsclientapi" fn WdsCliInitializeLog(
    hSession: ?*anyopaque, // HANDLE
    ulClientArchitecture: u32, // CPU_ARCHITECTURE
    pwszClientId: [*c]const u16, // LPWSTR
    pwszClientAddress: [*c]const u16 // LPWSTR
) callconv(std.os.windows.WINAPI) i32;
proc WdsCliInitializeLog(
    hSession: pointer,  # HANDLE
    ulClientArchitecture: uint32,  # CPU_ARCHITECTURE
    pwszClientId: WideCString,  # LPWSTR
    pwszClientAddress: WideCString  # LPWSTR
): int32 {.importc: "WdsCliInitializeLog", stdcall, dynlib: "WDSCLIENTAPI.dll".}
pragma(lib, "wdsclientapi");
extern(Windows)
int WdsCliInitializeLog(
    void* hSession,   // HANDLE
    uint ulClientArchitecture,   // CPU_ARCHITECTURE
    const(wchar)* pwszClientId,   // LPWSTR
    const(wchar)* pwszClientAddress   // LPWSTR
);
ccall((:WdsCliInitializeLog, "WDSCLIENTAPI.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, Cwstring, Cwstring),
      hSession, ulClientArchitecture, pwszClientId, pwszClientAddress)
# hSession : HANDLE -> Ptr{Cvoid}
# ulClientArchitecture : CPU_ARCHITECTURE -> UInt32
# pwszClientId : LPWSTR -> Cwstring
# pwszClientAddress : LPWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WdsCliInitializeLog(
    void* hSession,
    uint32_t ulClientArchitecture,
    const uint16_t* pwszClientId,
    const uint16_t* pwszClientAddress);
]]
local wdsclientapi = ffi.load("wdsclientapi")
-- wdsclientapi.WdsCliInitializeLog(hSession, ulClientArchitecture, pwszClientId, pwszClientAddress)
-- hSession : HANDLE
-- ulClientArchitecture : CPU_ARCHITECTURE
-- pwszClientId : LPWSTR
-- pwszClientAddress : LPWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WDSCLIENTAPI.dll');
const WdsCliInitializeLog = lib.func('__stdcall', 'WdsCliInitializeLog', 'int32_t', ['void *', 'uint32_t', 'str16', 'str16']);
// WdsCliInitializeLog(hSession, ulClientArchitecture, pwszClientId, pwszClientAddress)
// hSession : HANDLE -> 'void *'
// ulClientArchitecture : CPU_ARCHITECTURE -> 'uint32_t'
// pwszClientId : LPWSTR -> 'str16'
// pwszClientAddress : LPWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WDSCLIENTAPI.dll", {
  WdsCliInitializeLog: { parameters: ["pointer", "u32", "buffer", "buffer"], result: "i32" },
});
// lib.symbols.WdsCliInitializeLog(hSession, ulClientArchitecture, pwszClientId, pwszClientAddress)
// hSession : HANDLE -> "pointer"
// ulClientArchitecture : CPU_ARCHITECTURE -> "u32"
// pwszClientId : LPWSTR -> "buffer"
// pwszClientAddress : LPWSTR -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WdsCliInitializeLog(
    void* hSession,
    uint32_t ulClientArchitecture,
    const uint16_t* pwszClientId,
    const uint16_t* pwszClientAddress);
C, "WDSCLIENTAPI.dll");
// $ffi->WdsCliInitializeLog(hSession, ulClientArchitecture, pwszClientId, pwszClientAddress);
// hSession : HANDLE
// ulClientArchitecture : CPU_ARCHITECTURE
// pwszClientId : LPWSTR
// pwszClientAddress : LPWSTR
// 構造体/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 Wdsclientapi extends StdCallLibrary {
    Wdsclientapi INSTANCE = Native.load("wdsclientapi", Wdsclientapi.class);
    int WdsCliInitializeLog(
        Pointer hSession,   // HANDLE
        int ulClientArchitecture,   // CPU_ARCHITECTURE
        WString pwszClientId,   // LPWSTR
        WString pwszClientAddress   // LPWSTR
    );
}
@[Link("wdsclientapi")]
lib LibWDSCLIENTAPI
  fun WdsCliInitializeLog = WdsCliInitializeLog(
    hSession : Void*,   # HANDLE
    ulClientArchitecture : UInt32,   # CPU_ARCHITECTURE
    pwszClientId : UInt16*,   # LPWSTR
    pwszClientAddress : UInt16*   # LPWSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WdsCliInitializeLogNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Utf16>, Pointer<Utf16>);
typedef WdsCliInitializeLogDart = int Function(Pointer<Void>, int, Pointer<Utf16>, Pointer<Utf16>);
final WdsCliInitializeLog = DynamicLibrary.open('WDSCLIENTAPI.dll')
    .lookupFunction<WdsCliInitializeLogNative, WdsCliInitializeLogDart>('WdsCliInitializeLog');
// hSession : HANDLE -> Pointer<Void>
// ulClientArchitecture : CPU_ARCHITECTURE -> Uint32
// pwszClientId : LPWSTR -> Pointer<Utf16>
// pwszClientAddress : LPWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WdsCliInitializeLog(
  hSession: THandle;   // HANDLE
  ulClientArchitecture: DWORD;   // CPU_ARCHITECTURE
  pwszClientId: PWideChar;   // LPWSTR
  pwszClientAddress: PWideChar   // LPWSTR
): Integer; stdcall;
  external 'WDSCLIENTAPI.dll' name 'WdsCliInitializeLog';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WdsCliInitializeLog"
  c_WdsCliInitializeLog :: Ptr () -> Word32 -> CWString -> CWString -> IO Int32
-- hSession : HANDLE -> Ptr ()
-- ulClientArchitecture : CPU_ARCHITECTURE -> Word32
-- pwszClientId : LPWSTR -> CWString
-- pwszClientAddress : LPWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wdscliinitializelog =
  foreign "WdsCliInitializeLog"
    ((ptr void) @-> uint32_t @-> (ptr uint16_t) @-> (ptr uint16_t) @-> returning int32_t)
(* hSession : HANDLE -> (ptr void) *)
(* ulClientArchitecture : CPU_ARCHITECTURE -> uint32_t *)
(* pwszClientId : LPWSTR -> (ptr uint16_t) *)
(* pwszClientAddress : LPWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wdsclientapi (t "WDSCLIENTAPI.dll"))
(cffi:use-foreign-library wdsclientapi)

(cffi:defcfun ("WdsCliInitializeLog" wds-cli-initialize-log :convention :stdcall) :int32
  (h-session :pointer)   ; HANDLE
  (ul-client-architecture :uint32)   ; CPU_ARCHITECTURE
  (pwsz-client-id (:string :encoding :utf-16le))   ; LPWSTR
  (pwsz-client-address (:string :encoding :utf-16le)))   ; LPWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WdsCliInitializeLog = Win32::API::More->new('WDSCLIENTAPI',
    'int WdsCliInitializeLog(HANDLE hSession, DWORD ulClientArchitecture, LPCWSTR pwszClientId, LPCWSTR pwszClientAddress)');
# my $ret = $WdsCliInitializeLog->Call($hSession, $ulClientArchitecture, $pwszClientId, $pwszClientAddress);
# hSession : HANDLE -> HANDLE
# ulClientArchitecture : CPU_ARCHITECTURE -> DWORD
# pwszClientId : LPWSTR -> LPCWSTR
# pwszClientAddress : LPWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型