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

ReportIScsiTargetPortalsW

関数
指定ターゲットのiSCSIターゲットポータル一覧を報告する。
DLLISCSIDSC.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD ReportIScsiTargetPortalsW(
    LPWSTR InitiatorName,   // optional
    LPWSTR TargetName,
    WORD* TargetPortalTag,
    DWORD* ElementCount,
    ISCSI_TARGET_PORTALW* Portals
);

パラメーター

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

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD ReportIScsiTargetPortalsW(
    LPWSTR InitiatorName,   // optional
    LPWSTR TargetName,
    WORD* TargetPortalTag,
    DWORD* ElementCount,
    ISCSI_TARGET_PORTALW* Portals
);
[DllImport("ISCSIDSC.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint ReportIScsiTargetPortalsW(
    [MarshalAs(UnmanagedType.LPWStr)] string InitiatorName,   // LPWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string TargetName,   // LPWSTR
    ref ushort TargetPortalTag,   // WORD* in/out
    ref uint ElementCount,   // DWORD* in/out
    IntPtr Portals   // ISCSI_TARGET_PORTALW* in/out
);
<DllImport("ISCSIDSC.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function ReportIScsiTargetPortalsW(
    <MarshalAs(UnmanagedType.LPWStr)> InitiatorName As String,   ' LPWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> TargetName As String,   ' LPWSTR
    ByRef TargetPortalTag As UShort,   ' WORD* in/out
    ByRef ElementCount As UInteger,   ' DWORD* in/out
    Portals As IntPtr   ' ISCSI_TARGET_PORTALW* in/out
) As UInteger
End Function
' InitiatorName : LPWSTR optional
' TargetName : LPWSTR
' TargetPortalTag : WORD* in/out
' ElementCount : DWORD* in/out
' Portals : ISCSI_TARGET_PORTALW* in/out
Declare PtrSafe Function ReportIScsiTargetPortalsW Lib "iscsidsc" ( _
    ByVal InitiatorName As LongPtr, _
    ByVal TargetName As LongPtr, _
    ByRef TargetPortalTag As Integer, _
    ByRef ElementCount As Long, _
    ByVal Portals 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

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

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

var (
	iscsidsc = windows.NewLazySystemDLL("ISCSIDSC.dll")
	procReportIScsiTargetPortalsW = iscsidsc.NewProc("ReportIScsiTargetPortalsW")
)

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

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

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

let reportiscsitargetportalsw =
  foreign "ReportIScsiTargetPortalsW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint32_t) @-> (ptr void) @-> returning uint32_t)
(* InitiatorName : LPWSTR optional -> (ptr uint16_t) *)
(* TargetName : LPWSTR -> (ptr uint16_t) *)
(* TargetPortalTag : WORD* in/out -> (ptr uint16_t) *)
(* ElementCount : DWORD* in/out -> (ptr uint32_t) *)
(* Portals : ISCSI_TARGET_PORTALW* 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 ("ReportIScsiTargetPortalsW" report-iscsi-target-portals-w :convention :stdcall) :uint32
  (initiator-name (:string :encoding :utf-16le))   ; LPWSTR optional
  (target-name (:string :encoding :utf-16le))   ; LPWSTR
  (target-portal-tag :pointer)   ; WORD* in/out
  (element-count :pointer)   ; DWORD* in/out
  (portals :pointer))   ; ISCSI_TARGET_PORTALW* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ReportIScsiTargetPortalsW = Win32::API::More->new('ISCSIDSC',
    'DWORD ReportIScsiTargetPortalsW(LPCWSTR InitiatorName, LPCWSTR TargetName, LPVOID TargetPortalTag, LPVOID ElementCount, LPVOID Portals)');
# my $ret = $ReportIScsiTargetPortalsW->Call($InitiatorName, $TargetName, $TargetPortalTag, $ElementCount, $Portals);
# InitiatorName : LPWSTR optional -> LPCWSTR
# TargetName : LPWSTR -> LPCWSTR
# TargetPortalTag : WORD* in/out -> LPVOID
# ElementCount : DWORD* in/out -> LPVOID
# Portals : ISCSI_TARGET_PORTALW* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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