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

SetIScsiTunnelModeOuterAddressW

関数
iSCSI IPsecトンネルモードの外側アドレスを設定する。
DLLISCSIDSC.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

DWORD SetIScsiTunnelModeOuterAddressW(
    LPWSTR InitiatorName,   // optional
    DWORD InitiatorPortNumber,
    LPWSTR DestinationAddress,   // optional
    LPWSTR OuterModeAddress,   // optional
    BOOLEAN Persist
);

パラメーター

名前型方向説明
InitiatorNameLPWSTRinoptional対象のイニシエーター名を指す。NULL可。
InitiatorPortNumberDWORDin対象のイニシエーターポート番号を指定する。
DestinationAddressLPWSTRinoptionalトンネルモードを適用する宛先IPアドレス文字列を指す。
OuterModeAddressLPWSTRinoptionalIPsecトンネルの外側モードIPアドレス文字列を指す。
PersistBOOLEANinTRUEで設定を再起動後も保持するか示すBOOLEAN値。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD SetIScsiTunnelModeOuterAddressW(
    LPWSTR InitiatorName,   // optional
    DWORD InitiatorPortNumber,
    LPWSTR DestinationAddress,   // optional
    LPWSTR OuterModeAddress,   // optional
    BOOLEAN Persist
);
[DllImport("ISCSIDSC.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint SetIScsiTunnelModeOuterAddressW(
    [MarshalAs(UnmanagedType.LPWStr)] string InitiatorName,   // LPWSTR optional
    uint InitiatorPortNumber,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string DestinationAddress,   // LPWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string OuterModeAddress,   // LPWSTR optional
    [MarshalAs(UnmanagedType.U1)] bool Persist   // BOOLEAN
);
<DllImport("ISCSIDSC.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SetIScsiTunnelModeOuterAddressW(
    <MarshalAs(UnmanagedType.LPWStr)> InitiatorName As String,   ' LPWSTR optional
    InitiatorPortNumber As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> DestinationAddress As String,   ' LPWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> OuterModeAddress As String,   ' LPWSTR optional
    <MarshalAs(UnmanagedType.U1)> Persist As Boolean   ' BOOLEAN
) As UInteger
End Function
' InitiatorName : LPWSTR optional
' InitiatorPortNumber : DWORD
' DestinationAddress : LPWSTR optional
' OuterModeAddress : LPWSTR optional
' Persist : BOOLEAN
Declare PtrSafe Function SetIScsiTunnelModeOuterAddressW Lib "iscsidsc" ( _
    ByVal InitiatorName As LongPtr, _
    ByVal InitiatorPortNumber As Long, _
    ByVal DestinationAddress As LongPtr, _
    ByVal OuterModeAddress As LongPtr, _
    ByVal Persist As Byte) 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

SetIScsiTunnelModeOuterAddressW = ctypes.windll.iscsidsc.SetIScsiTunnelModeOuterAddressW
SetIScsiTunnelModeOuterAddressW.restype = wintypes.DWORD
SetIScsiTunnelModeOuterAddressW.argtypes = [
    wintypes.LPCWSTR,  # InitiatorName : LPWSTR optional
    wintypes.DWORD,  # InitiatorPortNumber : DWORD
    wintypes.LPCWSTR,  # DestinationAddress : LPWSTR optional
    wintypes.LPCWSTR,  # OuterModeAddress : LPWSTR optional
    wintypes.BOOLEAN,  # Persist : BOOLEAN
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ISCSIDSC.dll')
SetIScsiTunnelModeOuterAddressW = Fiddle::Function.new(
  lib['SetIScsiTunnelModeOuterAddressW'],
  [
    Fiddle::TYPE_VOIDP,  # InitiatorName : LPWSTR optional
    -Fiddle::TYPE_INT,  # InitiatorPortNumber : DWORD
    Fiddle::TYPE_VOIDP,  # DestinationAddress : LPWSTR optional
    Fiddle::TYPE_VOIDP,  # OuterModeAddress : LPWSTR optional
    Fiddle::TYPE_CHAR,  # Persist : BOOLEAN
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "iscsidsc")]
extern "system" {
    fn SetIScsiTunnelModeOuterAddressW(
        InitiatorName: *mut u16,  // LPWSTR optional
        InitiatorPortNumber: u32,  // DWORD
        DestinationAddress: *mut u16,  // LPWSTR optional
        OuterModeAddress: *mut u16,  // LPWSTR optional
        Persist: u8  // BOOLEAN
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ISCSIDSC.dll", CharSet = CharSet.Unicode)]
public static extern uint SetIScsiTunnelModeOuterAddressW([MarshalAs(UnmanagedType.LPWStr)] string InitiatorName, uint InitiatorPortNumber, [MarshalAs(UnmanagedType.LPWStr)] string DestinationAddress, [MarshalAs(UnmanagedType.LPWStr)] string OuterModeAddress, [MarshalAs(UnmanagedType.U1)] bool Persist);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ISCSIDSC_SetIScsiTunnelModeOuterAddressW' -Namespace Win32 -PassThru
# $api::SetIScsiTunnelModeOuterAddressW(InitiatorName, InitiatorPortNumber, DestinationAddress, OuterModeAddress, Persist)
#uselib "ISCSIDSC.dll"
#func global SetIScsiTunnelModeOuterAddressW "SetIScsiTunnelModeOuterAddressW" wptr, wptr, wptr, wptr, wptr
; SetIScsiTunnelModeOuterAddressW InitiatorName, InitiatorPortNumber, DestinationAddress, OuterModeAddress, Persist   ; 戻り値は stat
; InitiatorName : LPWSTR optional -> "wptr"
; InitiatorPortNumber : DWORD -> "wptr"
; DestinationAddress : LPWSTR optional -> "wptr"
; OuterModeAddress : LPWSTR optional -> "wptr"
; Persist : BOOLEAN -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ISCSIDSC.dll"
#cfunc global SetIScsiTunnelModeOuterAddressW "SetIScsiTunnelModeOuterAddressW" wstr, int, wstr, wstr, int
; res = SetIScsiTunnelModeOuterAddressW(InitiatorName, InitiatorPortNumber, DestinationAddress, OuterModeAddress, Persist)
; InitiatorName : LPWSTR optional -> "wstr"
; InitiatorPortNumber : DWORD -> "int"
; DestinationAddress : LPWSTR optional -> "wstr"
; OuterModeAddress : LPWSTR optional -> "wstr"
; Persist : BOOLEAN -> "int"
; DWORD SetIScsiTunnelModeOuterAddressW(LPWSTR InitiatorName, DWORD InitiatorPortNumber, LPWSTR DestinationAddress, LPWSTR OuterModeAddress, BOOLEAN Persist)
#uselib "ISCSIDSC.dll"
#cfunc global SetIScsiTunnelModeOuterAddressW "SetIScsiTunnelModeOuterAddressW" wstr, int, wstr, wstr, int
; res = SetIScsiTunnelModeOuterAddressW(InitiatorName, InitiatorPortNumber, DestinationAddress, OuterModeAddress, Persist)
; InitiatorName : LPWSTR optional -> "wstr"
; InitiatorPortNumber : DWORD -> "int"
; DestinationAddress : LPWSTR optional -> "wstr"
; OuterModeAddress : LPWSTR optional -> "wstr"
; Persist : BOOLEAN -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iscsidsc = windows.NewLazySystemDLL("ISCSIDSC.dll")
	procSetIScsiTunnelModeOuterAddressW = iscsidsc.NewProc("SetIScsiTunnelModeOuterAddressW")
)

// InitiatorName (LPWSTR optional), InitiatorPortNumber (DWORD), DestinationAddress (LPWSTR optional), OuterModeAddress (LPWSTR optional), Persist (BOOLEAN)
r1, _, err := procSetIScsiTunnelModeOuterAddressW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(InitiatorName))),
	uintptr(InitiatorPortNumber),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(DestinationAddress))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(OuterModeAddress))),
	uintptr(Persist),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function SetIScsiTunnelModeOuterAddressW(
  InitiatorName: PWideChar;   // LPWSTR optional
  InitiatorPortNumber: DWORD;   // DWORD
  DestinationAddress: PWideChar;   // LPWSTR optional
  OuterModeAddress: PWideChar;   // LPWSTR optional
  Persist: ByteBool   // BOOLEAN
): DWORD; stdcall;
  external 'ISCSIDSC.dll' name 'SetIScsiTunnelModeOuterAddressW';
result := DllCall("ISCSIDSC\SetIScsiTunnelModeOuterAddressW"
    , "WStr", InitiatorName   ; LPWSTR optional
    , "UInt", InitiatorPortNumber   ; DWORD
    , "WStr", DestinationAddress   ; LPWSTR optional
    , "WStr", OuterModeAddress   ; LPWSTR optional
    , "Char", Persist   ; BOOLEAN
    , "UInt")   ; return: DWORD
●SetIScsiTunnelModeOuterAddressW(InitiatorName, InitiatorPortNumber, DestinationAddress, OuterModeAddress, Persist) = DLL("ISCSIDSC.dll", "dword SetIScsiTunnelModeOuterAddressW(char*, dword, char*, char*, byte)")
# 呼び出し: SetIScsiTunnelModeOuterAddressW(InitiatorName, InitiatorPortNumber, DestinationAddress, OuterModeAddress, Persist)
# InitiatorName : LPWSTR optional -> "char*"
# InitiatorPortNumber : DWORD -> "dword"
# DestinationAddress : LPWSTR optional -> "char*"
# OuterModeAddress : LPWSTR optional -> "char*"
# Persist : BOOLEAN -> "byte"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "iscsidsc" fn SetIScsiTunnelModeOuterAddressW(
    InitiatorName: [*c]const u16, // LPWSTR optional
    InitiatorPortNumber: u32, // DWORD
    DestinationAddress: [*c]const u16, // LPWSTR optional
    OuterModeAddress: [*c]const u16, // LPWSTR optional
    Persist: u8 // BOOLEAN
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetIScsiTunnelModeOuterAddressW(
    InitiatorName: WideCString,  # LPWSTR optional
    InitiatorPortNumber: uint32,  # DWORD
    DestinationAddress: WideCString,  # LPWSTR optional
    OuterModeAddress: WideCString,  # LPWSTR optional
    Persist: uint8  # BOOLEAN
): uint32 {.importc: "SetIScsiTunnelModeOuterAddressW", stdcall, dynlib: "ISCSIDSC.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "iscsidsc");
extern(Windows)
uint SetIScsiTunnelModeOuterAddressW(
    const(wchar)* InitiatorName,   // LPWSTR optional
    uint InitiatorPortNumber,   // DWORD
    const(wchar)* DestinationAddress,   // LPWSTR optional
    const(wchar)* OuterModeAddress,   // LPWSTR optional
    ubyte Persist   // BOOLEAN
);
ccall((:SetIScsiTunnelModeOuterAddressW, "ISCSIDSC.dll"), stdcall, UInt32,
      (Cwstring, UInt32, Cwstring, Cwstring, UInt8),
      InitiatorName, InitiatorPortNumber, DestinationAddress, OuterModeAddress, Persist)
# InitiatorName : LPWSTR optional -> Cwstring
# InitiatorPortNumber : DWORD -> UInt32
# DestinationAddress : LPWSTR optional -> Cwstring
# OuterModeAddress : LPWSTR optional -> Cwstring
# Persist : BOOLEAN -> UInt8
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t SetIScsiTunnelModeOuterAddressW(
    const uint16_t* InitiatorName,
    uint32_t InitiatorPortNumber,
    const uint16_t* DestinationAddress,
    const uint16_t* OuterModeAddress,
    uint8_t Persist);
]]
local iscsidsc = ffi.load("iscsidsc")
-- iscsidsc.SetIScsiTunnelModeOuterAddressW(InitiatorName, InitiatorPortNumber, DestinationAddress, OuterModeAddress, Persist)
-- InitiatorName : LPWSTR optional
-- InitiatorPortNumber : DWORD
-- DestinationAddress : LPWSTR optional
-- OuterModeAddress : LPWSTR optional
-- Persist : BOOLEAN
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('ISCSIDSC.dll');
const SetIScsiTunnelModeOuterAddressW = lib.func('__stdcall', 'SetIScsiTunnelModeOuterAddressW', 'uint32_t', ['str16', 'uint32_t', 'str16', 'str16', 'uint8_t']);
// SetIScsiTunnelModeOuterAddressW(InitiatorName, InitiatorPortNumber, DestinationAddress, OuterModeAddress, Persist)
// InitiatorName : LPWSTR optional -> 'str16'
// InitiatorPortNumber : DWORD -> 'uint32_t'
// DestinationAddress : LPWSTR optional -> 'str16'
// OuterModeAddress : LPWSTR optional -> 'str16'
// Persist : BOOLEAN -> 'uint8_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ISCSIDSC.dll", {
  SetIScsiTunnelModeOuterAddressW: { parameters: ["buffer", "u32", "buffer", "buffer", "u8"], result: "u32" },
});
// lib.symbols.SetIScsiTunnelModeOuterAddressW(InitiatorName, InitiatorPortNumber, DestinationAddress, OuterModeAddress, Persist)
// InitiatorName : LPWSTR optional -> "buffer"
// InitiatorPortNumber : DWORD -> "u32"
// DestinationAddress : LPWSTR optional -> "buffer"
// OuterModeAddress : LPWSTR optional -> "buffer"
// Persist : BOOLEAN -> "u8"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t SetIScsiTunnelModeOuterAddressW(
    const uint16_t* InitiatorName,
    uint32_t InitiatorPortNumber,
    const uint16_t* DestinationAddress,
    const uint16_t* OuterModeAddress,
    uint8_t Persist);
C, "ISCSIDSC.dll");
// $ffi->SetIScsiTunnelModeOuterAddressW(InitiatorName, InitiatorPortNumber, DestinationAddress, OuterModeAddress, Persist);
// InitiatorName : LPWSTR optional
// InitiatorPortNumber : DWORD
// DestinationAddress : LPWSTR optional
// OuterModeAddress : LPWSTR optional
// Persist : BOOLEAN
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Iscsidsc extends StdCallLibrary {
    Iscsidsc INSTANCE = Native.load("iscsidsc", Iscsidsc.class, W32APIOptions.UNICODE_OPTIONS);
    int SetIScsiTunnelModeOuterAddressW(
        WString InitiatorName,   // LPWSTR optional
        int InitiatorPortNumber,   // DWORD
        WString DestinationAddress,   // LPWSTR optional
        WString OuterModeAddress,   // LPWSTR optional
        byte Persist   // BOOLEAN
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("iscsidsc")]
lib LibISCSIDSC
  fun SetIScsiTunnelModeOuterAddressW = SetIScsiTunnelModeOuterAddressW(
    InitiatorName : UInt16*,   # LPWSTR optional
    InitiatorPortNumber : UInt32,   # DWORD
    DestinationAddress : UInt16*,   # LPWSTR optional
    OuterModeAddress : UInt16*,   # LPWSTR optional
    Persist : UInt8   # BOOLEAN
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetIScsiTunnelModeOuterAddressWNative = Uint32 Function(Pointer<Utf16>, Uint32, Pointer<Utf16>, Pointer<Utf16>, Uint8);
typedef SetIScsiTunnelModeOuterAddressWDart = int Function(Pointer<Utf16>, int, Pointer<Utf16>, Pointer<Utf16>, int);
final SetIScsiTunnelModeOuterAddressW = DynamicLibrary.open('ISCSIDSC.dll')
    .lookupFunction<SetIScsiTunnelModeOuterAddressWNative, SetIScsiTunnelModeOuterAddressWDart>('SetIScsiTunnelModeOuterAddressW');
// InitiatorName : LPWSTR optional -> Pointer<Utf16>
// InitiatorPortNumber : DWORD -> Uint32
// DestinationAddress : LPWSTR optional -> Pointer<Utf16>
// OuterModeAddress : LPWSTR optional -> Pointer<Utf16>
// Persist : BOOLEAN -> Uint8
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetIScsiTunnelModeOuterAddressW(
  InitiatorName: PWideChar;   // LPWSTR optional
  InitiatorPortNumber: DWORD;   // DWORD
  DestinationAddress: PWideChar;   // LPWSTR optional
  OuterModeAddress: PWideChar;   // LPWSTR optional
  Persist: ByteBool   // BOOLEAN
): DWORD; stdcall;
  external 'ISCSIDSC.dll' name 'SetIScsiTunnelModeOuterAddressW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetIScsiTunnelModeOuterAddressW"
  c_SetIScsiTunnelModeOuterAddressW :: CWString -> Word32 -> CWString -> CWString -> Word8 -> IO Word32
-- InitiatorName : LPWSTR optional -> CWString
-- InitiatorPortNumber : DWORD -> Word32
-- DestinationAddress : LPWSTR optional -> CWString
-- OuterModeAddress : LPWSTR optional -> CWString
-- Persist : BOOLEAN -> Word8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setiscsitunnelmodeouteraddressw =
  foreign "SetIScsiTunnelModeOuterAddressW"
    ((ptr uint16_t) @-> uint32_t @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint8_t @-> returning uint32_t)
(* InitiatorName : LPWSTR optional -> (ptr uint16_t) *)
(* InitiatorPortNumber : DWORD -> uint32_t *)
(* DestinationAddress : LPWSTR optional -> (ptr uint16_t) *)
(* OuterModeAddress : LPWSTR optional -> (ptr uint16_t) *)
(* Persist : BOOLEAN -> uint8_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iscsidsc (t "ISCSIDSC.dll"))
(cffi:use-foreign-library iscsidsc)

(cffi:defcfun ("SetIScsiTunnelModeOuterAddressW" set-iscsi-tunnel-mode-outer-address-w :convention :stdcall) :uint32
  (initiator-name (:string :encoding :utf-16le))   ; LPWSTR optional
  (initiator-port-number :uint32)   ; DWORD
  (destination-address (:string :encoding :utf-16le))   ; LPWSTR optional
  (outer-mode-address (:string :encoding :utf-16le))   ; LPWSTR optional
  (persist :uint8))   ; BOOLEAN
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetIScsiTunnelModeOuterAddressW = Win32::API::More->new('ISCSIDSC',
    'DWORD SetIScsiTunnelModeOuterAddressW(LPCWSTR InitiatorName, DWORD InitiatorPortNumber, LPCWSTR DestinationAddress, LPCWSTR OuterModeAddress, BYTE Persist)');
# my $ret = $SetIScsiTunnelModeOuterAddressW->Call($InitiatorName, $InitiatorPortNumber, $DestinationAddress, $OuterModeAddress, $Persist);
# InitiatorName : LPWSTR optional -> LPCWSTR
# InitiatorPortNumber : DWORD -> DWORD
# DestinationAddress : LPWSTR optional -> LPCWSTR
# OuterModeAddress : LPWSTR optional -> LPCWSTR
# Persist : BOOLEAN -> BYTE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い