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

ReportIScsiTargetsA

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

シグネチャ

// ISCSIDSC.dll  (ANSI / -A)
#include <windows.h>

DWORD ReportIScsiTargetsA(
    BOOLEAN ForceUpdate,
    DWORD* BufferSize,
    LPSTR Buffer   // optional
);

パラメーター

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

戻り値の型: DWORD

各言語での呼び出し定義

// ISCSIDSC.dll  (ANSI / -A)
#include <windows.h>

DWORD ReportIScsiTargetsA(
    BOOLEAN ForceUpdate,
    DWORD* BufferSize,
    LPSTR Buffer   // optional
);
[DllImport("ISCSIDSC.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint ReportIScsiTargetsA(
    [MarshalAs(UnmanagedType.U1)] bool ForceUpdate,   // BOOLEAN
    ref uint BufferSize,   // DWORD* in/out
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder Buffer   // LPSTR optional, in/out
);
<DllImport("ISCSIDSC.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function ReportIScsiTargetsA(
    <MarshalAs(UnmanagedType.U1)> ForceUpdate As Boolean,   ' BOOLEAN
    ByRef BufferSize As UInteger,   ' DWORD* in/out
    <MarshalAs(UnmanagedType.LPStr)> Buffer As System.Text.StringBuilder   ' LPSTR optional, in/out
) As UInteger
End Function
' ForceUpdate : BOOLEAN
' BufferSize : DWORD* in/out
' Buffer : LPSTR optional, in/out
Declare PtrSafe Function ReportIScsiTargetsA Lib "iscsidsc" ( _
    ByVal ForceUpdate As Byte, _
    ByRef BufferSize As Long, _
    ByVal Buffer As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	iscsidsc = windows.NewLazySystemDLL("ISCSIDSC.dll")
	procReportIScsiTargetsA = iscsidsc.NewProc("ReportIScsiTargetsA")
)

// ForceUpdate (BOOLEAN), BufferSize (DWORD* in/out), Buffer (LPSTR optional, in/out)
r1, _, err := procReportIScsiTargetsA.Call(
	uintptr(ForceUpdate),
	uintptr(BufferSize),
	uintptr(Buffer),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function ReportIScsiTargetsA(
  ForceUpdate: ByteBool;   // BOOLEAN
  BufferSize: Pointer;   // DWORD* in/out
  Buffer: PAnsiChar   // LPSTR optional, in/out
): DWORD; stdcall;
  external 'ISCSIDSC.dll' name 'ReportIScsiTargetsA';
result := DllCall("ISCSIDSC\ReportIScsiTargetsA"
    , "Char", ForceUpdate   ; BOOLEAN
    , "Ptr", BufferSize   ; DWORD* in/out
    , "Ptr", Buffer   ; LPSTR optional, in/out
    , "UInt")   ; return: DWORD
●ReportIScsiTargetsA(ForceUpdate, BufferSize, Buffer) = DLL("ISCSIDSC.dll", "dword ReportIScsiTargetsA(byte, void*, char*)")
# 呼び出し: ReportIScsiTargetsA(ForceUpdate, BufferSize, Buffer)
# ForceUpdate : BOOLEAN -> "byte"
# BufferSize : DWORD* in/out -> "void*"
# Buffer : LPSTR optional, in/out -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "iscsidsc" fn ReportIScsiTargetsA(
    ForceUpdate: u8, // BOOLEAN
    BufferSize: [*c]u32, // DWORD* in/out
    Buffer: [*c]u8 // LPSTR optional, in/out
) callconv(std.os.windows.WINAPI) u32;
proc ReportIScsiTargetsA(
    ForceUpdate: uint8,  # BOOLEAN
    BufferSize: ptr uint32,  # DWORD* in/out
    Buffer: ptr char  # LPSTR optional, in/out
): uint32 {.importc: "ReportIScsiTargetsA", stdcall, dynlib: "ISCSIDSC.dll".}
pragma(lib, "iscsidsc");
extern(Windows)
uint ReportIScsiTargetsA(
    ubyte ForceUpdate,   // BOOLEAN
    uint* BufferSize,   // DWORD* in/out
    char* Buffer   // LPSTR optional, in/out
);
ccall((:ReportIScsiTargetsA, "ISCSIDSC.dll"), stdcall, UInt32,
      (UInt8, Ptr{UInt32}, Ptr{UInt8}),
      ForceUpdate, BufferSize, Buffer)
# ForceUpdate : BOOLEAN -> UInt8
# BufferSize : DWORD* in/out -> Ptr{UInt32}
# Buffer : LPSTR optional, in/out -> Ptr{UInt8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t ReportIScsiTargetsA(
    uint8_t ForceUpdate,
    uint32_t* BufferSize,
    char* Buffer);
]]
local iscsidsc = ffi.load("iscsidsc")
-- iscsidsc.ReportIScsiTargetsA(ForceUpdate, BufferSize, Buffer)
-- ForceUpdate : BOOLEAN
-- BufferSize : DWORD* in/out
-- Buffer : LPSTR optional, in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ISCSIDSC.dll');
const ReportIScsiTargetsA = lib.func('__stdcall', 'ReportIScsiTargetsA', 'uint32_t', ['uint8_t', 'uint32_t *', 'char *']);
// ReportIScsiTargetsA(ForceUpdate, BufferSize, Buffer)
// ForceUpdate : BOOLEAN -> 'uint8_t'
// BufferSize : DWORD* in/out -> 'uint32_t *'
// Buffer : LPSTR optional, in/out -> 'char *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ISCSIDSC.dll", {
  ReportIScsiTargetsA: { parameters: ["u8", "pointer", "buffer"], result: "u32" },
});
// lib.symbols.ReportIScsiTargetsA(ForceUpdate, BufferSize, Buffer)
// ForceUpdate : BOOLEAN -> "u8"
// BufferSize : DWORD* in/out -> "pointer"
// Buffer : LPSTR optional, in/out -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t ReportIScsiTargetsA(
    uint8_t ForceUpdate,
    uint32_t* BufferSize,
    char* Buffer);
C, "ISCSIDSC.dll");
// $ffi->ReportIScsiTargetsA(ForceUpdate, BufferSize, Buffer);
// ForceUpdate : BOOLEAN
// BufferSize : DWORD* in/out
// Buffer : LPSTR 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.ASCII_OPTIONS);
    int ReportIScsiTargetsA(
        byte ForceUpdate,   // BOOLEAN
        IntByReference BufferSize,   // DWORD* in/out
        byte[] Buffer   // LPSTR optional, in/out
    );
}
@[Link("iscsidsc")]
lib LibISCSIDSC
  fun ReportIScsiTargetsA = ReportIScsiTargetsA(
    ForceUpdate : UInt8,   # BOOLEAN
    BufferSize : UInt32*,   # DWORD* in/out
    Buffer : UInt8*   # LPSTR 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 ReportIScsiTargetsANative = Uint32 Function(Uint8, Pointer<Uint32>, Pointer<Utf8>);
typedef ReportIScsiTargetsADart = int Function(int, Pointer<Uint32>, Pointer<Utf8>);
final ReportIScsiTargetsA = DynamicLibrary.open('ISCSIDSC.dll')
    .lookupFunction<ReportIScsiTargetsANative, ReportIScsiTargetsADart>('ReportIScsiTargetsA');
// ForceUpdate : BOOLEAN -> Uint8
// BufferSize : DWORD* in/out -> Pointer<Uint32>
// Buffer : LPSTR optional, in/out -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ReportIScsiTargetsA(
  ForceUpdate: ByteBool;   // BOOLEAN
  BufferSize: Pointer;   // DWORD* in/out
  Buffer: PAnsiChar   // LPSTR optional, in/out
): DWORD; stdcall;
  external 'ISCSIDSC.dll' name 'ReportIScsiTargetsA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

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

関連項目

文字セット違い