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

WdsCliFindFirstImage

関数
WDSセッションでイメージ列挙を開始し最初の検索ハンドルを返す。
DLLWDSCLIENTAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT WdsCliFindFirstImage(
    HANDLE hSession,
    HANDLE* phFindHandle
);

パラメーター

名前方向説明
hSessionHANDLEinイメージ列挙に使用するWDSセッションのハンドル。
phFindHandleHANDLE*out最初のイメージを指す検索ハンドルを受け取るポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

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

WdsCliFindFirstImage = ctypes.windll.wdsclientapi.WdsCliFindFirstImage
WdsCliFindFirstImage.restype = ctypes.c_int
WdsCliFindFirstImage.argtypes = [
    wintypes.HANDLE,  # hSession : HANDLE
    ctypes.c_void_p,  # phFindHandle : HANDLE* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	wdsclientapi = windows.NewLazySystemDLL("WDSCLIENTAPI.dll")
	procWdsCliFindFirstImage = wdsclientapi.NewProc("WdsCliFindFirstImage")
)

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

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

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

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

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

(cffi:defcfun ("WdsCliFindFirstImage" wds-cli-find-first-image :convention :stdcall) :int32
  (h-session :pointer)   ; HANDLE
  (ph-find-handle :pointer))   ; HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WdsCliFindFirstImage = Win32::API::More->new('WDSCLIENTAPI',
    'int WdsCliFindFirstImage(HANDLE hSession, HANDLE phFindHandle)');
# my $ret = $WdsCliFindFirstImage->Call($hSession, $phFindHandle);
# hSession : HANDLE -> HANDLE
# phFindHandle : HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。