Win32 API 日本語リファレンス
ホームNetworkManagement.NetManagement › TraceGetConsoleW

TraceGetConsoleW

関数
トレース出力用コンソールのハンドルを取得する(Unicode版)。
DLLrtutils.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

DWORD TraceGetConsoleW(
    DWORD dwTraceID,
    HANDLE* lphConsole
);

パラメーター

名前方向説明
dwTraceIDDWORDin登録時に取得したトレースID。対象トレースを指す。
lphConsoleHANDLE*inoutトレースコンソールのハンドルを受け取る出力ポインター。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD TraceGetConsoleW(
    DWORD dwTraceID,
    HANDLE* lphConsole
);
[DllImport("rtutils.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint TraceGetConsoleW(
    uint dwTraceID,   // DWORD
    IntPtr lphConsole   // HANDLE* in/out
);
<DllImport("rtutils.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function TraceGetConsoleW(
    dwTraceID As UInteger,   ' DWORD
    lphConsole As IntPtr   ' HANDLE* in/out
) As UInteger
End Function
' dwTraceID : DWORD
' lphConsole : HANDLE* in/out
Declare PtrSafe Function TraceGetConsoleW Lib "rtutils" ( _
    ByVal dwTraceID As Long, _
    ByVal lphConsole As LongPtr) 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

TraceGetConsoleW = ctypes.windll.rtutils.TraceGetConsoleW
TraceGetConsoleW.restype = wintypes.DWORD
TraceGetConsoleW.argtypes = [
    wintypes.DWORD,  # dwTraceID : DWORD
    ctypes.c_void_p,  # lphConsole : HANDLE* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('rtutils.dll')
TraceGetConsoleW = Fiddle::Function.new(
  lib['TraceGetConsoleW'],
  [
    -Fiddle::TYPE_INT,  # dwTraceID : DWORD
    Fiddle::TYPE_VOIDP,  # lphConsole : HANDLE* in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "rtutils")]
extern "system" {
    fn TraceGetConsoleW(
        dwTraceID: u32,  // DWORD
        lphConsole: *mut *mut core::ffi::c_void  // HANDLE* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("rtutils.dll", CharSet = CharSet.Unicode)]
public static extern uint TraceGetConsoleW(uint dwTraceID, IntPtr lphConsole);
"@
$api = Add-Type -MemberDefinition $sig -Name 'rtutils_TraceGetConsoleW' -Namespace Win32 -PassThru
# $api::TraceGetConsoleW(dwTraceID, lphConsole)
#uselib "rtutils.dll"
#func global TraceGetConsoleW "TraceGetConsoleW" wptr, wptr
; TraceGetConsoleW dwTraceID, lphConsole   ; 戻り値は stat
; dwTraceID : DWORD -> "wptr"
; lphConsole : HANDLE* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "rtutils.dll"
#cfunc global TraceGetConsoleW "TraceGetConsoleW" int, sptr
; res = TraceGetConsoleW(dwTraceID, lphConsole)
; dwTraceID : DWORD -> "int"
; lphConsole : HANDLE* in/out -> "sptr"
; DWORD TraceGetConsoleW(DWORD dwTraceID, HANDLE* lphConsole)
#uselib "rtutils.dll"
#cfunc global TraceGetConsoleW "TraceGetConsoleW" int, intptr
; res = TraceGetConsoleW(dwTraceID, lphConsole)
; dwTraceID : DWORD -> "int"
; lphConsole : HANDLE* in/out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	rtutils = windows.NewLazySystemDLL("rtutils.dll")
	procTraceGetConsoleW = rtutils.NewProc("TraceGetConsoleW")
)

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

extern "rtutils" fn TraceGetConsoleW(
    dwTraceID: u32, // DWORD
    lphConsole: ?*anyopaque // HANDLE* in/out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc TraceGetConsoleW(
    dwTraceID: uint32,  # DWORD
    lphConsole: pointer  # HANDLE* in/out
): uint32 {.importc: "TraceGetConsoleW", stdcall, dynlib: "rtutils.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "rtutils");
extern(Windows)
uint TraceGetConsoleW(
    uint dwTraceID,   // DWORD
    void* lphConsole   // HANDLE* in/out
);
ccall((:TraceGetConsoleW, "rtutils.dll"), stdcall, UInt32,
      (UInt32, Ptr{Cvoid}),
      dwTraceID, lphConsole)
# dwTraceID : DWORD -> UInt32
# lphConsole : HANDLE* in/out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t TraceGetConsoleW(
    uint32_t dwTraceID,
    void* lphConsole);
]]
local rtutils = ffi.load("rtutils")
-- rtutils.TraceGetConsoleW(dwTraceID, lphConsole)
-- dwTraceID : DWORD
-- lphConsole : HANDLE* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('rtutils.dll');
const TraceGetConsoleW = lib.func('__stdcall', 'TraceGetConsoleW', 'uint32_t', ['uint32_t', 'void *']);
// TraceGetConsoleW(dwTraceID, lphConsole)
// dwTraceID : DWORD -> 'uint32_t'
// lphConsole : HANDLE* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("rtutils.dll", {
  TraceGetConsoleW: { parameters: ["u32", "pointer"], result: "u32" },
});
// lib.symbols.TraceGetConsoleW(dwTraceID, lphConsole)
// dwTraceID : DWORD -> "u32"
// lphConsole : HANDLE* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t TraceGetConsoleW(
    uint32_t dwTraceID,
    void* lphConsole);
C, "rtutils.dll");
// $ffi->TraceGetConsoleW(dwTraceID, lphConsole);
// dwTraceID : DWORD
// lphConsole : HANDLE* in/out
// 構造体/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 Rtutils extends StdCallLibrary {
    Rtutils INSTANCE = Native.load("rtutils", Rtutils.class, W32APIOptions.UNICODE_OPTIONS);
    int TraceGetConsoleW(
        int dwTraceID,   // DWORD
        Pointer lphConsole   // HANDLE* in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("rtutils")]
lib Librtutils
  fun TraceGetConsoleW = TraceGetConsoleW(
    dwTraceID : UInt32,   # DWORD
    lphConsole : Void*   # HANDLE* in/out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef TraceGetConsoleWNative = Uint32 Function(Uint32, Pointer<Void>);
typedef TraceGetConsoleWDart = int Function(int, Pointer<Void>);
final TraceGetConsoleW = DynamicLibrary.open('rtutils.dll')
    .lookupFunction<TraceGetConsoleWNative, TraceGetConsoleWDart>('TraceGetConsoleW');
// dwTraceID : DWORD -> Uint32
// lphConsole : HANDLE* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function TraceGetConsoleW(
  dwTraceID: DWORD;   // DWORD
  lphConsole: Pointer   // HANDLE* in/out
): DWORD; stdcall;
  external 'rtutils.dll' name 'TraceGetConsoleW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "TraceGetConsoleW"
  c_TraceGetConsoleW :: Word32 -> Ptr () -> IO Word32
-- dwTraceID : DWORD -> Word32
-- lphConsole : HANDLE* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let tracegetconsolew =
  foreign "TraceGetConsoleW"
    (uint32_t @-> (ptr void) @-> returning uint32_t)
(* dwTraceID : DWORD -> uint32_t *)
(* lphConsole : HANDLE* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rtutils (t "rtutils.dll"))
(cffi:use-foreign-library rtutils)

(cffi:defcfun ("TraceGetConsoleW" trace-get-console-w :convention :stdcall) :uint32
  (dw-trace-id :uint32)   ; DWORD
  (lph-console :pointer))   ; HANDLE* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TraceGetConsoleW = Win32::API::More->new('rtutils',
    'DWORD TraceGetConsoleW(DWORD dwTraceID, HANDLE lphConsole)');
# my $ret = $TraceGetConsoleW->Call($dwTraceID, $lphConsole);
# dwTraceID : DWORD -> DWORD
# lphConsole : HANDLE* in/out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い