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

WdsCliGetImageIndex

関数
WDSイメージのインデックス番号を取得する。
DLLWDSCLIENTAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT WdsCliGetImageIndex(
    HANDLE hIfh,
    DWORD* pdwValue
);

パラメーター

名前方向説明
hIfhHANDLEin対象イメージを示すイメージ情報ハンドル。
pdwValueDWORD*outWIM内におけるイメージのインデックス番号を受け取るDWORDポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

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

WdsCliGetImageIndex = ctypes.windll.wdsclientapi.WdsCliGetImageIndex
WdsCliGetImageIndex.restype = ctypes.c_int
WdsCliGetImageIndex.argtypes = [
    wintypes.HANDLE,  # hIfh : HANDLE
    ctypes.POINTER(wintypes.DWORD),  # pdwValue : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	wdsclientapi = windows.NewLazySystemDLL("WDSCLIENTAPI.dll")
	procWdsCliGetImageIndex = wdsclientapi.NewProc("WdsCliGetImageIndex")
)

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

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

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

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

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

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