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

LoginIScsiTargetW

関数
指定したiSCSIターゲットにログオンしセッションを確立する。
DLLISCSIDSC.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD LoginIScsiTargetW(
    LPWSTR TargetName,
    BOOLEAN IsInformationalSession,
    LPWSTR InitiatorInstance,   // optional
    DWORD InitiatorPortNumber,
    ISCSI_TARGET_PORTALW* TargetPortal,
    ULONGLONG SecurityFlags,
    ISCSI_TARGET_MAPPINGW* Mappings,
    ISCSI_LOGIN_OPTIONS* LoginOptions,
    DWORD KeySize,
    LPSTR Key,   // optional
    BOOLEAN IsPersistent,
    ISCSI_UNIQUE_SESSION_ID* UniqueSessionId,
    ISCSI_UNIQUE_SESSION_ID* UniqueConnectionId
);

パラメーター

名前方向
TargetNameLPWSTRin
IsInformationalSessionBOOLEANin
InitiatorInstanceLPWSTRinoptional
InitiatorPortNumberDWORDin
TargetPortalISCSI_TARGET_PORTALW*inout
SecurityFlagsULONGLONGin
MappingsISCSI_TARGET_MAPPINGW*inout
LoginOptionsISCSI_LOGIN_OPTIONS*inout
KeySizeDWORDin
KeyLPSTRinoptional
IsPersistentBOOLEANin
UniqueSessionIdISCSI_UNIQUE_SESSION_ID*inout
UniqueConnectionIdISCSI_UNIQUE_SESSION_ID*inout

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD LoginIScsiTargetW(
    LPWSTR TargetName,
    BOOLEAN IsInformationalSession,
    LPWSTR InitiatorInstance,   // optional
    DWORD InitiatorPortNumber,
    ISCSI_TARGET_PORTALW* TargetPortal,
    ULONGLONG SecurityFlags,
    ISCSI_TARGET_MAPPINGW* Mappings,
    ISCSI_LOGIN_OPTIONS* LoginOptions,
    DWORD KeySize,
    LPSTR Key,   // optional
    BOOLEAN IsPersistent,
    ISCSI_UNIQUE_SESSION_ID* UniqueSessionId,
    ISCSI_UNIQUE_SESSION_ID* UniqueConnectionId
);
[DllImport("ISCSIDSC.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint LoginIScsiTargetW(
    [MarshalAs(UnmanagedType.LPWStr)] string TargetName,   // LPWSTR
    [MarshalAs(UnmanagedType.U1)] bool IsInformationalSession,   // BOOLEAN
    [MarshalAs(UnmanagedType.LPWStr)] string InitiatorInstance,   // LPWSTR optional
    uint InitiatorPortNumber,   // DWORD
    IntPtr TargetPortal,   // ISCSI_TARGET_PORTALW* in/out
    ulong SecurityFlags,   // ULONGLONG
    IntPtr Mappings,   // ISCSI_TARGET_MAPPINGW* in/out
    IntPtr LoginOptions,   // ISCSI_LOGIN_OPTIONS* in/out
    uint KeySize,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string Key,   // LPSTR optional
    [MarshalAs(UnmanagedType.U1)] bool IsPersistent,   // BOOLEAN
    IntPtr UniqueSessionId,   // ISCSI_UNIQUE_SESSION_ID* in/out
    IntPtr UniqueConnectionId   // ISCSI_UNIQUE_SESSION_ID* in/out
);
<DllImport("ISCSIDSC.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function LoginIScsiTargetW(
    <MarshalAs(UnmanagedType.LPWStr)> TargetName As String,   ' LPWSTR
    <MarshalAs(UnmanagedType.U1)> IsInformationalSession As Boolean,   ' BOOLEAN
    <MarshalAs(UnmanagedType.LPWStr)> InitiatorInstance As String,   ' LPWSTR optional
    InitiatorPortNumber As UInteger,   ' DWORD
    TargetPortal As IntPtr,   ' ISCSI_TARGET_PORTALW* in/out
    SecurityFlags As ULong,   ' ULONGLONG
    Mappings As IntPtr,   ' ISCSI_TARGET_MAPPINGW* in/out
    LoginOptions As IntPtr,   ' ISCSI_LOGIN_OPTIONS* in/out
    KeySize As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> Key As String,   ' LPSTR optional
    <MarshalAs(UnmanagedType.U1)> IsPersistent As Boolean,   ' BOOLEAN
    UniqueSessionId As IntPtr,   ' ISCSI_UNIQUE_SESSION_ID* in/out
    UniqueConnectionId As IntPtr   ' ISCSI_UNIQUE_SESSION_ID* in/out
) As UInteger
End Function
' TargetName : LPWSTR
' IsInformationalSession : BOOLEAN
' InitiatorInstance : LPWSTR optional
' InitiatorPortNumber : DWORD
' TargetPortal : ISCSI_TARGET_PORTALW* in/out
' SecurityFlags : ULONGLONG
' Mappings : ISCSI_TARGET_MAPPINGW* in/out
' LoginOptions : ISCSI_LOGIN_OPTIONS* in/out
' KeySize : DWORD
' Key : LPSTR optional
' IsPersistent : BOOLEAN
' UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out
' UniqueConnectionId : ISCSI_UNIQUE_SESSION_ID* in/out
Declare PtrSafe Function LoginIScsiTargetW Lib "iscsidsc" ( _
    ByVal TargetName As LongPtr, _
    ByVal IsInformationalSession As Byte, _
    ByVal InitiatorInstance As LongPtr, _
    ByVal InitiatorPortNumber As Long, _
    ByVal TargetPortal As LongPtr, _
    ByVal SecurityFlags As LongLong, _
    ByVal Mappings As LongPtr, _
    ByVal LoginOptions As LongPtr, _
    ByVal KeySize As Long, _
    ByVal Key As String, _
    ByVal IsPersistent As Byte, _
    ByVal UniqueSessionId As LongPtr, _
    ByVal UniqueConnectionId 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

LoginIScsiTargetW = ctypes.windll.iscsidsc.LoginIScsiTargetW
LoginIScsiTargetW.restype = wintypes.DWORD
LoginIScsiTargetW.argtypes = [
    wintypes.LPCWSTR,  # TargetName : LPWSTR
    ctypes.c_byte,  # IsInformationalSession : BOOLEAN
    wintypes.LPCWSTR,  # InitiatorInstance : LPWSTR optional
    wintypes.DWORD,  # InitiatorPortNumber : DWORD
    ctypes.c_void_p,  # TargetPortal : ISCSI_TARGET_PORTALW* in/out
    ctypes.c_ulonglong,  # SecurityFlags : ULONGLONG
    ctypes.c_void_p,  # Mappings : ISCSI_TARGET_MAPPINGW* in/out
    ctypes.c_void_p,  # LoginOptions : ISCSI_LOGIN_OPTIONS* in/out
    wintypes.DWORD,  # KeySize : DWORD
    wintypes.LPCSTR,  # Key : LPSTR optional
    ctypes.c_byte,  # IsPersistent : BOOLEAN
    ctypes.c_void_p,  # UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out
    ctypes.c_void_p,  # UniqueConnectionId : ISCSI_UNIQUE_SESSION_ID* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ISCSIDSC.dll')
LoginIScsiTargetW = Fiddle::Function.new(
  lib['LoginIScsiTargetW'],
  [
    Fiddle::TYPE_VOIDP,  # TargetName : LPWSTR
    Fiddle::TYPE_CHAR,  # IsInformationalSession : BOOLEAN
    Fiddle::TYPE_VOIDP,  # InitiatorInstance : LPWSTR optional
    -Fiddle::TYPE_INT,  # InitiatorPortNumber : DWORD
    Fiddle::TYPE_VOIDP,  # TargetPortal : ISCSI_TARGET_PORTALW* in/out
    -Fiddle::TYPE_LONG_LONG,  # SecurityFlags : ULONGLONG
    Fiddle::TYPE_VOIDP,  # Mappings : ISCSI_TARGET_MAPPINGW* in/out
    Fiddle::TYPE_VOIDP,  # LoginOptions : ISCSI_LOGIN_OPTIONS* in/out
    -Fiddle::TYPE_INT,  # KeySize : DWORD
    Fiddle::TYPE_VOIDP,  # Key : LPSTR optional
    Fiddle::TYPE_CHAR,  # IsPersistent : BOOLEAN
    Fiddle::TYPE_VOIDP,  # UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out
    Fiddle::TYPE_VOIDP,  # UniqueConnectionId : ISCSI_UNIQUE_SESSION_ID* in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "iscsidsc")]
extern "system" {
    fn LoginIScsiTargetW(
        TargetName: *mut u16,  // LPWSTR
        IsInformationalSession: u8,  // BOOLEAN
        InitiatorInstance: *mut u16,  // LPWSTR optional
        InitiatorPortNumber: u32,  // DWORD
        TargetPortal: *mut ISCSI_TARGET_PORTALW,  // ISCSI_TARGET_PORTALW* in/out
        SecurityFlags: u64,  // ULONGLONG
        Mappings: *mut ISCSI_TARGET_MAPPINGW,  // ISCSI_TARGET_MAPPINGW* in/out
        LoginOptions: *mut ISCSI_LOGIN_OPTIONS,  // ISCSI_LOGIN_OPTIONS* in/out
        KeySize: u32,  // DWORD
        Key: *mut u8,  // LPSTR optional
        IsPersistent: u8,  // BOOLEAN
        UniqueSessionId: *mut ISCSI_UNIQUE_SESSION_ID,  // ISCSI_UNIQUE_SESSION_ID* in/out
        UniqueConnectionId: *mut ISCSI_UNIQUE_SESSION_ID  // ISCSI_UNIQUE_SESSION_ID* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ISCSIDSC.dll", CharSet = CharSet.Unicode)]
public static extern uint LoginIScsiTargetW([MarshalAs(UnmanagedType.LPWStr)] string TargetName, [MarshalAs(UnmanagedType.U1)] bool IsInformationalSession, [MarshalAs(UnmanagedType.LPWStr)] string InitiatorInstance, uint InitiatorPortNumber, IntPtr TargetPortal, ulong SecurityFlags, IntPtr Mappings, IntPtr LoginOptions, uint KeySize, [MarshalAs(UnmanagedType.LPStr)] string Key, [MarshalAs(UnmanagedType.U1)] bool IsPersistent, IntPtr UniqueSessionId, IntPtr UniqueConnectionId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ISCSIDSC_LoginIScsiTargetW' -Namespace Win32 -PassThru
# $api::LoginIScsiTargetW(TargetName, IsInformationalSession, InitiatorInstance, InitiatorPortNumber, TargetPortal, SecurityFlags, Mappings, LoginOptions, KeySize, Key, IsPersistent, UniqueSessionId, UniqueConnectionId)
#uselib "ISCSIDSC.dll"
#func global LoginIScsiTargetW "LoginIScsiTargetW" wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr
; LoginIScsiTargetW TargetName, IsInformationalSession, InitiatorInstance, InitiatorPortNumber, varptr(TargetPortal), SecurityFlags, varptr(Mappings), varptr(LoginOptions), KeySize, Key, IsPersistent, varptr(UniqueSessionId), varptr(UniqueConnectionId)   ; 戻り値は stat
; TargetName : LPWSTR -> "wptr"
; IsInformationalSession : BOOLEAN -> "wptr"
; InitiatorInstance : LPWSTR optional -> "wptr"
; InitiatorPortNumber : DWORD -> "wptr"
; TargetPortal : ISCSI_TARGET_PORTALW* in/out -> "wptr"
; SecurityFlags : ULONGLONG -> "wptr"
; Mappings : ISCSI_TARGET_MAPPINGW* in/out -> "wptr"
; LoginOptions : ISCSI_LOGIN_OPTIONS* in/out -> "wptr"
; KeySize : DWORD -> "wptr"
; Key : LPSTR optional -> "wptr"
; IsPersistent : BOOLEAN -> "wptr"
; UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out -> "wptr"
; UniqueConnectionId : ISCSI_UNIQUE_SESSION_ID* in/out -> "wptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ISCSIDSC.dll"
#cfunc global LoginIScsiTargetW "LoginIScsiTargetW" wstr, int, wstr, int, var, int64, var, var, int, str, int, var, var
; res = LoginIScsiTargetW(TargetName, IsInformationalSession, InitiatorInstance, InitiatorPortNumber, TargetPortal, SecurityFlags, Mappings, LoginOptions, KeySize, Key, IsPersistent, UniqueSessionId, UniqueConnectionId)
; TargetName : LPWSTR -> "wstr"
; IsInformationalSession : BOOLEAN -> "int"
; InitiatorInstance : LPWSTR optional -> "wstr"
; InitiatorPortNumber : DWORD -> "int"
; TargetPortal : ISCSI_TARGET_PORTALW* in/out -> "var"
; SecurityFlags : ULONGLONG -> "int64"
; Mappings : ISCSI_TARGET_MAPPINGW* in/out -> "var"
; LoginOptions : ISCSI_LOGIN_OPTIONS* in/out -> "var"
; KeySize : DWORD -> "int"
; Key : LPSTR optional -> "str"
; IsPersistent : BOOLEAN -> "int"
; UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out -> "var"
; UniqueConnectionId : ISCSI_UNIQUE_SESSION_ID* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
出力引数:
; DWORD LoginIScsiTargetW(LPWSTR TargetName, BOOLEAN IsInformationalSession, LPWSTR InitiatorInstance, DWORD InitiatorPortNumber, ISCSI_TARGET_PORTALW* TargetPortal, ULONGLONG SecurityFlags, ISCSI_TARGET_MAPPINGW* Mappings, ISCSI_LOGIN_OPTIONS* LoginOptions, DWORD KeySize, LPSTR Key, BOOLEAN IsPersistent, ISCSI_UNIQUE_SESSION_ID* UniqueSessionId, ISCSI_UNIQUE_SESSION_ID* UniqueConnectionId)
#uselib "ISCSIDSC.dll"
#cfunc global LoginIScsiTargetW "LoginIScsiTargetW" wstr, int, wstr, int, var, int64, var, var, int, str, int, var, var
; res = LoginIScsiTargetW(TargetName, IsInformationalSession, InitiatorInstance, InitiatorPortNumber, TargetPortal, SecurityFlags, Mappings, LoginOptions, KeySize, Key, IsPersistent, UniqueSessionId, UniqueConnectionId)
; TargetName : LPWSTR -> "wstr"
; IsInformationalSession : BOOLEAN -> "int"
; InitiatorInstance : LPWSTR optional -> "wstr"
; InitiatorPortNumber : DWORD -> "int"
; TargetPortal : ISCSI_TARGET_PORTALW* in/out -> "var"
; SecurityFlags : ULONGLONG -> "int64"
; Mappings : ISCSI_TARGET_MAPPINGW* in/out -> "var"
; LoginOptions : ISCSI_LOGIN_OPTIONS* in/out -> "var"
; KeySize : DWORD -> "int"
; Key : LPSTR optional -> "str"
; IsPersistent : BOOLEAN -> "int"
; UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out -> "var"
; UniqueConnectionId : ISCSI_UNIQUE_SESSION_ID* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iscsidsc = windows.NewLazySystemDLL("ISCSIDSC.dll")
	procLoginIScsiTargetW = iscsidsc.NewProc("LoginIScsiTargetW")
)

// TargetName (LPWSTR), IsInformationalSession (BOOLEAN), InitiatorInstance (LPWSTR optional), InitiatorPortNumber (DWORD), TargetPortal (ISCSI_TARGET_PORTALW* in/out), SecurityFlags (ULONGLONG), Mappings (ISCSI_TARGET_MAPPINGW* in/out), LoginOptions (ISCSI_LOGIN_OPTIONS* in/out), KeySize (DWORD), Key (LPSTR optional), IsPersistent (BOOLEAN), UniqueSessionId (ISCSI_UNIQUE_SESSION_ID* in/out), UniqueConnectionId (ISCSI_UNIQUE_SESSION_ID* in/out)
r1, _, err := procLoginIScsiTargetW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(TargetName))),
	uintptr(IsInformationalSession),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(InitiatorInstance))),
	uintptr(InitiatorPortNumber),
	uintptr(TargetPortal),
	uintptr(SecurityFlags),
	uintptr(Mappings),
	uintptr(LoginOptions),
	uintptr(KeySize),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(Key))),
	uintptr(IsPersistent),
	uintptr(UniqueSessionId),
	uintptr(UniqueConnectionId),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function LoginIScsiTargetW(
  TargetName: PWideChar;   // LPWSTR
  IsInformationalSession: ByteBool;   // BOOLEAN
  InitiatorInstance: PWideChar;   // LPWSTR optional
  InitiatorPortNumber: DWORD;   // DWORD
  TargetPortal: Pointer;   // ISCSI_TARGET_PORTALW* in/out
  SecurityFlags: UInt64;   // ULONGLONG
  Mappings: Pointer;   // ISCSI_TARGET_MAPPINGW* in/out
  LoginOptions: Pointer;   // ISCSI_LOGIN_OPTIONS* in/out
  KeySize: DWORD;   // DWORD
  Key: PAnsiChar;   // LPSTR optional
  IsPersistent: ByteBool;   // BOOLEAN
  UniqueSessionId: Pointer;   // ISCSI_UNIQUE_SESSION_ID* in/out
  UniqueConnectionId: Pointer   // ISCSI_UNIQUE_SESSION_ID* in/out
): DWORD; stdcall;
  external 'ISCSIDSC.dll' name 'LoginIScsiTargetW';
result := DllCall("ISCSIDSC\LoginIScsiTargetW"
    , "WStr", TargetName   ; LPWSTR
    , "Char", IsInformationalSession   ; BOOLEAN
    , "WStr", InitiatorInstance   ; LPWSTR optional
    , "UInt", InitiatorPortNumber   ; DWORD
    , "Ptr", TargetPortal   ; ISCSI_TARGET_PORTALW* in/out
    , "Int64", SecurityFlags   ; ULONGLONG
    , "Ptr", Mappings   ; ISCSI_TARGET_MAPPINGW* in/out
    , "Ptr", LoginOptions   ; ISCSI_LOGIN_OPTIONS* in/out
    , "UInt", KeySize   ; DWORD
    , "AStr", Key   ; LPSTR optional
    , "Char", IsPersistent   ; BOOLEAN
    , "Ptr", UniqueSessionId   ; ISCSI_UNIQUE_SESSION_ID* in/out
    , "Ptr", UniqueConnectionId   ; ISCSI_UNIQUE_SESSION_ID* in/out
    , "UInt")   ; return: DWORD
●LoginIScsiTargetW(TargetName, IsInformationalSession, InitiatorInstance, InitiatorPortNumber, TargetPortal, SecurityFlags, Mappings, LoginOptions, KeySize, Key, IsPersistent, UniqueSessionId, UniqueConnectionId) = DLL("ISCSIDSC.dll", "dword LoginIScsiTargetW(char*, byte, char*, dword, void*, qword, void*, void*, dword, char*, byte, void*, void*)")
# 呼び出し: LoginIScsiTargetW(TargetName, IsInformationalSession, InitiatorInstance, InitiatorPortNumber, TargetPortal, SecurityFlags, Mappings, LoginOptions, KeySize, Key, IsPersistent, UniqueSessionId, UniqueConnectionId)
# TargetName : LPWSTR -> "char*"
# IsInformationalSession : BOOLEAN -> "byte"
# InitiatorInstance : LPWSTR optional -> "char*"
# InitiatorPortNumber : DWORD -> "dword"
# TargetPortal : ISCSI_TARGET_PORTALW* in/out -> "void*"
# SecurityFlags : ULONGLONG -> "qword"
# Mappings : ISCSI_TARGET_MAPPINGW* in/out -> "void*"
# LoginOptions : ISCSI_LOGIN_OPTIONS* in/out -> "void*"
# KeySize : DWORD -> "dword"
# Key : LPSTR optional -> "char*"
# IsPersistent : BOOLEAN -> "byte"
# UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out -> "void*"
# UniqueConnectionId : ISCSI_UNIQUE_SESSION_ID* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。