ホーム › Storage.IscsiDisc › ReportActiveIScsiTargetMappingsA

ReportActiveIScsiTargetMappingsA

関数

アクティブなiSCSIターゲットのマッピング一覧を報告する（ANSI版）。

DLLISCSIDSC.dll文字セットANSI (-A)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD ReportActiveIScsiTargetMappingsA(
    DWORD* BufferSize,
    DWORD* MappingCount,
    ISCSI_TARGET_MAPPINGA* Mappings
);

パラメーター

名前	型	方向	説明
BufferSize	DWORD*	inout	入力時に Mappings が指すバッファーのサイズ (バイト単位) を格納する場所へのポインター。操作が成功した場合、この場所には取得されたマッピングデータのサイズ (バイト単位) が格納されます。Mappings が指すバッファーが出力データを格納するのに十分でない場合、この場所には必要なバッファーのサイズ (バイト単位) が格納されます。
MappingCount	DWORD*	inout	操作が成功した場合、MappingCount が指す場所に、取得されたマッピングの数が格納されます。
Mappings	ISCSI_TARGET_MAPPINGA*	inout	ISCSI_TARGET_MAPPING 型の配列へのポインター。出力時に、すべてのイニシエーターのアクティブなターゲットマッピングが格納されます。

戻り値の型: DWORD

公式ドキュメント

ReportActiveIscsiTargetMappings 関数は、コンピューター上のすべてのイニシエーターについて現在アクティブなターゲットマッピングを取得します。(ANSI)

戻り値

操作が成功した場合は ERROR_SUCCESS を返し、バッファーのサイズが十分でない場合は ERROR_INSUFFICIENT_BUFFER を返します。

それ以外の場合、失敗時には ReportActiveIscsiTargetMappings は適切な Win32 または iSCSI のエラーコードを返します。

解説(Remarks)

ターゲットマッピングは、バス番号、ターゲット番号、および LUN 番号を、ターゲットデバイス上の LUN に関連付けます。

メモ

iscsidsc.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして ReportActiveIScsiTargetMappings を定義しています。エンコード中立のエイリアスを、エンコード中立でないコードと混在して使用すると、不一致が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

DWORD ReportActiveIScsiTargetMappingsA(
    DWORD* BufferSize,
    DWORD* MappingCount,
    ISCSI_TARGET_MAPPINGA* Mappings
);

[DllImport("ISCSIDSC.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint ReportActiveIScsiTargetMappingsA(
    ref uint BufferSize,   // DWORD* in/out
    ref uint MappingCount,   // DWORD* in/out
    IntPtr Mappings   // ISCSI_TARGET_MAPPINGA* in/out
);

<DllImport("ISCSIDSC.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function ReportActiveIScsiTargetMappingsA(
    ByRef BufferSize As UInteger,   ' DWORD* in/out
    ByRef MappingCount As UInteger,   ' DWORD* in/out
    Mappings As IntPtr   ' ISCSI_TARGET_MAPPINGA* in/out
) As UInteger
End Function

' BufferSize : DWORD* in/out
' MappingCount : DWORD* in/out
' Mappings : ISCSI_TARGET_MAPPINGA* in/out
Declare PtrSafe Function ReportActiveIScsiTargetMappingsA Lib "iscsidsc" ( _
    ByRef BufferSize As Long, _
    ByRef MappingCount As Long, _
    ByVal Mappings As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ReportActiveIScsiTargetMappingsA = ctypes.windll.iscsidsc.ReportActiveIScsiTargetMappingsA
ReportActiveIScsiTargetMappingsA.restype = wintypes.DWORD
ReportActiveIScsiTargetMappingsA.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # BufferSize : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # MappingCount : DWORD* in/out
    ctypes.c_void_p,  # Mappings : ISCSI_TARGET_MAPPINGA* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ISCSIDSC.dll')
ReportActiveIScsiTargetMappingsA = Fiddle::Function.new(
  lib['ReportActiveIScsiTargetMappingsA'],
  [
    Fiddle::TYPE_VOIDP,  # BufferSize : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # MappingCount : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # Mappings : ISCSI_TARGET_MAPPINGA* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iscsidsc")]
extern "system" {
    fn ReportActiveIScsiTargetMappingsA(
        BufferSize: *mut u32,  // DWORD* in/out
        MappingCount: *mut u32,  // DWORD* in/out
        Mappings: *mut ISCSI_TARGET_MAPPINGA  // ISCSI_TARGET_MAPPINGA* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ISCSIDSC.dll", CharSet = CharSet.Ansi)]
public static extern uint ReportActiveIScsiTargetMappingsA(ref uint BufferSize, ref uint MappingCount, IntPtr Mappings);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ISCSIDSC_ReportActiveIScsiTargetMappingsA' -Namespace Win32 -PassThru
# $api::ReportActiveIScsiTargetMappingsA(BufferSize, MappingCount, Mappings)

#uselib "ISCSIDSC.dll"
#func global ReportActiveIScsiTargetMappingsA "ReportActiveIScsiTargetMappingsA" sptr, sptr, sptr
; ReportActiveIScsiTargetMappingsA varptr(BufferSize), varptr(MappingCount), varptr(Mappings)   ; 戻り値は stat
; BufferSize : DWORD* in/out -> "sptr"
; MappingCount : DWORD* in/out -> "sptr"
; Mappings : ISCSI_TARGET_MAPPINGA* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ISCSIDSC.dll"
#cfunc global ReportActiveIScsiTargetMappingsA "ReportActiveIScsiTargetMappingsA" var, var, var
; res = ReportActiveIScsiTargetMappingsA(BufferSize, MappingCount, Mappings)
; BufferSize : DWORD* in/out -> "var"
; MappingCount : DWORD* in/out -> "var"
; Mappings : ISCSI_TARGET_MAPPINGA* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ISCSIDSC.dll"
#cfunc global ReportActiveIScsiTargetMappingsA "ReportActiveIScsiTargetMappingsA" sptr, sptr, sptr
; res = ReportActiveIScsiTargetMappingsA(varptr(BufferSize), varptr(MappingCount), varptr(Mappings))
; BufferSize : DWORD* in/out -> "sptr"
; MappingCount : DWORD* in/out -> "sptr"
; Mappings : ISCSI_TARGET_MAPPINGA* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。