ホーム › Storage.IscsiDisc › GetDevicesForIScsiSessionA

GetDevicesForIScsiSessionA

関数

指定iSCSIセッションのデバイス一覧を取得する（ANSI版）。

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

シグネチャ

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

DWORD GetDevicesForIScsiSessionA(
    ISCSI_UNIQUE_SESSION_ID* UniqueSessionId,
    DWORD* DeviceCount,
    ISCSI_DEVICE_ON_SESSIONA* Devices
);

パラメーター

名前	型	方向	説明
UniqueSessionId	ISCSI_UNIQUE_SESSION_ID*	inout	セッションのセッション識別子を格納する ISCSI_UNIQUE_SESSION_ID 型の構造体へのポインター。
DeviceCount	DWORD*	inout	入力時に、Devices が指すバッファーに収容できる ISCSI_DEVICE_ON_SESSION 型の要素数を格納する場所へのポインター。操作が成功すると、この場所には取得された要素数が格納されます。GetDevicesForIscsiSession が ERROR_INSUFFICIENT_BUFFER を返す場合でも、この場所にはバッファーが収容できる要素数が格納されます。
Devices	ISCSI_DEVICE_ON_SESSIONA*	inout	出力時に、セッションに関連付けられている各デバイスに関する情報を受け取る ISCSI_DEVICE_ON_SESSION 型構造体の配列。

戻り値の型: DWORD

公式ドキュメント

GetDevicesForIscsiSession 関数は、現在のセッションに関連付けられているデバイスに関する情報を取得します。(ANSI)

戻り値

操作が成功した場合は ERROR_SUCCESS を返します。呼び出し元が Devices の配列に対して割り当てたバッファー領域が不足している場合は ERROR_INSUFFICIENT_BUFFER を返します。

それ以外の場合、GetDevicesForIscsiSession は失敗時に該当する Win32 または iSCSI のエラーコードを返します。

解説(Remarks)

メモ

iscsidsc.h ヘッダーは GetDevicesForIScsiSession を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版と Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因になることがあります。詳細については、「Conventions for Function Prototypes」を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetDevicesForIScsiSessionA(
    ISCSI_UNIQUE_SESSION_ID* UniqueSessionId,
    DWORD* DeviceCount,
    ISCSI_DEVICE_ON_SESSIONA* Devices
);

[DllImport("ISCSIDSC.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint GetDevicesForIScsiSessionA(
    IntPtr UniqueSessionId,   // ISCSI_UNIQUE_SESSION_ID* in/out
    ref uint DeviceCount,   // DWORD* in/out
    IntPtr Devices   // ISCSI_DEVICE_ON_SESSIONA* in/out
);

<DllImport("ISCSIDSC.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetDevicesForIScsiSessionA(
    UniqueSessionId As IntPtr,   ' ISCSI_UNIQUE_SESSION_ID* in/out
    ByRef DeviceCount As UInteger,   ' DWORD* in/out
    Devices As IntPtr   ' ISCSI_DEVICE_ON_SESSIONA* in/out
) As UInteger
End Function

' UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out
' DeviceCount : DWORD* in/out
' Devices : ISCSI_DEVICE_ON_SESSIONA* in/out
Declare PtrSafe Function GetDevicesForIScsiSessionA Lib "iscsidsc" ( _
    ByVal UniqueSessionId As LongPtr, _
    ByRef DeviceCount As Long, _
    ByVal Devices As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetDevicesForIScsiSessionA = ctypes.windll.iscsidsc.GetDevicesForIScsiSessionA
GetDevicesForIScsiSessionA.restype = wintypes.DWORD
GetDevicesForIScsiSessionA.argtypes = [
    ctypes.c_void_p,  # UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out
    ctypes.POINTER(wintypes.DWORD),  # DeviceCount : DWORD* in/out
    ctypes.c_void_p,  # Devices : ISCSI_DEVICE_ON_SESSIONA* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ISCSIDSC.dll')
GetDevicesForIScsiSessionA = Fiddle::Function.new(
  lib['GetDevicesForIScsiSessionA'],
  [
    Fiddle::TYPE_VOIDP,  # UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out
    Fiddle::TYPE_VOIDP,  # DeviceCount : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # Devices : ISCSI_DEVICE_ON_SESSIONA* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iscsidsc")]
extern "system" {
    fn GetDevicesForIScsiSessionA(
        UniqueSessionId: *mut ISCSI_UNIQUE_SESSION_ID,  // ISCSI_UNIQUE_SESSION_ID* in/out
        DeviceCount: *mut u32,  // DWORD* in/out
        Devices: *mut ISCSI_DEVICE_ON_SESSIONA  // ISCSI_DEVICE_ON_SESSIONA* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ISCSIDSC.dll", CharSet = CharSet.Ansi)]
public static extern uint GetDevicesForIScsiSessionA(IntPtr UniqueSessionId, ref uint DeviceCount, IntPtr Devices);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ISCSIDSC_GetDevicesForIScsiSessionA' -Namespace Win32 -PassThru
# $api::GetDevicesForIScsiSessionA(UniqueSessionId, DeviceCount, Devices)

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

出力引数:

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