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

ReportIScsiTargetPortalsA

関数
iSCSIターゲットポータル一覧を報告する（ANSI版）。
DLLISCSIDSC.dll文字セットANSI (-A)呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

DWORD ReportIScsiTargetPortalsA(
    LPSTR InitiatorName,   // optional
    LPSTR TargetName,
    WORD* TargetPortalTag,
    DWORD* ElementCount,
    ISCSI_TARGET_PORTALA* Portals
);

パラメーター

名前型方向説明
InitiatorNameLPSTRinoptional対象とするイニシエータのHBA名を指すANSI文字列。
TargetNameLPSTRinポータル情報を取得する対象ターゲット名(IQN)を指すANSI文字列。
TargetPortalTagWORD*inout対象とするターゲットポータルグループタグを指すWORDポインタ。NULL可。
ElementCountDWORD*inout入出力でPortals配列の要素数を指すポインタ。ポータル数が返る。
PortalsISCSI_TARGET_PORTALA*inoutターゲットポータル情報の配列を受け取るISCSI_TARGET_PORTALA構造体へのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD ReportIScsiTargetPortalsA(
    LPSTR InitiatorName,   // optional
    LPSTR TargetName,
    WORD* TargetPortalTag,
    DWORD* ElementCount,
    ISCSI_TARGET_PORTALA* Portals
);
[DllImport("ISCSIDSC.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint ReportIScsiTargetPortalsA(
    [MarshalAs(UnmanagedType.LPStr)] string InitiatorName,   // LPSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string TargetName,   // LPSTR
    ref ushort TargetPortalTag,   // WORD* in/out
    ref uint ElementCount,   // DWORD* in/out
    IntPtr Portals   // ISCSI_TARGET_PORTALA* in/out
);
<DllImport("ISCSIDSC.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function ReportIScsiTargetPortalsA(
    <MarshalAs(UnmanagedType.LPStr)> InitiatorName As String,   ' LPSTR optional
    <MarshalAs(UnmanagedType.LPStr)> TargetName As String,   ' LPSTR
    ByRef TargetPortalTag As UShort,   ' WORD* in/out
    ByRef ElementCount As UInteger,   ' DWORD* in/out
    Portals As IntPtr   ' ISCSI_TARGET_PORTALA* in/out
) As UInteger
End Function
' InitiatorName : LPSTR optional
' TargetName : LPSTR
' TargetPortalTag : WORD* in/out
' ElementCount : DWORD* in/out
' Portals : ISCSI_TARGET_PORTALA* in/out
Declare PtrSafe Function ReportIScsiTargetPortalsA Lib "iscsidsc" ( _
    ByVal InitiatorName As String, _
    ByVal TargetName As String, _
    ByRef TargetPortalTag As Integer, _
    ByRef ElementCount As Long, _
    ByVal Portals As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ReportIScsiTargetPortalsA = ctypes.windll.iscsidsc.ReportIScsiTargetPortalsA
ReportIScsiTargetPortalsA.restype = wintypes.DWORD
ReportIScsiTargetPortalsA.argtypes = [
    wintypes.LPCSTR,  # InitiatorName : LPSTR optional
    wintypes.LPCSTR,  # TargetName : LPSTR
    ctypes.POINTER(ctypes.c_ushort),  # TargetPortalTag : WORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # ElementCount : DWORD* in/out
    ctypes.c_void_p,  # Portals : ISCSI_TARGET_PORTALA* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iscsidsc = windows.NewLazySystemDLL("ISCSIDSC.dll")
	procReportIScsiTargetPortalsA = iscsidsc.NewProc("ReportIScsiTargetPortalsA")
)

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

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

foreign import stdcall safe "ReportIScsiTargetPortalsA"
  c_ReportIScsiTargetPortalsA :: CString -> CString -> Ptr Word16 -> Ptr Word32 -> Ptr () -> IO Word32
-- InitiatorName : LPSTR optional -> CString
-- TargetName : LPSTR -> CString
-- TargetPortalTag : WORD* in/out -> Ptr Word16
-- ElementCount : DWORD* in/out -> Ptr Word32
-- Portals : ISCSI_TARGET_PORTALA* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let reportiscsitargetportalsa =
  foreign "ReportIScsiTargetPortalsA"
    (string @-> string @-> (ptr uint16_t) @-> (ptr uint32_t) @-> (ptr void) @-> returning uint32_t)
(* InitiatorName : LPSTR optional -> string *)
(* TargetName : LPSTR -> string *)
(* TargetPortalTag : WORD* in/out -> (ptr uint16_t) *)
(* ElementCount : DWORD* in/out -> (ptr uint32_t) *)
(* Portals : ISCSI_TARGET_PORTALA* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iscsidsc (t "ISCSIDSC.dll"))
(cffi:use-foreign-library iscsidsc)

(cffi:defcfun ("ReportIScsiTargetPortalsA" report-iscsi-target-portals-a :convention :stdcall) :uint32
  (initiator-name :string)   ; LPSTR optional
  (target-name :string)   ; LPSTR
  (target-portal-tag :pointer)   ; WORD* in/out
  (element-count :pointer)   ; DWORD* in/out
  (portals :pointer))   ; ISCSI_TARGET_PORTALA* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ReportIScsiTargetPortalsA = Win32::API::More->new('ISCSIDSC',
    'DWORD ReportIScsiTargetPortalsA(LPCSTR InitiatorName, LPCSTR TargetName, LPVOID TargetPortalTag, LPVOID ElementCount, LPVOID Portals)');
# my $ret = $ReportIScsiTargetPortalsA->Call($InitiatorName, $TargetName, $TargetPortalTag, $ElementCount, $Portals);
# InitiatorName : LPSTR optional -> LPCSTR
# TargetName : LPSTR -> LPCSTR
# TargetPortalTag : WORD* in/out -> LPVOID
# ElementCount : DWORD* in/out -> LPVOID
# Portals : ISCSI_TARGET_PORTALA* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型