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

WdsCliGetImageParameter

関数
WDSイメージの指定種別のパラメーター値を取得する。
DLLWDSCLIENTAPI.dll呼出規約winapi

シグネチャ

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

HRESULT WdsCliGetImageParameter(
    HANDLE hIfh,
    WDS_CLI_IMAGE_PARAM_TYPE ParamType,
    void* pResponse,
    DWORD uResponseLen
);

パラメーター

名前方向説明
hIfhHANDLEin対象イメージを示すイメージ情報ハンドル。
ParamTypeWDS_CLI_IMAGE_PARAM_TYPEin取得するパラメーターの種類を指定する列挙値。要求する属性を選択する。
pResponsevoid*out取得した値を書き込む呼び出し側確保バッファ。ParamTypeに応じた型を格納する。
uResponseLenDWORDinpResponseバッファのサイズ(バイト単位)。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WdsCliGetImageParameter(
    HANDLE hIfh,
    WDS_CLI_IMAGE_PARAM_TYPE ParamType,
    void* pResponse,
    DWORD uResponseLen
);
[DllImport("WDSCLIENTAPI.dll", ExactSpelling = true)]
static extern int WdsCliGetImageParameter(
    IntPtr hIfh,   // HANDLE
    int ParamType,   // WDS_CLI_IMAGE_PARAM_TYPE
    IntPtr pResponse,   // void* out
    uint uResponseLen   // DWORD
);
<DllImport("WDSCLIENTAPI.dll", ExactSpelling:=True)>
Public Shared Function WdsCliGetImageParameter(
    hIfh As IntPtr,   ' HANDLE
    ParamType As Integer,   ' WDS_CLI_IMAGE_PARAM_TYPE
    pResponse As IntPtr,   ' void* out
    uResponseLen As UInteger   ' DWORD
) As Integer
End Function
' hIfh : HANDLE
' ParamType : WDS_CLI_IMAGE_PARAM_TYPE
' pResponse : void* out
' uResponseLen : DWORD
Declare PtrSafe Function WdsCliGetImageParameter Lib "wdsclientapi" ( _
    ByVal hIfh As LongPtr, _
    ByVal ParamType As Long, _
    ByVal pResponse As LongPtr, _
    ByVal uResponseLen As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WdsCliGetImageParameter = ctypes.windll.wdsclientapi.WdsCliGetImageParameter
WdsCliGetImageParameter.restype = ctypes.c_int
WdsCliGetImageParameter.argtypes = [
    wintypes.HANDLE,  # hIfh : HANDLE
    ctypes.c_int,  # ParamType : WDS_CLI_IMAGE_PARAM_TYPE
    ctypes.POINTER(None),  # pResponse : void* out
    wintypes.DWORD,  # uResponseLen : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	wdsclientapi = windows.NewLazySystemDLL("WDSCLIENTAPI.dll")
	procWdsCliGetImageParameter = wdsclientapi.NewProc("WdsCliGetImageParameter")
)

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

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

typedef WdsCliGetImageParameterNative = Int32 Function(Pointer<Void>, Int32, Pointer<Void>, Uint32);
typedef WdsCliGetImageParameterDart = int Function(Pointer<Void>, int, Pointer<Void>, int);
final WdsCliGetImageParameter = DynamicLibrary.open('WDSCLIENTAPI.dll')
    .lookupFunction<WdsCliGetImageParameterNative, WdsCliGetImageParameterDart>('WdsCliGetImageParameter');
// hIfh : HANDLE -> Pointer<Void>
// ParamType : WDS_CLI_IMAGE_PARAM_TYPE -> Int32
// pResponse : void* out -> Pointer<Void>
// uResponseLen : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WdsCliGetImageParameter(
  hIfh: THandle;   // HANDLE
  ParamType: Integer;   // WDS_CLI_IMAGE_PARAM_TYPE
  pResponse: Pointer;   // void* out
  uResponseLen: DWORD   // DWORD
): Integer; stdcall;
  external 'WDSCLIENTAPI.dll' name 'WdsCliGetImageParameter';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WdsCliGetImageParameter"
  c_WdsCliGetImageParameter :: Ptr () -> Int32 -> Ptr () -> Word32 -> IO Int32
-- hIfh : HANDLE -> Ptr ()
-- ParamType : WDS_CLI_IMAGE_PARAM_TYPE -> Int32
-- pResponse : void* out -> Ptr ()
-- uResponseLen : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wdscligetimageparameter =
  foreign "WdsCliGetImageParameter"
    ((ptr void) @-> int32_t @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* hIfh : HANDLE -> (ptr void) *)
(* ParamType : WDS_CLI_IMAGE_PARAM_TYPE -> int32_t *)
(* pResponse : void* out -> (ptr void) *)
(* uResponseLen : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wdsclientapi (t "WDSCLIENTAPI.dll"))
(cffi:use-foreign-library wdsclientapi)

(cffi:defcfun ("WdsCliGetImageParameter" wds-cli-get-image-parameter :convention :stdcall) :int32
  (h-ifh :pointer)   ; HANDLE
  (param-type :int32)   ; WDS_CLI_IMAGE_PARAM_TYPE
  (p-response :pointer)   ; void* out
  (u-response-len :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WdsCliGetImageParameter = Win32::API::More->new('WDSCLIENTAPI',
    'int WdsCliGetImageParameter(HANDLE hIfh, int ParamType, LPVOID pResponse, DWORD uResponseLen)');
# my $ret = $WdsCliGetImageParameter->Call($hIfh, $ParamType, $pResponse, $uResponseLen);
# hIfh : HANDLE -> HANDLE
# ParamType : WDS_CLI_IMAGE_PARAM_TYPE -> int
# pResponse : void* out -> LPVOID
# uResponseLen : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型