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

WdsTransportClientQueryStatus

関数
WDS転送セッションの状態とエラーコードを取得する。
DLLWDSTPTC.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD WdsTransportClientQueryStatus(
    HANDLE hSessionKey,
    DWORD* puStatus,
    DWORD* puErrorCode
);

パラメーター

名前方向説明
hSessionKeyHANDLEin状態を照会する対象のセッションハンドル。
puStatusDWORD*outセッションの現在状態を受け取るDWORDポインタ。
puErrorCodeDWORD*out発生したエラーコードを受け取るDWORDポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD WdsTransportClientQueryStatus(
    HANDLE hSessionKey,
    DWORD* puStatus,
    DWORD* puErrorCode
);
[DllImport("WDSTPTC.dll", ExactSpelling = true)]
static extern uint WdsTransportClientQueryStatus(
    IntPtr hSessionKey,   // HANDLE
    out uint puStatus,   // DWORD* out
    out uint puErrorCode   // DWORD* out
);
<DllImport("WDSTPTC.dll", ExactSpelling:=True)>
Public Shared Function WdsTransportClientQueryStatus(
    hSessionKey As IntPtr,   ' HANDLE
    <Out> ByRef puStatus As UInteger,   ' DWORD* out
    <Out> ByRef puErrorCode As UInteger   ' DWORD* out
) As UInteger
End Function
' hSessionKey : HANDLE
' puStatus : DWORD* out
' puErrorCode : DWORD* out
Declare PtrSafe Function WdsTransportClientQueryStatus Lib "wdstptc" ( _
    ByVal hSessionKey As LongPtr, _
    ByRef puStatus As Long, _
    ByRef puErrorCode As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WdsTransportClientQueryStatus = ctypes.windll.wdstptc.WdsTransportClientQueryStatus
WdsTransportClientQueryStatus.restype = wintypes.DWORD
WdsTransportClientQueryStatus.argtypes = [
    wintypes.HANDLE,  # hSessionKey : HANDLE
    ctypes.POINTER(wintypes.DWORD),  # puStatus : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # puErrorCode : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WDSTPTC.dll')
WdsTransportClientQueryStatus = Fiddle::Function.new(
  lib['WdsTransportClientQueryStatus'],
  [
    Fiddle::TYPE_VOIDP,  # hSessionKey : HANDLE
    Fiddle::TYPE_VOIDP,  # puStatus : DWORD* out
    Fiddle::TYPE_VOIDP,  # puErrorCode : DWORD* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "wdstptc")]
extern "system" {
    fn WdsTransportClientQueryStatus(
        hSessionKey: *mut core::ffi::c_void,  // HANDLE
        puStatus: *mut u32,  // DWORD* out
        puErrorCode: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WDSTPTC.dll")]
public static extern uint WdsTransportClientQueryStatus(IntPtr hSessionKey, out uint puStatus, out uint puErrorCode);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WDSTPTC_WdsTransportClientQueryStatus' -Namespace Win32 -PassThru
# $api::WdsTransportClientQueryStatus(hSessionKey, puStatus, puErrorCode)
#uselib "WDSTPTC.dll"
#func global WdsTransportClientQueryStatus "WdsTransportClientQueryStatus" sptr, sptr, sptr
; WdsTransportClientQueryStatus hSessionKey, varptr(puStatus), varptr(puErrorCode)   ; 戻り値は stat
; hSessionKey : HANDLE -> "sptr"
; puStatus : DWORD* out -> "sptr"
; puErrorCode : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WDSTPTC.dll"
#cfunc global WdsTransportClientQueryStatus "WdsTransportClientQueryStatus" sptr, var, var
; res = WdsTransportClientQueryStatus(hSessionKey, puStatus, puErrorCode)
; hSessionKey : HANDLE -> "sptr"
; puStatus : DWORD* out -> "var"
; puErrorCode : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD WdsTransportClientQueryStatus(HANDLE hSessionKey, DWORD* puStatus, DWORD* puErrorCode)
#uselib "WDSTPTC.dll"
#cfunc global WdsTransportClientQueryStatus "WdsTransportClientQueryStatus" intptr, var, var
; res = WdsTransportClientQueryStatus(hSessionKey, puStatus, puErrorCode)
; hSessionKey : HANDLE -> "intptr"
; puStatus : DWORD* out -> "var"
; puErrorCode : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wdstptc = windows.NewLazySystemDLL("WDSTPTC.dll")
	procWdsTransportClientQueryStatus = wdstptc.NewProc("WdsTransportClientQueryStatus")
)

// hSessionKey (HANDLE), puStatus (DWORD* out), puErrorCode (DWORD* out)
r1, _, err := procWdsTransportClientQueryStatus.Call(
	uintptr(hSessionKey),
	uintptr(puStatus),
	uintptr(puErrorCode),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function WdsTransportClientQueryStatus(
  hSessionKey: THandle;   // HANDLE
  puStatus: Pointer;   // DWORD* out
  puErrorCode: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'WDSTPTC.dll' name 'WdsTransportClientQueryStatus';
result := DllCall("WDSTPTC\WdsTransportClientQueryStatus"
    , "Ptr", hSessionKey   ; HANDLE
    , "Ptr", puStatus   ; DWORD* out
    , "Ptr", puErrorCode   ; DWORD* out
    , "UInt")   ; return: DWORD
●WdsTransportClientQueryStatus(hSessionKey, puStatus, puErrorCode) = DLL("WDSTPTC.dll", "dword WdsTransportClientQueryStatus(void*, void*, void*)")
# 呼び出し: WdsTransportClientQueryStatus(hSessionKey, puStatus, puErrorCode)
# hSessionKey : HANDLE -> "void*"
# puStatus : DWORD* out -> "void*"
# puErrorCode : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef WdsTransportClientQueryStatusNative = Uint32 Function(Pointer<Void>, Pointer<Uint32>, Pointer<Uint32>);
typedef WdsTransportClientQueryStatusDart = int Function(Pointer<Void>, Pointer<Uint32>, Pointer<Uint32>);
final WdsTransportClientQueryStatus = DynamicLibrary.open('WDSTPTC.dll')
    .lookupFunction<WdsTransportClientQueryStatusNative, WdsTransportClientQueryStatusDart>('WdsTransportClientQueryStatus');
// hSessionKey : HANDLE -> Pointer<Void>
// puStatus : DWORD* out -> Pointer<Uint32>
// puErrorCode : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WdsTransportClientQueryStatus(
  hSessionKey: THandle;   // HANDLE
  puStatus: Pointer;   // DWORD* out
  puErrorCode: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'WDSTPTC.dll' name 'WdsTransportClientQueryStatus';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let wdstransportclientquerystatus =
  foreign "WdsTransportClientQueryStatus"
    ((ptr void) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* hSessionKey : HANDLE -> (ptr void) *)
(* puStatus : DWORD* out -> (ptr uint32_t) *)
(* puErrorCode : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wdstptc (t "WDSTPTC.dll"))
(cffi:use-foreign-library wdstptc)

(cffi:defcfun ("WdsTransportClientQueryStatus" wds-transport-client-query-status :convention :stdcall) :uint32
  (h-session-key :pointer)   ; HANDLE
  (pu-status :pointer)   ; DWORD* out
  (pu-error-code :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WdsTransportClientQueryStatus = Win32::API::More->new('WDSTPTC',
    'DWORD WdsTransportClientQueryStatus(HANDLE hSessionKey, LPVOID puStatus, LPVOID puErrorCode)');
# my $ret = $WdsTransportClientQueryStatus->Call($hSessionKey, $puStatus, $puErrorCode);
# hSessionKey : HANDLE -> HANDLE
# puStatus : DWORD* out -> LPVOID
# puErrorCode : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。