Win32 API 日本語リファレンス
ホームSystem.DeploymentServices › WdsBpGetOptionBuffer

WdsBpGetOptionBuffer

関数
WDSブートプログラムの構築済みオプションバッファを取得する。
DLLWDSBP.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// WDSBP.dll
#include <windows.h>

DWORD WdsBpGetOptionBuffer(
    HANDLE hHandle,
    DWORD uBufferLen,
    void* pBuffer,
    DWORD* puBytes
);

パラメーター

名前方向説明
hHandleHANDLEin対象のパケット構築ハンドル。
uBufferLenDWORDinpBufferのサイズ(バイト単位)。
pBuffervoid*out構築済みオプション群のバイト列を書き込むバッファ。
puBytesDWORD*out実際に書き込まれたバイト数を受け取るDWORDポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

// WDSBP.dll
#include <windows.h>

DWORD WdsBpGetOptionBuffer(
    HANDLE hHandle,
    DWORD uBufferLen,
    void* pBuffer,
    DWORD* puBytes
);
[DllImport("WDSBP.dll", ExactSpelling = true)]
static extern uint WdsBpGetOptionBuffer(
    IntPtr hHandle,   // HANDLE
    uint uBufferLen,   // DWORD
    IntPtr pBuffer,   // void* out
    out uint puBytes   // DWORD* out
);
<DllImport("WDSBP.dll", ExactSpelling:=True)>
Public Shared Function WdsBpGetOptionBuffer(
    hHandle As IntPtr,   ' HANDLE
    uBufferLen As UInteger,   ' DWORD
    pBuffer As IntPtr,   ' void* out
    <Out> ByRef puBytes As UInteger   ' DWORD* out
) As UInteger
End Function
' hHandle : HANDLE
' uBufferLen : DWORD
' pBuffer : void* out
' puBytes : DWORD* out
Declare PtrSafe Function WdsBpGetOptionBuffer Lib "wdsbp" ( _
    ByVal hHandle As LongPtr, _
    ByVal uBufferLen As Long, _
    ByVal pBuffer As LongPtr, _
    ByRef puBytes As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WdsBpGetOptionBuffer = ctypes.windll.wdsbp.WdsBpGetOptionBuffer
WdsBpGetOptionBuffer.restype = wintypes.DWORD
WdsBpGetOptionBuffer.argtypes = [
    wintypes.HANDLE,  # hHandle : HANDLE
    wintypes.DWORD,  # uBufferLen : DWORD
    ctypes.POINTER(None),  # pBuffer : void* out
    ctypes.POINTER(wintypes.DWORD),  # puBytes : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WDSBP.dll')
WdsBpGetOptionBuffer = Fiddle::Function.new(
  lib['WdsBpGetOptionBuffer'],
  [
    Fiddle::TYPE_VOIDP,  # hHandle : HANDLE
    -Fiddle::TYPE_INT,  # uBufferLen : DWORD
    Fiddle::TYPE_VOIDP,  # pBuffer : void* out
    Fiddle::TYPE_VOIDP,  # puBytes : DWORD* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "wdsbp")]
extern "system" {
    fn WdsBpGetOptionBuffer(
        hHandle: *mut core::ffi::c_void,  // HANDLE
        uBufferLen: u32,  // DWORD
        pBuffer: *mut (),  // void* out
        puBytes: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WDSBP.dll")]
public static extern uint WdsBpGetOptionBuffer(IntPtr hHandle, uint uBufferLen, IntPtr pBuffer, out uint puBytes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WDSBP_WdsBpGetOptionBuffer' -Namespace Win32 -PassThru
# $api::WdsBpGetOptionBuffer(hHandle, uBufferLen, pBuffer, puBytes)
#uselib "WDSBP.dll"
#func global WdsBpGetOptionBuffer "WdsBpGetOptionBuffer" sptr, sptr, sptr, sptr
; WdsBpGetOptionBuffer hHandle, uBufferLen, pBuffer, varptr(puBytes)   ; 戻り値は stat
; hHandle : HANDLE -> "sptr"
; uBufferLen : DWORD -> "sptr"
; pBuffer : void* out -> "sptr"
; puBytes : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WDSBP.dll"
#cfunc global WdsBpGetOptionBuffer "WdsBpGetOptionBuffer" sptr, int, sptr, var
; res = WdsBpGetOptionBuffer(hHandle, uBufferLen, pBuffer, puBytes)
; hHandle : HANDLE -> "sptr"
; uBufferLen : DWORD -> "int"
; pBuffer : void* out -> "sptr"
; puBytes : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD WdsBpGetOptionBuffer(HANDLE hHandle, DWORD uBufferLen, void* pBuffer, DWORD* puBytes)
#uselib "WDSBP.dll"
#cfunc global WdsBpGetOptionBuffer "WdsBpGetOptionBuffer" intptr, int, intptr, var
; res = WdsBpGetOptionBuffer(hHandle, uBufferLen, pBuffer, puBytes)
; hHandle : HANDLE -> "intptr"
; uBufferLen : DWORD -> "int"
; pBuffer : void* out -> "intptr"
; puBytes : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wdsbp = windows.NewLazySystemDLL("WDSBP.dll")
	procWdsBpGetOptionBuffer = wdsbp.NewProc("WdsBpGetOptionBuffer")
)

// hHandle (HANDLE), uBufferLen (DWORD), pBuffer (void* out), puBytes (DWORD* out)
r1, _, err := procWdsBpGetOptionBuffer.Call(
	uintptr(hHandle),
	uintptr(uBufferLen),
	uintptr(pBuffer),
	uintptr(puBytes),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function WdsBpGetOptionBuffer(
  hHandle: THandle;   // HANDLE
  uBufferLen: DWORD;   // DWORD
  pBuffer: Pointer;   // void* out
  puBytes: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'WDSBP.dll' name 'WdsBpGetOptionBuffer';
result := DllCall("WDSBP\WdsBpGetOptionBuffer"
    , "Ptr", hHandle   ; HANDLE
    , "UInt", uBufferLen   ; DWORD
    , "Ptr", pBuffer   ; void* out
    , "Ptr", puBytes   ; DWORD* out
    , "UInt")   ; return: DWORD
●WdsBpGetOptionBuffer(hHandle, uBufferLen, pBuffer, puBytes) = DLL("WDSBP.dll", "dword WdsBpGetOptionBuffer(void*, dword, void*, void*)")
# 呼び出し: WdsBpGetOptionBuffer(hHandle, uBufferLen, pBuffer, puBytes)
# hHandle : HANDLE -> "void*"
# uBufferLen : DWORD -> "dword"
# pBuffer : void* out -> "void*"
# puBytes : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wdsbp" fn WdsBpGetOptionBuffer(
    hHandle: ?*anyopaque, // HANDLE
    uBufferLen: u32, // DWORD
    pBuffer: ?*anyopaque, // void* out
    puBytes: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) u32;
proc WdsBpGetOptionBuffer(
    hHandle: pointer,  # HANDLE
    uBufferLen: uint32,  # DWORD
    pBuffer: pointer,  # void* out
    puBytes: ptr uint32  # DWORD* out
): uint32 {.importc: "WdsBpGetOptionBuffer", stdcall, dynlib: "WDSBP.dll".}
pragma(lib, "wdsbp");
extern(Windows)
uint WdsBpGetOptionBuffer(
    void* hHandle,   // HANDLE
    uint uBufferLen,   // DWORD
    void* pBuffer,   // void* out
    uint* puBytes   // DWORD* out
);
ccall((:WdsBpGetOptionBuffer, "WDSBP.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, UInt32, Ptr{Cvoid}, Ptr{UInt32}),
      hHandle, uBufferLen, pBuffer, puBytes)
# hHandle : HANDLE -> Ptr{Cvoid}
# uBufferLen : DWORD -> UInt32
# pBuffer : void* out -> Ptr{Cvoid}
# puBytes : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t WdsBpGetOptionBuffer(
    void* hHandle,
    uint32_t uBufferLen,
    void* pBuffer,
    uint32_t* puBytes);
]]
local wdsbp = ffi.load("wdsbp")
-- wdsbp.WdsBpGetOptionBuffer(hHandle, uBufferLen, pBuffer, puBytes)
-- hHandle : HANDLE
-- uBufferLen : DWORD
-- pBuffer : void* out
-- puBytes : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WDSBP.dll');
const WdsBpGetOptionBuffer = lib.func('__stdcall', 'WdsBpGetOptionBuffer', 'uint32_t', ['void *', 'uint32_t', 'void *', 'uint32_t *']);
// WdsBpGetOptionBuffer(hHandle, uBufferLen, pBuffer, puBytes)
// hHandle : HANDLE -> 'void *'
// uBufferLen : DWORD -> 'uint32_t'
// pBuffer : void* out -> 'void *'
// puBytes : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WDSBP.dll", {
  WdsBpGetOptionBuffer: { parameters: ["pointer", "u32", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.WdsBpGetOptionBuffer(hHandle, uBufferLen, pBuffer, puBytes)
// hHandle : HANDLE -> "pointer"
// uBufferLen : DWORD -> "u32"
// pBuffer : void* out -> "pointer"
// puBytes : DWORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t WdsBpGetOptionBuffer(
    void* hHandle,
    uint32_t uBufferLen,
    void* pBuffer,
    uint32_t* puBytes);
C, "WDSBP.dll");
// $ffi->WdsBpGetOptionBuffer(hHandle, uBufferLen, pBuffer, puBytes);
// hHandle : HANDLE
// uBufferLen : DWORD
// pBuffer : void* out
// puBytes : DWORD* 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 Wdsbp extends StdCallLibrary {
    Wdsbp INSTANCE = Native.load("wdsbp", Wdsbp.class);
    int WdsBpGetOptionBuffer(
        Pointer hHandle,   // HANDLE
        int uBufferLen,   // DWORD
        Pointer pBuffer,   // void* out
        IntByReference puBytes   // DWORD* out
    );
}
@[Link("wdsbp")]
lib LibWDSBP
  fun WdsBpGetOptionBuffer = WdsBpGetOptionBuffer(
    hHandle : Void*,   # HANDLE
    uBufferLen : UInt32,   # DWORD
    pBuffer : Void*,   # void* out
    puBytes : UInt32*   # DWORD* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WdsBpGetOptionBufferNative = Uint32 Function(Pointer<Void>, Uint32, Pointer<Void>, Pointer<Uint32>);
typedef WdsBpGetOptionBufferDart = int Function(Pointer<Void>, int, Pointer<Void>, Pointer<Uint32>);
final WdsBpGetOptionBuffer = DynamicLibrary.open('WDSBP.dll')
    .lookupFunction<WdsBpGetOptionBufferNative, WdsBpGetOptionBufferDart>('WdsBpGetOptionBuffer');
// hHandle : HANDLE -> Pointer<Void>
// uBufferLen : DWORD -> Uint32
// pBuffer : void* out -> Pointer<Void>
// puBytes : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WdsBpGetOptionBuffer(
  hHandle: THandle;   // HANDLE
  uBufferLen: DWORD;   // DWORD
  pBuffer: Pointer;   // void* out
  puBytes: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'WDSBP.dll' name 'WdsBpGetOptionBuffer';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WdsBpGetOptionBuffer"
  c_WdsBpGetOptionBuffer :: Ptr () -> Word32 -> Ptr () -> Ptr Word32 -> IO Word32
-- hHandle : HANDLE -> Ptr ()
-- uBufferLen : DWORD -> Word32
-- pBuffer : void* out -> Ptr ()
-- puBytes : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wdsbpgetoptionbuffer =
  foreign "WdsBpGetOptionBuffer"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> (ptr uint32_t) @-> returning uint32_t)
(* hHandle : HANDLE -> (ptr void) *)
(* uBufferLen : DWORD -> uint32_t *)
(* pBuffer : void* out -> (ptr void) *)
(* puBytes : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wdsbp (t "WDSBP.dll"))
(cffi:use-foreign-library wdsbp)

(cffi:defcfun ("WdsBpGetOptionBuffer" wds-bp-get-option-buffer :convention :stdcall) :uint32
  (h-handle :pointer)   ; HANDLE
  (u-buffer-len :uint32)   ; DWORD
  (p-buffer :pointer)   ; void* out
  (pu-bytes :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WdsBpGetOptionBuffer = Win32::API::More->new('WDSBP',
    'DWORD WdsBpGetOptionBuffer(HANDLE hHandle, DWORD uBufferLen, LPVOID pBuffer, LPVOID puBytes)');
# my $ret = $WdsBpGetOptionBuffer->Call($hHandle, $uBufferLen, $pBuffer, $puBytes);
# hHandle : HANDLE -> HANDLE
# uBufferLen : DWORD -> DWORD
# pBuffer : void* out -> LPVOID
# puBytes : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。