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

ISCSI_TARGET_PORTAL_INFO_EXW

構造体
サイズx64: 1616 バイト / x86: 1608 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
InitiatorNameWCHAR512+0+0ホストバスアダプター (HBA) イニシエーターの名前を表す文字列です。
InitiatorPortNumberDWORD4+512+512ポータルに関連付けられた HBA 上のポート番号を表す ULONG 値です。
SymbolicNameWCHAR512+516+516ポータルに関連付けられたシンボリック名を表す文字列です。
AddressWCHAR512+1028+1028ポータルに関連付けられた IP アドレスまたは DNS 名を表す文字列です。
SocketWORD2+1540+1540ソケット番号を表す USHORT 値です。
SecurityFlagsULONGLONG8+1544+1544

ログイン接続のセキュリティ特性を定義するビットマップを格納する ISCSI_SECURITY_FLAGS 構造体へのポインターです。

意味
ISCSI_SECURITY_FLAG_TUNNEL_MODE_PREFERRED
1 に設定すると、イニシエーターは IPsec トンネルモードで接続を確立します。呼び出し元は、このフラグまたは ISCSI_SECURITY_FLAG_TRANSPORT_MODE_PREFERRED フラグのいずれか一方を設定します。両方を設定することはできません。
ISCSI_SECURITY_FLAG_TRANSPORT_MODE_PREFERRED
1 に設定すると、イニシエーターは IPsec トランスポートモードで接続を確立します。呼び出し元は、このフラグまたは ISCSI_SECURITY_FLAG_TUNNEL_MODE_PREFERRED フラグのいずれか一方を設定します。両方を設定することはできません。
ISCSI_SECURITY_FLAG_PFS_ENABLED
1 に設定すると、イニシエーターは Perfect Forward Secrecy (PFS) モードを有効にして接続を確立します。それ以外の場合、イニシエーターは PFS モードを無効にして接続を確立します。
ISCSI_SECURITY_FLAG_AGGRESSIVE_MODE_ENABLED
1 に設定すると、イニシエーターはアグレッシブモードを有効にして接続を確立します。呼び出し元は、このフラグまたは ISCSI_SECURITY_FLAG_MAIN_MODE_ENABLED フラグのいずれか一方を設定します。両方を設定することはできません。
メモ Microsoft のソフトウェアイニシエータードライバーはアグレッシブモードをサポートしていません。
ISCSI_SECURITY_FLAG_MAIN_MODE_ENABLED
1 に設定すると、イニシエーターはメインモードを有効にして接続を確立します。呼び出し元は、このフラグまたは ISCSI_SECURITY_FLAG_AGGRESSIVE_MODE_ENABLED フラグのいずれか一方を設定します。両方を設定することはできません。
ISCSI_SECURITY_FLAG_IKE_IPSEC_ENABLED
1 に設定すると、イニシエーターは IKE/IPsec プロトコルを有効にして接続を確立します。それ以外の場合、IKE/IPsec プロトコルは無効になります。
ISCSI_SECURITY_FLAG_VALID
1 に設定すると、他のマスク値が有効になります。それ以外の場合、iSCSI イニシエーターサービスは、そのターゲットポータルに対して以前に定義されたビットマップ値を使用します。使用できる値がない場合、イニシエーターサービスはレジストリに定義されている既定値を使用します。
LoginOptionsISCSI_LOGIN_OPTIONS64/52+1552+1552ログインデータを定義する ISCSI_LOGIN_OPTIONS 構造体へのポインターです。

公式ドキュメント

ISCSI_TARGET_PORTAL_INFO_EX 構造体は、ターゲットポータルへのログイン資格情報に関する情報を格納します。

解説(Remarks)

メモ

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

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

各言語での定義

#include <windows.h>

// ISCSI_LOGIN_OPTIONS  (x64 64 / x86 52 バイト)
typedef struct ISCSI_LOGIN_OPTIONS {
    DWORD Version;
    DWORD InformationSpecified;
    DWORD LoginFlags;
    ISCSI_AUTH_TYPES AuthType;
    ISCSI_DIGEST_TYPES HeaderDigest;
    ISCSI_DIGEST_TYPES DataDigest;
    DWORD MaximumConnections;
    DWORD DefaultTime2Wait;
    DWORD DefaultTime2Retain;
    DWORD UsernameLength;
    DWORD PasswordLength;
    BYTE* Username;
    BYTE* Password;
} ISCSI_LOGIN_OPTIONS;

// ISCSI_TARGET_PORTAL_INFO_EXW  (x64 1616 / x86 1608 バイト)
typedef struct ISCSI_TARGET_PORTAL_INFO_EXW {
    WCHAR InitiatorName[256];
    DWORD InitiatorPortNumber;
    WCHAR SymbolicName[256];
    WCHAR Address[256];
    WORD Socket;
    ULONGLONG SecurityFlags;
    ISCSI_LOGIN_OPTIONS LoginOptions;
} ISCSI_TARGET_PORTAL_INFO_EXW;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct ISCSI_LOGIN_OPTIONS
{
    public uint Version;
    public uint InformationSpecified;
    public uint LoginFlags;
    public int AuthType;
    public int HeaderDigest;
    public int DataDigest;
    public uint MaximumConnections;
    public uint DefaultTime2Wait;
    public uint DefaultTime2Retain;
    public uint UsernameLength;
    public uint PasswordLength;
    public IntPtr Username;
    public IntPtr Password;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct ISCSI_TARGET_PORTAL_INFO_EXW
{
    [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 256)] public string InitiatorName;
    public uint InitiatorPortNumber;
    [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 256)] public string SymbolicName;
    [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 256)] public string Address;
    public ushort Socket;
    public ulong SecurityFlags;
    public ISCSI_LOGIN_OPTIONS LoginOptions;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure ISCSI_LOGIN_OPTIONS
    Public Version As UInteger
    Public InformationSpecified As UInteger
    Public LoginFlags As UInteger
    Public AuthType As Integer
    Public HeaderDigest As Integer
    Public DataDigest As Integer
    Public MaximumConnections As UInteger
    Public DefaultTime2Wait As UInteger
    Public DefaultTime2Retain As UInteger
    Public UsernameLength As UInteger
    Public PasswordLength As UInteger
    Public Username As IntPtr
    Public Password As IntPtr
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure ISCSI_TARGET_PORTAL_INFO_EXW
    <MarshalAs(UnmanagedType.ByValTStr, SizeConst:=256)> Public InitiatorName As String
    Public InitiatorPortNumber As UInteger
    <MarshalAs(UnmanagedType.ByValTStr, SizeConst:=256)> Public SymbolicName As String
    <MarshalAs(UnmanagedType.ByValTStr, SizeConst:=256)> Public Address As String
    Public Socket As UShort
    Public SecurityFlags As ULong
    Public LoginOptions As ISCSI_LOGIN_OPTIONS
End Structure
import ctypes
from ctypes import wintypes

class ISCSI_LOGIN_OPTIONS(ctypes.Structure):
    _fields_ = [
        ("Version", wintypes.DWORD),
        ("InformationSpecified", wintypes.DWORD),
        ("LoginFlags", wintypes.DWORD),
        ("AuthType", ctypes.c_int),
        ("HeaderDigest", ctypes.c_int),
        ("DataDigest", ctypes.c_int),
        ("MaximumConnections", wintypes.DWORD),
        ("DefaultTime2Wait", wintypes.DWORD),
        ("DefaultTime2Retain", wintypes.DWORD),
        ("UsernameLength", wintypes.DWORD),
        ("PasswordLength", wintypes.DWORD),
        ("Username", ctypes.c_void_p),
        ("Password", ctypes.c_void_p),
    ]

class ISCSI_TARGET_PORTAL_INFO_EXW(ctypes.Structure):
    _fields_ = [
        ("InitiatorName", ctypes.c_wchar * 256),
        ("InitiatorPortNumber", wintypes.DWORD),
        ("SymbolicName", ctypes.c_wchar * 256),
        ("Address", ctypes.c_wchar * 256),
        ("Socket", ctypes.c_ushort),
        ("SecurityFlags", ctypes.c_ulonglong),
        ("LoginOptions", ISCSI_LOGIN_OPTIONS),
    ]
#[repr(C)]
pub struct ISCSI_LOGIN_OPTIONS {
    pub Version: u32,
    pub InformationSpecified: u32,
    pub LoginFlags: u32,
    pub AuthType: i32,
    pub HeaderDigest: i32,
    pub DataDigest: i32,
    pub MaximumConnections: u32,
    pub DefaultTime2Wait: u32,
    pub DefaultTime2Retain: u32,
    pub UsernameLength: u32,
    pub PasswordLength: u32,
    pub Username: *mut core::ffi::c_void,
    pub Password: *mut core::ffi::c_void,
}

#[repr(C)]
pub struct ISCSI_TARGET_PORTAL_INFO_EXW {
    pub InitiatorName: [u16; 256],
    pub InitiatorPortNumber: u32,
    pub SymbolicName: [u16; 256],
    pub Address: [u16; 256],
    pub Socket: u16,
    pub SecurityFlags: u64,
    pub LoginOptions: ISCSI_LOGIN_OPTIONS,
}
import "golang.org/x/sys/windows"

type ISCSI_LOGIN_OPTIONS struct {
	Version uint32
	InformationSpecified uint32
	LoginFlags uint32
	AuthType int32
	HeaderDigest int32
	DataDigest int32
	MaximumConnections uint32
	DefaultTime2Wait uint32
	DefaultTime2Retain uint32
	UsernameLength uint32
	PasswordLength uint32
	Username uintptr
	Password uintptr
}

type ISCSI_TARGET_PORTAL_INFO_EXW struct {
	InitiatorName [256]uint16
	InitiatorPortNumber uint32
	SymbolicName [256]uint16
	Address [256]uint16
	Socket uint16
	SecurityFlags uint64
	LoginOptions ISCSI_LOGIN_OPTIONS
}
type
  ISCSI_LOGIN_OPTIONS = record
    Version: DWORD;
    InformationSpecified: DWORD;
    LoginFlags: DWORD;
    AuthType: Integer;
    HeaderDigest: Integer;
    DataDigest: Integer;
    MaximumConnections: DWORD;
    DefaultTime2Wait: DWORD;
    DefaultTime2Retain: DWORD;
    UsernameLength: DWORD;
    PasswordLength: DWORD;
    Username: Pointer;
    Password: Pointer;
  end;

  ISCSI_TARGET_PORTAL_INFO_EXW = record
    InitiatorName: array[0..255] of WideChar;
    InitiatorPortNumber: DWORD;
    SymbolicName: array[0..255] of WideChar;
    Address: array[0..255] of WideChar;
    Socket: Word;
    SecurityFlags: UInt64;
    LoginOptions: ISCSI_LOGIN_OPTIONS;
  end;
const ISCSI_LOGIN_OPTIONS = extern struct {
    Version: u32,
    InformationSpecified: u32,
    LoginFlags: u32,
    AuthType: i32,
    HeaderDigest: i32,
    DataDigest: i32,
    MaximumConnections: u32,
    DefaultTime2Wait: u32,
    DefaultTime2Retain: u32,
    UsernameLength: u32,
    PasswordLength: u32,
    Username: ?*anyopaque,
    Password: ?*anyopaque,
};

const ISCSI_TARGET_PORTAL_INFO_EXW = extern struct {
    InitiatorName: [256]u16,
    InitiatorPortNumber: u32,
    SymbolicName: [256]u16,
    Address: [256]u16,
    Socket: u16,
    SecurityFlags: u64,
    LoginOptions: ISCSI_LOGIN_OPTIONS,
};
type
  ISCSI_LOGIN_OPTIONS {.bycopy.} = object
    Version: uint32
    InformationSpecified: uint32
    LoginFlags: uint32
    AuthType: int32
    HeaderDigest: int32
    DataDigest: int32
    MaximumConnections: uint32
    DefaultTime2Wait: uint32
    DefaultTime2Retain: uint32
    UsernameLength: uint32
    PasswordLength: uint32
    Username: pointer
    Password: pointer

  ISCSI_TARGET_PORTAL_INFO_EXW {.bycopy.} = object
    InitiatorName: array[256, uint16]
    InitiatorPortNumber: uint32
    SymbolicName: array[256, uint16]
    Address: array[256, uint16]
    Socket: uint16
    SecurityFlags: uint64
    LoginOptions: ISCSI_LOGIN_OPTIONS
struct ISCSI_LOGIN_OPTIONS
{
    uint Version;
    uint InformationSpecified;
    uint LoginFlags;
    int AuthType;
    int HeaderDigest;
    int DataDigest;
    uint MaximumConnections;
    uint DefaultTime2Wait;
    uint DefaultTime2Retain;
    uint UsernameLength;
    uint PasswordLength;
    void* Username;
    void* Password;
}

struct ISCSI_TARGET_PORTAL_INFO_EXW
{
    wchar[256] InitiatorName;
    uint InitiatorPortNumber;
    wchar[256] SymbolicName;
    wchar[256] Address;
    ushort Socket;
    ulong SecurityFlags;
    ISCSI_LOGIN_OPTIONS LoginOptions;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; ISCSI_TARGET_PORTAL_INFO_EXW サイズ: 1608 バイト(x86)
dim st, 402    ; 4byte整数×402(構造体サイズ 1608 / 4 切り上げ)
; InitiatorName : WCHAR (+0, 512byte)  varptr(st)+0 を基点に操作(512byte:入れ子/配列)
; InitiatorPortNumber : DWORD (+512, 4byte)  st.128 = 値  /  値 = st.128   (lpoke/lpeek も可)
; SymbolicName : WCHAR (+516, 512byte)  varptr(st)+516 を基点に操作(512byte:入れ子/配列)
; Address : WCHAR (+1028, 512byte)  varptr(st)+1028 を基点に操作(512byte:入れ子/配列)
; Socket : WORD (+1540, 2byte)  wpoke st,1540,値  /  値 = wpeek(st,1540)
; SecurityFlags : ULONGLONG (+1544, 8byte)  qpoke st,1544,値 / qpeek(st,1544)  ※IronHSPのみ。3.7/3.8は lpoke st,1544,下位 : lpoke st,1548,上位
; LoginOptions : ISCSI_LOGIN_OPTIONS (+1552, 52byte)  varptr(st)+1552 を基点に操作(52byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; ISCSI_TARGET_PORTAL_INFO_EXW サイズ: 1616 バイト(x64)
dim st, 404    ; 4byte整数×404(構造体サイズ 1616 / 4 切り上げ)
; InitiatorName : WCHAR (+0, 512byte)  varptr(st)+0 を基点に操作(512byte:入れ子/配列)
; InitiatorPortNumber : DWORD (+512, 4byte)  st.128 = 値  /  値 = st.128   (lpoke/lpeek も可)
; SymbolicName : WCHAR (+516, 512byte)  varptr(st)+516 を基点に操作(512byte:入れ子/配列)
; Address : WCHAR (+1028, 512byte)  varptr(st)+1028 を基点に操作(512byte:入れ子/配列)
; Socket : WORD (+1540, 2byte)  wpoke st,1540,値  /  値 = wpeek(st,1540)
; SecurityFlags : ULONGLONG (+1544, 8byte)  qpoke st,1544,値 / qpeek(st,1544)  ※IronHSPのみ。3.7/3.8は lpoke st,1544,下位 : lpoke st,1548,上位
; LoginOptions : ISCSI_LOGIN_OPTIONS (+1552, 64byte)  varptr(st)+1552 を基点に操作(64byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global ISCSI_LOGIN_OPTIONS
    #field int Version
    #field int InformationSpecified
    #field int LoginFlags
    #field int AuthType
    #field int HeaderDigest
    #field int DataDigest
    #field int MaximumConnections
    #field int DefaultTime2Wait
    #field int DefaultTime2Retain
    #field int UsernameLength
    #field int PasswordLength
    #field intptr Username
    #field intptr Password
#endstruct

#defstruct global ISCSI_TARGET_PORTAL_INFO_EXW
    #field wchar InitiatorName 256
    #field int InitiatorPortNumber
    #field wchar SymbolicName 256
    #field wchar Address 256
    #field short Socket
    #field int64 SecurityFlags
    #field ISCSI_LOGIN_OPTIONS LoginOptions
#endstruct

stdim st, ISCSI_TARGET_PORTAL_INFO_EXW        ; NSTRUCT 変数を確保
st->InitiatorPortNumber = 100
mes "InitiatorPortNumber=" + st->InitiatorPortNumber