ホーム › Storage.IscsiDisc › GetIScsiInitiatorNodeNameA

GetIScsiInitiatorNodeNameA

関数

iSCSIイニシエーターのノード名を取得する（ANSI版）。

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

シグネチャ

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

DWORD GetIScsiInitiatorNodeNameA(
    LPSTR InitiatorNodeName
);

パラメーター

名前	型	方向	説明
InitiatorNodeName	LPSTR	out	呼び出し元が割り当てたバッファー。出力時にノード名を受け取ります。このバッファーは MAX_ISCSI_NAME_LEN+1 バイトを格納できる大きさである必要があります。

戻り値の型: DWORD

公式ドキュメント

GetIscsiInitiatorNodeName 関数は、ローカルコンピューターからセッションを確立するときに使用される共通のイニシエーターノード名を取得します。(ANSI)

戻り値

操作が成功した場合は ERROR_SUCCESS を返し、失敗した場合は該当する Win32 または iSCSI のエラーコードを返します。

解説(Remarks)

ソフトウェアとハードウェアのどちらであっても、すべてのイニシエーターホストバスアダプターは、セッションを確立するときに同じノード名を使用します。

メモ

iscsidsc.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版と Unicode 版を自動的に選択するエイリアスとして GetIScsiInitiatorNodeName を定義しています。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードとを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因になる可能性があります。詳細については、「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 GetIScsiInitiatorNodeNameA(
    LPSTR InitiatorNodeName
);

[DllImport("ISCSIDSC.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint GetIScsiInitiatorNodeNameA(
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder InitiatorNodeName   // LPSTR out
);

<DllImport("ISCSIDSC.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetIScsiInitiatorNodeNameA(
    <MarshalAs(UnmanagedType.LPStr)> InitiatorNodeName As System.Text.StringBuilder   ' LPSTR out
) As UInteger
End Function

' InitiatorNodeName : LPSTR out
Declare PtrSafe Function GetIScsiInitiatorNodeNameA Lib "iscsidsc" ( _
    ByVal InitiatorNodeName As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetIScsiInitiatorNodeNameA = ctypes.windll.iscsidsc.GetIScsiInitiatorNodeNameA
GetIScsiInitiatorNodeNameA.restype = wintypes.DWORD
GetIScsiInitiatorNodeNameA.argtypes = [
    wintypes.LPSTR,  # InitiatorNodeName : LPSTR out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ISCSIDSC.dll')
GetIScsiInitiatorNodeNameA = Fiddle::Function.new(
  lib['GetIScsiInitiatorNodeNameA'],
  [
    Fiddle::TYPE_VOIDP,  # InitiatorNodeName : LPSTR out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iscsidsc")]
extern "system" {
    fn GetIScsiInitiatorNodeNameA(
        InitiatorNodeName: *mut u8  // LPSTR out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ISCSIDSC.dll", CharSet = CharSet.Ansi)]
public static extern uint GetIScsiInitiatorNodeNameA([MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder InitiatorNodeName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ISCSIDSC_GetIScsiInitiatorNodeNameA' -Namespace Win32 -PassThru
# $api::GetIScsiInitiatorNodeNameA(InitiatorNodeName)

#uselib "ISCSIDSC.dll"
#func global GetIScsiInitiatorNodeNameA "GetIScsiInitiatorNodeNameA" sptr
; GetIScsiInitiatorNodeNameA varptr(InitiatorNodeName)   ; 戻り値は stat
; InitiatorNodeName : LPSTR out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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