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

GetDevicesForIScsiSessionW

関数
指定iSCSIセッションに紐づくデバイスの一覧を取得する。
DLLISCSIDSC.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD GetDevicesForIScsiSessionW(
    ISCSI_UNIQUE_SESSION_ID* UniqueSessionId,
    DWORD* DeviceCount,
    ISCSI_DEVICE_ON_SESSIONW* Devices
);

パラメーター

名前方向説明
UniqueSessionIdISCSI_UNIQUE_SESSION_ID*inout対象セッションを一意に識別するISCSI_UNIQUE_SESSION_ID構造体へのポインタ。
DeviceCountDWORD*inout入出力でDevices配列の要素数を指すポインタ。デバイス数が返る。
DevicesISCSI_DEVICE_ON_SESSIONW*inoutセッション上のデバイス情報配列を受け取るISCSI_DEVICE_ON_SESSIONW構造体へのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD GetDevicesForIScsiSessionW(
    ISCSI_UNIQUE_SESSION_ID* UniqueSessionId,
    DWORD* DeviceCount,
    ISCSI_DEVICE_ON_SESSIONW* Devices
);
[DllImport("ISCSIDSC.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint GetDevicesForIScsiSessionW(
    IntPtr UniqueSessionId,   // ISCSI_UNIQUE_SESSION_ID* in/out
    ref uint DeviceCount,   // DWORD* in/out
    IntPtr Devices   // ISCSI_DEVICE_ON_SESSIONW* in/out
);
<DllImport("ISCSIDSC.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetDevicesForIScsiSessionW(
    UniqueSessionId As IntPtr,   ' ISCSI_UNIQUE_SESSION_ID* in/out
    ByRef DeviceCount As UInteger,   ' DWORD* in/out
    Devices As IntPtr   ' ISCSI_DEVICE_ON_SESSIONW* in/out
) As UInteger
End Function
' UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out
' DeviceCount : DWORD* in/out
' Devices : ISCSI_DEVICE_ON_SESSIONW* in/out
Declare PtrSafe Function GetDevicesForIScsiSessionW Lib "iscsidsc" ( _
    ByVal UniqueSessionId As LongPtr, _
    ByRef DeviceCount As Long, _
    ByVal Devices 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

GetDevicesForIScsiSessionW = ctypes.windll.iscsidsc.GetDevicesForIScsiSessionW
GetDevicesForIScsiSessionW.restype = wintypes.DWORD
GetDevicesForIScsiSessionW.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_SESSIONW* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ISCSIDSC.dll')
GetDevicesForIScsiSessionW = Fiddle::Function.new(
  lib['GetDevicesForIScsiSessionW'],
  [
    Fiddle::TYPE_VOIDP,  # UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out
    Fiddle::TYPE_VOIDP,  # DeviceCount : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # Devices : ISCSI_DEVICE_ON_SESSIONW* in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "iscsidsc")]
extern "system" {
    fn GetDevicesForIScsiSessionW(
        UniqueSessionId: *mut ISCSI_UNIQUE_SESSION_ID,  // ISCSI_UNIQUE_SESSION_ID* in/out
        DeviceCount: *mut u32,  // DWORD* in/out
        Devices: *mut ISCSI_DEVICE_ON_SESSIONW  // ISCSI_DEVICE_ON_SESSIONW* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ISCSIDSC.dll", CharSet = CharSet.Unicode)]
public static extern uint GetDevicesForIScsiSessionW(IntPtr UniqueSessionId, ref uint DeviceCount, IntPtr Devices);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ISCSIDSC_GetDevicesForIScsiSessionW' -Namespace Win32 -PassThru
# $api::GetDevicesForIScsiSessionW(UniqueSessionId, DeviceCount, Devices)
#uselib "ISCSIDSC.dll"
#func global GetDevicesForIScsiSessionW "GetDevicesForIScsiSessionW" wptr, wptr, wptr
; GetDevicesForIScsiSessionW varptr(UniqueSessionId), varptr(DeviceCount), varptr(Devices)   ; 戻り値は stat
; UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out -> "wptr"
; DeviceCount : DWORD* in/out -> "wptr"
; Devices : ISCSI_DEVICE_ON_SESSIONW* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ISCSIDSC.dll"
#cfunc global GetDevicesForIScsiSessionW "GetDevicesForIScsiSessionW" var, var, var
; res = GetDevicesForIScsiSessionW(UniqueSessionId, DeviceCount, Devices)
; UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out -> "var"
; DeviceCount : DWORD* in/out -> "var"
; Devices : ISCSI_DEVICE_ON_SESSIONW* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD GetDevicesForIScsiSessionW(ISCSI_UNIQUE_SESSION_ID* UniqueSessionId, DWORD* DeviceCount, ISCSI_DEVICE_ON_SESSIONW* Devices)
#uselib "ISCSIDSC.dll"
#cfunc global GetDevicesForIScsiSessionW "GetDevicesForIScsiSessionW" var, var, var
; res = GetDevicesForIScsiSessionW(UniqueSessionId, DeviceCount, Devices)
; UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out -> "var"
; DeviceCount : DWORD* in/out -> "var"
; Devices : ISCSI_DEVICE_ON_SESSIONW* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iscsidsc = windows.NewLazySystemDLL("ISCSIDSC.dll")
	procGetDevicesForIScsiSessionW = iscsidsc.NewProc("GetDevicesForIScsiSessionW")
)

// UniqueSessionId (ISCSI_UNIQUE_SESSION_ID* in/out), DeviceCount (DWORD* in/out), Devices (ISCSI_DEVICE_ON_SESSIONW* in/out)
r1, _, err := procGetDevicesForIScsiSessionW.Call(
	uintptr(UniqueSessionId),
	uintptr(DeviceCount),
	uintptr(Devices),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetDevicesForIScsiSessionW(
  UniqueSessionId: Pointer;   // ISCSI_UNIQUE_SESSION_ID* in/out
  DeviceCount: Pointer;   // DWORD* in/out
  Devices: Pointer   // ISCSI_DEVICE_ON_SESSIONW* in/out
): DWORD; stdcall;
  external 'ISCSIDSC.dll' name 'GetDevicesForIScsiSessionW';
result := DllCall("ISCSIDSC\GetDevicesForIScsiSessionW"
    , "Ptr", UniqueSessionId   ; ISCSI_UNIQUE_SESSION_ID* in/out
    , "Ptr", DeviceCount   ; DWORD* in/out
    , "Ptr", Devices   ; ISCSI_DEVICE_ON_SESSIONW* in/out
    , "UInt")   ; return: DWORD
●GetDevicesForIScsiSessionW(UniqueSessionId, DeviceCount, Devices) = DLL("ISCSIDSC.dll", "dword GetDevicesForIScsiSessionW(void*, void*, void*)")
# 呼び出し: GetDevicesForIScsiSessionW(UniqueSessionId, DeviceCount, Devices)
# UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out -> "void*"
# DeviceCount : DWORD* in/out -> "void*"
# Devices : ISCSI_DEVICE_ON_SESSIONW* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "iscsidsc" fn GetDevicesForIScsiSessionW(
    UniqueSessionId: [*c]ISCSI_UNIQUE_SESSION_ID, // ISCSI_UNIQUE_SESSION_ID* in/out
    DeviceCount: [*c]u32, // DWORD* in/out
    Devices: [*c]ISCSI_DEVICE_ON_SESSIONW // ISCSI_DEVICE_ON_SESSIONW* in/out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetDevicesForIScsiSessionW(
    UniqueSessionId: ptr ISCSI_UNIQUE_SESSION_ID,  # ISCSI_UNIQUE_SESSION_ID* in/out
    DeviceCount: ptr uint32,  # DWORD* in/out
    Devices: ptr ISCSI_DEVICE_ON_SESSIONW  # ISCSI_DEVICE_ON_SESSIONW* in/out
): uint32 {.importc: "GetDevicesForIScsiSessionW", stdcall, dynlib: "ISCSIDSC.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "iscsidsc");
extern(Windows)
uint GetDevicesForIScsiSessionW(
    ISCSI_UNIQUE_SESSION_ID* UniqueSessionId,   // ISCSI_UNIQUE_SESSION_ID* in/out
    uint* DeviceCount,   // DWORD* in/out
    ISCSI_DEVICE_ON_SESSIONW* Devices   // ISCSI_DEVICE_ON_SESSIONW* in/out
);
ccall((:GetDevicesForIScsiSessionW, "ISCSIDSC.dll"), stdcall, UInt32,
      (Ptr{ISCSI_UNIQUE_SESSION_ID}, Ptr{UInt32}, Ptr{ISCSI_DEVICE_ON_SESSIONW}),
      UniqueSessionId, DeviceCount, Devices)
# UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out -> Ptr{ISCSI_UNIQUE_SESSION_ID}
# DeviceCount : DWORD* in/out -> Ptr{UInt32}
# Devices : ISCSI_DEVICE_ON_SESSIONW* in/out -> Ptr{ISCSI_DEVICE_ON_SESSIONW}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetDevicesForIScsiSessionW(
    void* UniqueSessionId,
    uint32_t* DeviceCount,
    void* Devices);
]]
local iscsidsc = ffi.load("iscsidsc")
-- iscsidsc.GetDevicesForIScsiSessionW(UniqueSessionId, DeviceCount, Devices)
-- UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out
-- DeviceCount : DWORD* in/out
-- Devices : ISCSI_DEVICE_ON_SESSIONW* in/out
-- 構造体/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 GetDevicesForIScsiSessionW = lib.func('__stdcall', 'GetDevicesForIScsiSessionW', 'uint32_t', ['void *', 'uint32_t *', 'void *']);
// GetDevicesForIScsiSessionW(UniqueSessionId, DeviceCount, Devices)
// UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out -> 'void *'
// DeviceCount : DWORD* in/out -> 'uint32_t *'
// Devices : ISCSI_DEVICE_ON_SESSIONW* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ISCSIDSC.dll", {
  GetDevicesForIScsiSessionW: { parameters: ["pointer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.GetDevicesForIScsiSessionW(UniqueSessionId, DeviceCount, Devices)
// UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out -> "pointer"
// DeviceCount : DWORD* in/out -> "pointer"
// Devices : ISCSI_DEVICE_ON_SESSIONW* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetDevicesForIScsiSessionW(
    void* UniqueSessionId,
    uint32_t* DeviceCount,
    void* Devices);
C, "ISCSIDSC.dll");
// $ffi->GetDevicesForIScsiSessionW(UniqueSessionId, DeviceCount, Devices);
// UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out
// DeviceCount : DWORD* in/out
// Devices : ISCSI_DEVICE_ON_SESSIONW* in/out
// 構造体/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 GetDevicesForIScsiSessionW(
        Pointer UniqueSessionId,   // ISCSI_UNIQUE_SESSION_ID* in/out
        IntByReference DeviceCount,   // DWORD* in/out
        Pointer Devices   // ISCSI_DEVICE_ON_SESSIONW* in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("iscsidsc")]
lib LibISCSIDSC
  fun GetDevicesForIScsiSessionW = GetDevicesForIScsiSessionW(
    UniqueSessionId : ISCSI_UNIQUE_SESSION_ID*,   # ISCSI_UNIQUE_SESSION_ID* in/out
    DeviceCount : UInt32*,   # DWORD* in/out
    Devices : ISCSI_DEVICE_ON_SESSIONW*   # ISCSI_DEVICE_ON_SESSIONW* in/out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetDevicesForIScsiSessionWNative = Uint32 Function(Pointer<Void>, Pointer<Uint32>, Pointer<Void>);
typedef GetDevicesForIScsiSessionWDart = int Function(Pointer<Void>, Pointer<Uint32>, Pointer<Void>);
final GetDevicesForIScsiSessionW = DynamicLibrary.open('ISCSIDSC.dll')
    .lookupFunction<GetDevicesForIScsiSessionWNative, GetDevicesForIScsiSessionWDart>('GetDevicesForIScsiSessionW');
// UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out -> Pointer<Void>
// DeviceCount : DWORD* in/out -> Pointer<Uint32>
// Devices : ISCSI_DEVICE_ON_SESSIONW* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetDevicesForIScsiSessionW(
  UniqueSessionId: Pointer;   // ISCSI_UNIQUE_SESSION_ID* in/out
  DeviceCount: Pointer;   // DWORD* in/out
  Devices: Pointer   // ISCSI_DEVICE_ON_SESSIONW* in/out
): DWORD; stdcall;
  external 'ISCSIDSC.dll' name 'GetDevicesForIScsiSessionW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetDevicesForIScsiSessionW"
  c_GetDevicesForIScsiSessionW :: Ptr () -> Ptr Word32 -> Ptr () -> IO Word32
-- UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out -> Ptr ()
-- DeviceCount : DWORD* in/out -> Ptr Word32
-- Devices : ISCSI_DEVICE_ON_SESSIONW* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getdevicesforiscsisessionw =
  foreign "GetDevicesForIScsiSessionW"
    ((ptr void) @-> (ptr uint32_t) @-> (ptr void) @-> returning uint32_t)
(* UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out -> (ptr void) *)
(* DeviceCount : DWORD* in/out -> (ptr uint32_t) *)
(* Devices : ISCSI_DEVICE_ON_SESSIONW* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iscsidsc (t "ISCSIDSC.dll"))
(cffi:use-foreign-library iscsidsc)

(cffi:defcfun ("GetDevicesForIScsiSessionW" get-devices-for-iscsi-session-w :convention :stdcall) :uint32
  (unique-session-id :pointer)   ; ISCSI_UNIQUE_SESSION_ID* in/out
  (device-count :pointer)   ; DWORD* in/out
  (devices :pointer))   ; ISCSI_DEVICE_ON_SESSIONW* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetDevicesForIScsiSessionW = Win32::API::More->new('ISCSIDSC',
    'DWORD GetDevicesForIScsiSessionW(LPVOID UniqueSessionId, LPVOID DeviceCount, LPVOID Devices)');
# my $ret = $GetDevicesForIScsiSessionW->Call($UniqueSessionId, $DeviceCount, $Devices);
# UniqueSessionId : ISCSI_UNIQUE_SESSION_ID* in/out -> LPVOID
# DeviceCount : DWORD* in/out -> LPVOID
# Devices : ISCSI_DEVICE_ON_SESSIONW* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型