Win32 API 日本語リファレンス
ホームStorage.IscsiDisc › ReportIScsiTargetsW

ReportIScsiTargetsW

関数
イニシエーターが利用可能なiSCSIターゲットの一覧を報告する。
DLLISCSIDSC.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD ReportIScsiTargetsW(
    BOOLEAN ForceUpdate,
    DWORD* BufferSize,
    LPWSTR Buffer   // optional
);

パラメーター

名前方向説明
ForceUpdateBOOLEANinTRUEで再探索を強制し最新ターゲット一覧を取得するか示すBOOLEAN値。
BufferSizeDWORD*inout入力でBufferのサイズ、出力で必要サイズを受け取るDWORDへのポインタ。
BufferLPWSTRinoutoptionalターゲット名をNULL区切りで受け取るUnicodeバッファを指す。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD ReportIScsiTargetsW(
    BOOLEAN ForceUpdate,
    DWORD* BufferSize,
    LPWSTR Buffer   // optional
);
[DllImport("ISCSIDSC.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint ReportIScsiTargetsW(
    [MarshalAs(UnmanagedType.U1)] bool ForceUpdate,   // BOOLEAN
    ref uint BufferSize,   // DWORD* in/out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder Buffer   // LPWSTR optional, in/out
);
<DllImport("ISCSIDSC.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function ReportIScsiTargetsW(
    <MarshalAs(UnmanagedType.U1)> ForceUpdate As Boolean,   ' BOOLEAN
    ByRef BufferSize As UInteger,   ' DWORD* in/out
    <MarshalAs(UnmanagedType.LPWStr)> Buffer As System.Text.StringBuilder   ' LPWSTR optional, in/out
) As UInteger
End Function
' ForceUpdate : BOOLEAN
' BufferSize : DWORD* in/out
' Buffer : LPWSTR optional, in/out
Declare PtrSafe Function ReportIScsiTargetsW Lib "iscsidsc" ( _
    ByVal ForceUpdate As Byte, _
    ByRef BufferSize As Long, _
    ByVal Buffer 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

ReportIScsiTargetsW = ctypes.windll.iscsidsc.ReportIScsiTargetsW
ReportIScsiTargetsW.restype = wintypes.DWORD
ReportIScsiTargetsW.argtypes = [
    wintypes.BOOLEAN,  # ForceUpdate : BOOLEAN
    ctypes.POINTER(wintypes.DWORD),  # BufferSize : DWORD* in/out
    wintypes.LPWSTR,  # Buffer : LPWSTR optional, in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ISCSIDSC.dll')
ReportIScsiTargetsW = Fiddle::Function.new(
  lib['ReportIScsiTargetsW'],
  [
    Fiddle::TYPE_CHAR,  # ForceUpdate : BOOLEAN
    Fiddle::TYPE_VOIDP,  # BufferSize : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # Buffer : LPWSTR optional, in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "iscsidsc")]
extern "system" {
    fn ReportIScsiTargetsW(
        ForceUpdate: u8,  // BOOLEAN
        BufferSize: *mut u32,  // DWORD* in/out
        Buffer: *mut u16  // LPWSTR optional, in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ISCSIDSC.dll", CharSet = CharSet.Unicode)]
public static extern uint ReportIScsiTargetsW([MarshalAs(UnmanagedType.U1)] bool ForceUpdate, ref uint BufferSize, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder Buffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ISCSIDSC_ReportIScsiTargetsW' -Namespace Win32 -PassThru
# $api::ReportIScsiTargetsW(ForceUpdate, BufferSize, Buffer)
#uselib "ISCSIDSC.dll"
#func global ReportIScsiTargetsW "ReportIScsiTargetsW" wptr, wptr, wptr
; ReportIScsiTargetsW ForceUpdate, varptr(BufferSize), varptr(Buffer)   ; 戻り値は stat
; ForceUpdate : BOOLEAN -> "wptr"
; BufferSize : DWORD* in/out -> "wptr"
; Buffer : LPWSTR optional, in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ISCSIDSC.dll"
#cfunc global ReportIScsiTargetsW "ReportIScsiTargetsW" int, var, var
; res = ReportIScsiTargetsW(ForceUpdate, BufferSize, Buffer)
; ForceUpdate : BOOLEAN -> "int"
; BufferSize : DWORD* in/out -> "var"
; Buffer : LPWSTR optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD ReportIScsiTargetsW(BOOLEAN ForceUpdate, DWORD* BufferSize, LPWSTR Buffer)
#uselib "ISCSIDSC.dll"
#cfunc global ReportIScsiTargetsW "ReportIScsiTargetsW" int, var, var
; res = ReportIScsiTargetsW(ForceUpdate, BufferSize, Buffer)
; ForceUpdate : BOOLEAN -> "int"
; BufferSize : DWORD* in/out -> "var"
; Buffer : LPWSTR optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iscsidsc = windows.NewLazySystemDLL("ISCSIDSC.dll")
	procReportIScsiTargetsW = iscsidsc.NewProc("ReportIScsiTargetsW")
)

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

extern "iscsidsc" fn ReportIScsiTargetsW(
    ForceUpdate: u8, // BOOLEAN
    BufferSize: [*c]u32, // DWORD* in/out
    Buffer: [*c]u16 // LPWSTR optional, in/out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc ReportIScsiTargetsW(
    ForceUpdate: uint8,  # BOOLEAN
    BufferSize: ptr uint32,  # DWORD* in/out
    Buffer: ptr uint16  # LPWSTR optional, in/out
): uint32 {.importc: "ReportIScsiTargetsW", stdcall, dynlib: "ISCSIDSC.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "iscsidsc");
extern(Windows)
uint ReportIScsiTargetsW(
    ubyte ForceUpdate,   // BOOLEAN
    uint* BufferSize,   // DWORD* in/out
    wchar* Buffer   // LPWSTR optional, in/out
);
ccall((:ReportIScsiTargetsW, "ISCSIDSC.dll"), stdcall, UInt32,
      (UInt8, Ptr{UInt32}, Ptr{UInt16}),
      ForceUpdate, BufferSize, Buffer)
# ForceUpdate : BOOLEAN -> UInt8
# BufferSize : DWORD* in/out -> Ptr{UInt32}
# Buffer : LPWSTR optional, in/out -> Ptr{UInt16}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t ReportIScsiTargetsW(
    uint8_t ForceUpdate,
    uint32_t* BufferSize,
    uint16_t* Buffer);
]]
local iscsidsc = ffi.load("iscsidsc")
-- iscsidsc.ReportIScsiTargetsW(ForceUpdate, BufferSize, Buffer)
-- ForceUpdate : BOOLEAN
-- BufferSize : DWORD* in/out
-- Buffer : LPWSTR optional, 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('ISCSIDSC.dll');
const ReportIScsiTargetsW = lib.func('__stdcall', 'ReportIScsiTargetsW', 'uint32_t', ['uint8_t', 'uint32_t *', 'uint16_t *']);
// ReportIScsiTargetsW(ForceUpdate, BufferSize, Buffer)
// ForceUpdate : BOOLEAN -> 'uint8_t'
// BufferSize : DWORD* in/out -> 'uint32_t *'
// Buffer : LPWSTR optional, in/out -> 'uint16_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ISCSIDSC.dll", {
  ReportIScsiTargetsW: { parameters: ["u8", "pointer", "buffer"], result: "u32" },
});
// lib.symbols.ReportIScsiTargetsW(ForceUpdate, BufferSize, Buffer)
// ForceUpdate : BOOLEAN -> "u8"
// BufferSize : DWORD* in/out -> "pointer"
// Buffer : LPWSTR optional, in/out -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t ReportIScsiTargetsW(
    uint8_t ForceUpdate,
    uint32_t* BufferSize,
    uint16_t* Buffer);
C, "ISCSIDSC.dll");
// $ffi->ReportIScsiTargetsW(ForceUpdate, BufferSize, Buffer);
// ForceUpdate : BOOLEAN
// BufferSize : DWORD* in/out
// Buffer : LPWSTR optional, 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 Iscsidsc extends StdCallLibrary {
    Iscsidsc INSTANCE = Native.load("iscsidsc", Iscsidsc.class, W32APIOptions.UNICODE_OPTIONS);
    int ReportIScsiTargetsW(
        byte ForceUpdate,   // BOOLEAN
        IntByReference BufferSize,   // DWORD* in/out
        char[] Buffer   // LPWSTR optional, in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("iscsidsc")]
lib LibISCSIDSC
  fun ReportIScsiTargetsW = ReportIScsiTargetsW(
    ForceUpdate : UInt8,   # BOOLEAN
    BufferSize : UInt32*,   # DWORD* in/out
    Buffer : UInt16*   # LPWSTR optional, 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 ReportIScsiTargetsWNative = Uint32 Function(Uint8, Pointer<Uint32>, Pointer<Utf16>);
typedef ReportIScsiTargetsWDart = int Function(int, Pointer<Uint32>, Pointer<Utf16>);
final ReportIScsiTargetsW = DynamicLibrary.open('ISCSIDSC.dll')
    .lookupFunction<ReportIScsiTargetsWNative, ReportIScsiTargetsWDart>('ReportIScsiTargetsW');
// ForceUpdate : BOOLEAN -> Uint8
// BufferSize : DWORD* in/out -> Pointer<Uint32>
// Buffer : LPWSTR optional, in/out -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ReportIScsiTargetsW(
  ForceUpdate: ByteBool;   // BOOLEAN
  BufferSize: Pointer;   // DWORD* in/out
  Buffer: PWideChar   // LPWSTR optional, in/out
): DWORD; stdcall;
  external 'ISCSIDSC.dll' name 'ReportIScsiTargetsW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ReportIScsiTargetsW"
  c_ReportIScsiTargetsW :: Word8 -> Ptr Word32 -> CWString -> IO Word32
-- ForceUpdate : BOOLEAN -> Word8
-- BufferSize : DWORD* in/out -> Ptr Word32
-- Buffer : LPWSTR optional, in/out -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let reportiscsitargetsw =
  foreign "ReportIScsiTargetsW"
    (uint8_t @-> (ptr uint32_t) @-> (ptr uint16_t) @-> returning uint32_t)
(* ForceUpdate : BOOLEAN -> uint8_t *)
(* BufferSize : DWORD* in/out -> (ptr uint32_t) *)
(* Buffer : LPWSTR optional, in/out -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iscsidsc (t "ISCSIDSC.dll"))
(cffi:use-foreign-library iscsidsc)

(cffi:defcfun ("ReportIScsiTargetsW" report-iscsi-targets-w :convention :stdcall) :uint32
  (force-update :uint8)   ; BOOLEAN
  (buffer-size :pointer)   ; DWORD* in/out
  (buffer :pointer))   ; LPWSTR optional, in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ReportIScsiTargetsW = Win32::API::More->new('ISCSIDSC',
    'DWORD ReportIScsiTargetsW(BYTE ForceUpdate, LPVOID BufferSize, LPWSTR Buffer)');
# my $ret = $ReportIScsiTargetsW->Call($ForceUpdate, $BufferSize, $Buffer);
# ForceUpdate : BOOLEAN -> BYTE
# BufferSize : DWORD* in/out -> LPVOID
# Buffer : LPWSTR optional, in/out -> LPWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い