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

WdsBpAddOption

関数
WDSブートプログラムパケットにオプションを追加する。
DLLWDSBP.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD WdsBpAddOption(
    HANDLE hHandle,
    DWORD uOption,
    DWORD uValueLen,
    void* pValue
);

パラメーター

名前方向説明
hHandleHANDLEin対象のパケット構築ハンドル。
uOptionDWORDin追加するオプションのコード。
uValueLenDWORDinオプション値の長さ(バイト単位)。
pValuevoid*in追加するオプション値データへのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

WdsBpAddOption = ctypes.windll.wdsbp.WdsBpAddOption
WdsBpAddOption.restype = wintypes.DWORD
WdsBpAddOption.argtypes = [
    wintypes.HANDLE,  # hHandle : HANDLE
    wintypes.DWORD,  # uOption : DWORD
    wintypes.DWORD,  # uValueLen : DWORD
    ctypes.POINTER(None),  # pValue : void*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WDSBP.dll')
WdsBpAddOption = Fiddle::Function.new(
  lib['WdsBpAddOption'],
  [
    Fiddle::TYPE_VOIDP,  # hHandle : HANDLE
    -Fiddle::TYPE_INT,  # uOption : DWORD
    -Fiddle::TYPE_INT,  # uValueLen : DWORD
    Fiddle::TYPE_VOIDP,  # pValue : void*
  ],
  -Fiddle::TYPE_INT)
#[link(name = "wdsbp")]
extern "system" {
    fn WdsBpAddOption(
        hHandle: *mut core::ffi::c_void,  // HANDLE
        uOption: u32,  // DWORD
        uValueLen: u32,  // DWORD
        pValue: *mut ()  // void*
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WDSBP.dll")]
public static extern uint WdsBpAddOption(IntPtr hHandle, uint uOption, uint uValueLen, IntPtr pValue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WDSBP_WdsBpAddOption' -Namespace Win32 -PassThru
# $api::WdsBpAddOption(hHandle, uOption, uValueLen, pValue)
#uselib "WDSBP.dll"
#func global WdsBpAddOption "WdsBpAddOption" sptr, sptr, sptr, sptr
; WdsBpAddOption hHandle, uOption, uValueLen, pValue   ; 戻り値は stat
; hHandle : HANDLE -> "sptr"
; uOption : DWORD -> "sptr"
; uValueLen : DWORD -> "sptr"
; pValue : void* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WDSBP.dll"
#cfunc global WdsBpAddOption "WdsBpAddOption" sptr, int, int, sptr
; res = WdsBpAddOption(hHandle, uOption, uValueLen, pValue)
; hHandle : HANDLE -> "sptr"
; uOption : DWORD -> "int"
; uValueLen : DWORD -> "int"
; pValue : void* -> "sptr"
; DWORD WdsBpAddOption(HANDLE hHandle, DWORD uOption, DWORD uValueLen, void* pValue)
#uselib "WDSBP.dll"
#cfunc global WdsBpAddOption "WdsBpAddOption" intptr, int, int, intptr
; res = WdsBpAddOption(hHandle, uOption, uValueLen, pValue)
; hHandle : HANDLE -> "intptr"
; uOption : DWORD -> "int"
; uValueLen : DWORD -> "int"
; pValue : void* -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wdsbp = windows.NewLazySystemDLL("WDSBP.dll")
	procWdsBpAddOption = wdsbp.NewProc("WdsBpAddOption")
)

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

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

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

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

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

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