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

WdsCliLog

関数可変長引数
WDSセッションへログメッセージを記録する。
DLLWDSCLIENTAPI.dll呼出規約cdecl対応OSWindows Vista 以降

シグネチャ

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

HRESULT WdsCliLog(
    HANDLE hSession,
    DWORD ulLogLevel,
    DWORD ulMessageCode,
    ...
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。

パラメーター

名前方向説明
hSessionHANDLEinログを記録する対象のWDSセッションハンドル。
ulLogLevelDWORDinログの重要度レベルを示す値。
ulMessageCodeDWORDin記録するメッセージのコード。後続に可変引数が続く。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WdsCliLog(
    HANDLE hSession,
    DWORD ulLogLevel,
    DWORD ulMessageCode,
    ...
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
[DllImport("WDSCLIENTAPI.dll", ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern int WdsCliLog(
    IntPtr hSession,   // HANDLE
    uint ulLogLevel,   // DWORD
    uint ulMessageCode,   // DWORD
    __arglist
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
<DllImport("WDSCLIENTAPI.dll", ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Function WdsCliLog(
    hSession As IntPtr,   ' HANDLE
    ulLogLevel As UInteger,   ' DWORD
    ulMessageCode As UInteger   ' DWORD
) As Integer
End Function
' ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
' hSession : HANDLE
' ulLogLevel : DWORD
' ulMessageCode : DWORD
Declare PtrSafe Function WdsCliLog Lib "wdsclientapi" ( _
    ByVal hSession As LongPtr, _
    ByVal ulLogLevel As Long, _
    ByVal ulMessageCode As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
' ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
import ctypes
from ctypes import wintypes

WdsCliLog = ctypes.cdll.wdsclientapi.WdsCliLog
WdsCliLog.restype = ctypes.c_int
WdsCliLog.argtypes = [
    wintypes.HANDLE,  # hSession : HANDLE
    wintypes.DWORD,  # ulLogLevel : DWORD
    wintypes.DWORD,  # ulMessageCode : DWORD
]
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WDSCLIENTAPI.dll')
WdsCliLog = Fiddle::Function.new(
  lib['WdsCliLog'],
  [
    Fiddle::TYPE_VOIDP,  # hSession : HANDLE
    -Fiddle::TYPE_INT,  # ulLogLevel : DWORD
    -Fiddle::TYPE_INT,  # ulMessageCode : DWORD
  ],
  Fiddle::TYPE_INT, Fiddle::Function::CDECL)
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
#[link(name = "wdsclientapi")]
extern "C" {
    fn WdsCliLog(
        hSession: *mut core::ffi::c_void,  // HANDLE
        ulLogLevel: u32,  // DWORD
        ulMessageCode: u32,  // DWORD
        ...
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
$sig = @"
[DllImport("WDSCLIENTAPI.dll", CallingConvention = CallingConvention.Cdecl)]
public static extern int WdsCliLog(IntPtr hSession, uint ulLogLevel, uint ulMessageCode);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WDSCLIENTAPI_WdsCliLog' -Namespace Win32 -PassThru
# $api::WdsCliLog(hSession, ulLogLevel, ulMessageCode)
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
#uselib "WDSCLIENTAPI.dll"
#func global WdsCliLog "WdsCliLog" sptr, sptr, sptr
; WdsCliLog hSession, ulLogLevel, ulMessageCode   ; 戻り値は stat
; hSession : HANDLE -> "sptr"
; ulLogLevel : DWORD -> "sptr"
; ulMessageCode : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
#uselib "WDSCLIENTAPI.dll"
#cfunc global WdsCliLog "WdsCliLog" sptr, int, int
; res = WdsCliLog(hSession, ulLogLevel, ulMessageCode)
; hSession : HANDLE -> "sptr"
; ulLogLevel : DWORD -> "int"
; ulMessageCode : DWORD -> "int"
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
; HRESULT WdsCliLog(HANDLE hSession, DWORD ulLogLevel, DWORD ulMessageCode)
#uselib "WDSCLIENTAPI.dll"
#cfunc global WdsCliLog "WdsCliLog" intptr, int, int
; res = WdsCliLog(hSession, ulLogLevel, ulMessageCode)
; hSession : HANDLE -> "intptr"
; ulLogLevel : DWORD -> "int"
; ulMessageCode : DWORD -> "int"
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wdsclientapi = windows.NewLazySystemDLL("WDSCLIENTAPI.dll")
	procWdsCliLog = wdsclientapi.NewProc("WdsCliLog")
)

// hSession (HANDLE), ulLogLevel (DWORD), ulMessageCode (DWORD)
r1, _, err := procWdsCliLog.Call(
	uintptr(hSession),
	uintptr(ulLogLevel),
	uintptr(ulMessageCode),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
function WdsCliLog(
  hSession: THandle;   // HANDLE
  ulLogLevel: DWORD;   // DWORD
  ulMessageCode: DWORD   // DWORD
): Integer; cdecl; varargs;
  external 'WDSCLIENTAPI.dll' name 'WdsCliLog';
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
result := DllCall("WDSCLIENTAPI\WdsCliLog"
    , "Ptr", hSession   ; HANDLE
    , "UInt", ulLogLevel   ; DWORD
    , "UInt", ulMessageCode   ; DWORD
    , "Cdecl Int")   ; return: HRESULT
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
●WdsCliLog(hSession, ulLogLevel, ulMessageCode) = DLL("WDSCLIENTAPI.dll", "int WdsCliLog(void*, dword, dword)")
# 呼び出し: WdsCliLog(hSession, ulLogLevel, ulMessageCode)
# hSession : HANDLE -> "void*"
# ulLogLevel : DWORD -> "dword"
# ulMessageCode : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※cdecl関数。DLL()宣言はstdcall前提。cdeclは EXEC_PTR(`cdecl`,…) を使用。
# ※可変長引数。DLL()は固定引数のみ。追加引数は EXEC_PTR で渡してください。
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
const std = @import("std");

extern "wdsclientapi" fn WdsCliLog(
    hSession: ?*anyopaque, // HANDLE
    ulLogLevel: u32, // DWORD
    ulMessageCode: u32, // DWORD
    ...
) callconv(.c) i32;
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
proc WdsCliLog(
    hSession: pointer,  # HANDLE
    ulLogLevel: uint32,  # DWORD
    ulMessageCode: uint32  # DWORD
): int32 {.importc: "WdsCliLog", cdecl, varargs, dynlib: "WDSCLIENTAPI.dll".}
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
pragma(lib, "wdsclientapi");
extern(C)
int WdsCliLog(
    void* hSession,   // HANDLE
    uint ulLogLevel,   // DWORD
    uint ulMessageCode,   // DWORD
    ...
);
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
ccall((:WdsCliLog, "WDSCLIENTAPI.dll"), Int32,
      (Ptr{Cvoid}, UInt32, UInt32),
      hSession, ulLogLevel, ulMessageCode)
# hSession : HANDLE -> Ptr{Cvoid}
# ulLogLevel : DWORD -> UInt32
# ulMessageCode : DWORD -> UInt32
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
local ffi = require("ffi")
ffi.cdef[[
int32_t WdsCliLog(
    void* hSession,
    uint32_t ulLogLevel,
    uint32_t ulMessageCode,
    ...);
]]
local wdsclientapi = ffi.load("wdsclientapi")
-- wdsclientapi.WdsCliLog(hSession, ulLogLevel, ulMessageCode)
-- hSession : HANDLE
-- ulLogLevel : DWORD
-- ulMessageCode : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
const koffi = require('koffi');
const lib = koffi.load('WDSCLIENTAPI.dll');
const WdsCliLog = lib.func('__cdecl', 'WdsCliLog', 'int32_t', ['void *', 'uint32_t', 'uint32_t', '...']);
// WdsCliLog(hSession, ulLogLevel, ulMessageCode)
// hSession : HANDLE -> 'void *'
// ulLogLevel : DWORD -> 'uint32_t'
// ulMessageCode : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
const lib = Deno.dlopen("WDSCLIENTAPI.dll", {
  WdsCliLog: { parameters: ["pointer", "u32", "u32"], result: "i32" },
});
// lib.symbols.WdsCliLog(hSession, ulLogLevel, ulMessageCode)
// hSession : HANDLE -> "pointer"
// ulLogLevel : DWORD -> "u32"
// ulMessageCode : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
<?php
$ffi = FFI::cdef(<<<C
int32_t WdsCliLog(
    void* hSession,
    uint32_t ulLogLevel,
    uint32_t ulMessageCode,
    ...);
C, "WDSCLIENTAPI.dll");
// $ffi->WdsCliLog(hSession, ulLogLevel, ulMessageCode);
// hSession : HANDLE
// ulLogLevel : DWORD
// ulMessageCode : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
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 Library {
    Wdsclientapi INSTANCE = Native.load("wdsclientapi", Wdsclientapi.class);
    int WdsCliLog(
        Pointer hSession,   // HANDLE
        int ulLogLevel,   // DWORD
        int ulMessageCode,   // DWORD
        Object... args   // 可変長引数(printf形式)
    );
}
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
@[Link("wdsclientapi")]
lib LibWDSCLIENTAPI
  fun WdsCliLog = WdsCliLog(
    hSession : Void*,   # HANDLE
    ulLogLevel : UInt32,   # DWORD
    ulMessageCode : UInt32,   # DWORD
    ...
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WdsCliLogNative = Int32 Function(Pointer<Void>, Uint32, Uint32);
typedef WdsCliLogDart = int Function(Pointer<Void>, int, int);
final WdsCliLog = DynamicLibrary.open('WDSCLIENTAPI.dll')
    .lookupFunction<WdsCliLogNative, WdsCliLogDart>('WdsCliLog');
// hSession : HANDLE -> Pointer<Void>
// ulLogLevel : DWORD -> Uint32
// ulMessageCode : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
{$mode objfpc}{$H+}
function WdsCliLog(
  hSession: THandle;   // HANDLE
  ulLogLevel: DWORD;   // DWORD
  ulMessageCode: DWORD   // DWORD
): Integer; cdecl; varargs;
  external 'WDSCLIENTAPI.dll' name 'WdsCliLog';
// ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import ccall safe "WdsCliLog"
  c_WdsCliLog :: Ptr () -> Word32 -> Word32 -> IO Int32
-- hSession : HANDLE -> Ptr ()
-- ulLogLevel : DWORD -> Word32
-- ulMessageCode : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
open Ctypes
open Foreign

let wdsclilog =
  foreign "WdsCliLog"
    ((ptr void) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* hSession : HANDLE -> (ptr void) *)
(* ulLogLevel : DWORD -> uint32_t *)
(* ulMessageCode : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(* ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
(cffi:define-foreign-library wdsclientapi (t "WDSCLIENTAPI.dll"))
(cffi:use-foreign-library wdsclientapi)

(cffi:defcfun ("WdsCliLog" wds-cli-log :convention :cdecl) :int32
  (h-session :pointer)   ; HANDLE
  (ul-log-level :uint32)   ; DWORD
  (ul-message-code :uint32)   ; DWORD
  &rest)   ; 可変長引数(printf形式)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
; ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。
use Win32::API;
my $WdsCliLog = Win32::API::More->new('WDSCLIENTAPI',
    'int WdsCliLog(HANDLE hSession, DWORD ulLogLevel, DWORD ulMessageCode)');
# my $ret = $WdsCliLog->Call($hSession, $ulLogLevel, $ulMessageCode);
# hSession : HANDLE -> HANDLE
# ulLogLevel : DWORD -> DWORD
# ulMessageCode : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# ※可変長引数(printf形式・cdecl)。上記の固定引数の後に、書式に応じた引数を追加で渡します。