Win32 API 日本語リファレンス
ホームDevices.WebServicesOnDevices › WSDGetConfigurationOption

WSDGetConfigurationOption

関数
WSDAPIの指定した構成オプションの現在値を取得する。
DLLwsdapi.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT WSDGetConfigurationOption(
    DWORD dwOption,
    void* pVoid,
    DWORD cbOutBuffer
);

パラメーター

名前方向説明
dwOptionDWORDin取得する構成オプションの種類を示す識別子。
pVoidvoid*out取得したオプション値を格納するバッファへのポインタ。
cbOutBufferDWORDinpVoidが指す出力バッファのバイト数。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WSDGetConfigurationOption(
    DWORD dwOption,
    void* pVoid,
    DWORD cbOutBuffer
);
[DllImport("wsdapi.dll", ExactSpelling = true)]
static extern int WSDGetConfigurationOption(
    uint dwOption,   // DWORD
    IntPtr pVoid,   // void* out
    uint cbOutBuffer   // DWORD
);
<DllImport("wsdapi.dll", ExactSpelling:=True)>
Public Shared Function WSDGetConfigurationOption(
    dwOption As UInteger,   ' DWORD
    pVoid As IntPtr,   ' void* out
    cbOutBuffer As UInteger   ' DWORD
) As Integer
End Function
' dwOption : DWORD
' pVoid : void* out
' cbOutBuffer : DWORD
Declare PtrSafe Function WSDGetConfigurationOption Lib "wsdapi" ( _
    ByVal dwOption As Long, _
    ByVal pVoid As LongPtr, _
    ByVal cbOutBuffer As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WSDGetConfigurationOption = ctypes.windll.wsdapi.WSDGetConfigurationOption
WSDGetConfigurationOption.restype = ctypes.c_int
WSDGetConfigurationOption.argtypes = [
    wintypes.DWORD,  # dwOption : DWORD
    ctypes.POINTER(None),  # pVoid : void* out
    wintypes.DWORD,  # cbOutBuffer : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	wsdapi = windows.NewLazySystemDLL("wsdapi.dll")
	procWSDGetConfigurationOption = wsdapi.NewProc("WSDGetConfigurationOption")
)

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

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

typedef WSDGetConfigurationOptionNative = Int32 Function(Uint32, Pointer<Void>, Uint32);
typedef WSDGetConfigurationOptionDart = int Function(int, Pointer<Void>, int);
final WSDGetConfigurationOption = DynamicLibrary.open('wsdapi.dll')
    .lookupFunction<WSDGetConfigurationOptionNative, WSDGetConfigurationOptionDart>('WSDGetConfigurationOption');
// dwOption : DWORD -> Uint32
// pVoid : void* out -> Pointer<Void>
// cbOutBuffer : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WSDGetConfigurationOption(
  dwOption: DWORD;   // DWORD
  pVoid: Pointer;   // void* out
  cbOutBuffer: DWORD   // DWORD
): Integer; stdcall;
  external 'wsdapi.dll' name 'WSDGetConfigurationOption';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WSDGetConfigurationOption"
  c_WSDGetConfigurationOption :: Word32 -> Ptr () -> Word32 -> IO Int32
-- dwOption : DWORD -> Word32
-- pVoid : void* out -> Ptr ()
-- cbOutBuffer : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wsdgetconfigurationoption =
  foreign "WSDGetConfigurationOption"
    (uint32_t @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* dwOption : DWORD -> uint32_t *)
(* pVoid : void* out -> (ptr void) *)
(* cbOutBuffer : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wsdapi (t "wsdapi.dll"))
(cffi:use-foreign-library wsdapi)

(cffi:defcfun ("WSDGetConfigurationOption" wsdget-configuration-option :convention :stdcall) :int32
  (dw-option :uint32)   ; DWORD
  (p-void :pointer)   ; void* out
  (cb-out-buffer :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WSDGetConfigurationOption = Win32::API::More->new('wsdapi',
    'int WSDGetConfigurationOption(DWORD dwOption, LPVOID pVoid, DWORD cbOutBuffer)');
# my $ret = $WSDGetConfigurationOption->Call($dwOption, $pVoid, $cbOutBuffer);
# dwOption : DWORD -> DWORD
# pVoid : void* out -> LPVOID
# cbOutBuffer : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。