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

WdsCliRegisterTrace

関数
WDSクライアントのトレース出力用コールバック関数を登録する。
DLLWDSCLIENTAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT WdsCliRegisterTrace(
    PFN_WdsCliTraceFunction pfn   // optional
);

パラメーター

名前方向説明
pfnPFN_WdsCliTraceFunctioninoptionalトレース出力を受け取るコールバック関数(PFN_WdsCliTraceFunction)へのポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WdsCliRegisterTrace(
    PFN_WdsCliTraceFunction pfn   // optional
);
[DllImport("WDSCLIENTAPI.dll", ExactSpelling = true)]
static extern int WdsCliRegisterTrace(
    IntPtr pfn   // PFN_WdsCliTraceFunction optional
);
<DllImport("WDSCLIENTAPI.dll", ExactSpelling:=True)>
Public Shared Function WdsCliRegisterTrace(
    pfn As IntPtr   ' PFN_WdsCliTraceFunction optional
) As Integer
End Function
' pfn : PFN_WdsCliTraceFunction optional
Declare PtrSafe Function WdsCliRegisterTrace Lib "wdsclientapi" ( _
    ByVal pfn As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WdsCliRegisterTrace = ctypes.windll.wdsclientapi.WdsCliRegisterTrace
WdsCliRegisterTrace.restype = ctypes.c_int
WdsCliRegisterTrace.argtypes = [
    ctypes.c_void_p,  # pfn : PFN_WdsCliTraceFunction optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	wdsclientapi = windows.NewLazySystemDLL("WDSCLIENTAPI.dll")
	procWdsCliRegisterTrace = wdsclientapi.NewProc("WdsCliRegisterTrace")
)

// pfn (PFN_WdsCliTraceFunction optional)
r1, _, err := procWdsCliRegisterTrace.Call(
	uintptr(pfn),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function WdsCliRegisterTrace(
  pfn: Pointer   // PFN_WdsCliTraceFunction optional
): Integer; stdcall;
  external 'WDSCLIENTAPI.dll' name 'WdsCliRegisterTrace';
result := DllCall("WDSCLIENTAPI\WdsCliRegisterTrace"
    , "Ptr", pfn   ; PFN_WdsCliTraceFunction optional
    , "Int")   ; return: HRESULT
●WdsCliRegisterTrace(pfn) = DLL("WDSCLIENTAPI.dll", "int WdsCliRegisterTrace(void*)")
# 呼び出し: WdsCliRegisterTrace(pfn)
# pfn : PFN_WdsCliTraceFunction optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wdsclientapi" fn WdsCliRegisterTrace(
    pfn: ?*anyopaque // PFN_WdsCliTraceFunction optional
) callconv(std.os.windows.WINAPI) i32;
proc WdsCliRegisterTrace(
    pfn: pointer  # PFN_WdsCliTraceFunction optional
): int32 {.importc: "WdsCliRegisterTrace", stdcall, dynlib: "WDSCLIENTAPI.dll".}
pragma(lib, "wdsclientapi");
extern(Windows)
int WdsCliRegisterTrace(
    void* pfn   // PFN_WdsCliTraceFunction optional
);
ccall((:WdsCliRegisterTrace, "WDSCLIENTAPI.dll"), stdcall, Int32,
      (Ptr{Cvoid},),
      pfn)
# pfn : PFN_WdsCliTraceFunction optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WdsCliRegisterTrace(
    void* pfn);
]]
local wdsclientapi = ffi.load("wdsclientapi")
-- wdsclientapi.WdsCliRegisterTrace(pfn)
-- pfn : PFN_WdsCliTraceFunction optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WDSCLIENTAPI.dll');
const WdsCliRegisterTrace = lib.func('__stdcall', 'WdsCliRegisterTrace', 'int32_t', ['void *']);
// WdsCliRegisterTrace(pfn)
// pfn : PFN_WdsCliTraceFunction optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("WDSCLIENTAPI.dll", {
  WdsCliRegisterTrace: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.WdsCliRegisterTrace(pfn)
// pfn : PFN_WdsCliTraceFunction optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WdsCliRegisterTrace(
    void* pfn);
C, "WDSCLIENTAPI.dll");
// $ffi->WdsCliRegisterTrace(pfn);
// pfn : PFN_WdsCliTraceFunction optional
// 構造体/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 WdsCliRegisterTrace(
        Callback pfn   // PFN_WdsCliTraceFunction optional
    );
}
@[Link("wdsclientapi")]
lib LibWDSCLIENTAPI
  fun WdsCliRegisterTrace = WdsCliRegisterTrace(
    pfn : Void*   # PFN_WdsCliTraceFunction optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WdsCliRegisterTraceNative = Int32 Function(Pointer<Void>);
typedef WdsCliRegisterTraceDart = int Function(Pointer<Void>);
final WdsCliRegisterTrace = DynamicLibrary.open('WDSCLIENTAPI.dll')
    .lookupFunction<WdsCliRegisterTraceNative, WdsCliRegisterTraceDart>('WdsCliRegisterTrace');
// pfn : PFN_WdsCliTraceFunction optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WdsCliRegisterTrace(
  pfn: Pointer   // PFN_WdsCliTraceFunction optional
): Integer; stdcall;
  external 'WDSCLIENTAPI.dll' name 'WdsCliRegisterTrace';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WdsCliRegisterTrace"
  c_WdsCliRegisterTrace :: Ptr () -> IO Int32
-- pfn : PFN_WdsCliTraceFunction optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wdscliregistertrace =
  foreign "WdsCliRegisterTrace"
    ((ptr void) @-> returning int32_t)
(* pfn : PFN_WdsCliTraceFunction optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wdsclientapi (t "WDSCLIENTAPI.dll"))
(cffi:use-foreign-library wdsclientapi)

(cffi:defcfun ("WdsCliRegisterTrace" wds-cli-register-trace :convention :stdcall) :int32
  (pfn :pointer))   ; PFN_WdsCliTraceFunction optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WdsCliRegisterTrace = Win32::API::More->new('WDSCLIENTAPI',
    'int WdsCliRegisterTrace(LPVOID pfn)');
# my $ret = $WdsCliRegisterTrace->Call($pfn);
# pfn : PFN_WdsCliTraceFunction optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

使用する型