Win32 API 日本語リファレンス
ホームNetworkManagement.WindowsConnectionManager › WcmSetProperty

WcmSetProperty

関数
接続マネージャーのインターフェイスまたはプロファイルのプロパティを設定する。
DLLwcmapi.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD WcmSetProperty(
    const GUID* pInterface,   // optional
    LPCWSTR strProfileName,   // optional
    WCM_PROPERTY Property,
    void* pReserved,   // optional
    DWORD dwDataSize,
    const BYTE* pbData   // optional
);

パラメーター

名前方向説明
pInterfaceGUID*inoptional対象インターフェースのGUIDへのポインター。NULLで全インターフェース。
strProfileNameLPCWSTRinoptional対象プロファイル名。プロファイル単位でない場合はNULL可。
PropertyWCM_PROPERTYin設定するWCMプロパティの種別を示す列挙値。
pReservedvoid*optional予約領域。NULLを指定する必要がある。
dwDataSizeDWORDinpbDataが指すプロパティ値データのバイト数。
pbDataBYTE*inoptional設定するプロパティ値のデータへのポインター。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD WcmSetProperty(
    const GUID* pInterface,   // optional
    LPCWSTR strProfileName,   // optional
    WCM_PROPERTY Property,
    void* pReserved,   // optional
    DWORD dwDataSize,
    const BYTE* pbData   // optional
);
[DllImport("wcmapi.dll", ExactSpelling = true)]
static extern uint WcmSetProperty(
    IntPtr pInterface,   // GUID* optional
    [MarshalAs(UnmanagedType.LPWStr)] string strProfileName,   // LPCWSTR optional
    int Property,   // WCM_PROPERTY
    IntPtr pReserved,   // void* optional
    uint dwDataSize,   // DWORD
    IntPtr pbData   // BYTE* optional
);
<DllImport("wcmapi.dll", ExactSpelling:=True)>
Public Shared Function WcmSetProperty(
    pInterface As IntPtr,   ' GUID* optional
    <MarshalAs(UnmanagedType.LPWStr)> strProfileName As String,   ' LPCWSTR optional
    [Property] As Integer,   ' WCM_PROPERTY
    pReserved As IntPtr,   ' void* optional
    dwDataSize As UInteger,   ' DWORD
    pbData As IntPtr   ' BYTE* optional
) As UInteger
End Function
' pInterface : GUID* optional
' strProfileName : LPCWSTR optional
' Property : WCM_PROPERTY
' pReserved : void* optional
' dwDataSize : DWORD
' pbData : BYTE* optional
Declare PtrSafe Function WcmSetProperty Lib "wcmapi" ( _
    ByVal pInterface As LongPtr, _
    ByVal strProfileName As LongPtr, _
    ByVal Property As Long, _
    ByVal pReserved As LongPtr, _
    ByVal dwDataSize As Long, _
    ByVal pbData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WcmSetProperty = ctypes.windll.wcmapi.WcmSetProperty
WcmSetProperty.restype = wintypes.DWORD
WcmSetProperty.argtypes = [
    ctypes.c_void_p,  # pInterface : GUID* optional
    wintypes.LPCWSTR,  # strProfileName : LPCWSTR optional
    ctypes.c_int,  # Property : WCM_PROPERTY
    ctypes.POINTER(None),  # pReserved : void* optional
    wintypes.DWORD,  # dwDataSize : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pbData : BYTE* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wcmapi.dll')
WcmSetProperty = Fiddle::Function.new(
  lib['WcmSetProperty'],
  [
    Fiddle::TYPE_VOIDP,  # pInterface : GUID* optional
    Fiddle::TYPE_VOIDP,  # strProfileName : LPCWSTR optional
    Fiddle::TYPE_INT,  # Property : WCM_PROPERTY
    Fiddle::TYPE_VOIDP,  # pReserved : void* optional
    -Fiddle::TYPE_INT,  # dwDataSize : DWORD
    Fiddle::TYPE_VOIDP,  # pbData : BYTE* optional
  ],
  -Fiddle::TYPE_INT)
#[link(name = "wcmapi")]
extern "system" {
    fn WcmSetProperty(
        pInterface: *const GUID,  // GUID* optional
        strProfileName: *const u16,  // LPCWSTR optional
        Property: i32,  // WCM_PROPERTY
        pReserved: *mut (),  // void* optional
        dwDataSize: u32,  // DWORD
        pbData: *const u8  // BYTE* optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("wcmapi.dll")]
public static extern uint WcmSetProperty(IntPtr pInterface, [MarshalAs(UnmanagedType.LPWStr)] string strProfileName, int Property, IntPtr pReserved, uint dwDataSize, IntPtr pbData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wcmapi_WcmSetProperty' -Namespace Win32 -PassThru
# $api::WcmSetProperty(pInterface, strProfileName, Property, pReserved, dwDataSize, pbData)
#uselib "wcmapi.dll"
#func global WcmSetProperty "WcmSetProperty" sptr, sptr, sptr, sptr, sptr, sptr
; WcmSetProperty varptr(pInterface), strProfileName, Property, pReserved, dwDataSize, varptr(pbData)   ; 戻り値は stat
; pInterface : GUID* optional -> "sptr"
; strProfileName : LPCWSTR optional -> "sptr"
; Property : WCM_PROPERTY -> "sptr"
; pReserved : void* optional -> "sptr"
; dwDataSize : DWORD -> "sptr"
; pbData : BYTE* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "wcmapi.dll"
#cfunc global WcmSetProperty "WcmSetProperty" var, wstr, int, sptr, int, var
; res = WcmSetProperty(pInterface, strProfileName, Property, pReserved, dwDataSize, pbData)
; pInterface : GUID* optional -> "var"
; strProfileName : LPCWSTR optional -> "wstr"
; Property : WCM_PROPERTY -> "int"
; pReserved : void* optional -> "sptr"
; dwDataSize : DWORD -> "int"
; pbData : BYTE* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD WcmSetProperty(GUID* pInterface, LPCWSTR strProfileName, WCM_PROPERTY Property, void* pReserved, DWORD dwDataSize, BYTE* pbData)
#uselib "wcmapi.dll"
#cfunc global WcmSetProperty "WcmSetProperty" var, wstr, int, intptr, int, var
; res = WcmSetProperty(pInterface, strProfileName, Property, pReserved, dwDataSize, pbData)
; pInterface : GUID* optional -> "var"
; strProfileName : LPCWSTR optional -> "wstr"
; Property : WCM_PROPERTY -> "int"
; pReserved : void* optional -> "intptr"
; dwDataSize : DWORD -> "int"
; pbData : BYTE* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wcmapi = windows.NewLazySystemDLL("wcmapi.dll")
	procWcmSetProperty = wcmapi.NewProc("WcmSetProperty")
)

// pInterface (GUID* optional), strProfileName (LPCWSTR optional), Property (WCM_PROPERTY), pReserved (void* optional), dwDataSize (DWORD), pbData (BYTE* optional)
r1, _, err := procWcmSetProperty.Call(
	uintptr(pInterface),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(strProfileName))),
	uintptr(Property),
	uintptr(pReserved),
	uintptr(dwDataSize),
	uintptr(pbData),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function WcmSetProperty(
  pInterface: PGUID;   // GUID* optional
  strProfileName: PWideChar;   // LPCWSTR optional
  Property: Integer;   // WCM_PROPERTY
  pReserved: Pointer;   // void* optional
  dwDataSize: DWORD;   // DWORD
  pbData: Pointer   // BYTE* optional
): DWORD; stdcall;
  external 'wcmapi.dll' name 'WcmSetProperty';
result := DllCall("wcmapi\WcmSetProperty"
    , "Ptr", pInterface   ; GUID* optional
    , "WStr", strProfileName   ; LPCWSTR optional
    , "Int", Property   ; WCM_PROPERTY
    , "Ptr", pReserved   ; void* optional
    , "UInt", dwDataSize   ; DWORD
    , "Ptr", pbData   ; BYTE* optional
    , "UInt")   ; return: DWORD
●WcmSetProperty(pInterface, strProfileName, Property, pReserved, dwDataSize, pbData) = DLL("wcmapi.dll", "dword WcmSetProperty(void*, char*, int, void*, dword, void*)")
# 呼び出し: WcmSetProperty(pInterface, strProfileName, Property, pReserved, dwDataSize, pbData)
# pInterface : GUID* optional -> "void*"
# strProfileName : LPCWSTR optional -> "char*"
# Property : WCM_PROPERTY -> "int"
# pReserved : void* optional -> "void*"
# dwDataSize : DWORD -> "dword"
# pbData : BYTE* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef WcmSetPropertyNative = Uint32 Function(Pointer<Void>, Pointer<Utf16>, Int32, Pointer<Void>, Uint32, Pointer<Uint8>);
typedef WcmSetPropertyDart = int Function(Pointer<Void>, Pointer<Utf16>, int, Pointer<Void>, int, Pointer<Uint8>);
final WcmSetProperty = DynamicLibrary.open('wcmapi.dll')
    .lookupFunction<WcmSetPropertyNative, WcmSetPropertyDart>('WcmSetProperty');
// pInterface : GUID* optional -> Pointer<Void>
// strProfileName : LPCWSTR optional -> Pointer<Utf16>
// Property : WCM_PROPERTY -> Int32
// pReserved : void* optional -> Pointer<Void>
// dwDataSize : DWORD -> Uint32
// pbData : BYTE* optional -> Pointer<Uint8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WcmSetProperty(
  pInterface: PGUID;   // GUID* optional
  strProfileName: PWideChar;   // LPCWSTR optional
  Property: Integer;   // WCM_PROPERTY
  pReserved: Pointer;   // void* optional
  dwDataSize: DWORD;   // DWORD
  pbData: Pointer   // BYTE* optional
): DWORD; stdcall;
  external 'wcmapi.dll' name 'WcmSetProperty';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WcmSetProperty"
  c_WcmSetProperty :: Ptr () -> CWString -> Int32 -> Ptr () -> Word32 -> Ptr Word8 -> IO Word32
-- pInterface : GUID* optional -> Ptr ()
-- strProfileName : LPCWSTR optional -> CWString
-- Property : WCM_PROPERTY -> Int32
-- pReserved : void* optional -> Ptr ()
-- dwDataSize : DWORD -> Word32
-- pbData : BYTE* optional -> Ptr Word8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wcmsetproperty =
  foreign "WcmSetProperty"
    ((ptr void) @-> (ptr uint16_t) @-> int32_t @-> (ptr void) @-> uint32_t @-> (ptr uint8_t) @-> returning uint32_t)
(* pInterface : GUID* optional -> (ptr void) *)
(* strProfileName : LPCWSTR optional -> (ptr uint16_t) *)
(* Property : WCM_PROPERTY -> int32_t *)
(* pReserved : void* optional -> (ptr void) *)
(* dwDataSize : DWORD -> uint32_t *)
(* pbData : BYTE* optional -> (ptr uint8_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wcmapi (t "wcmapi.dll"))
(cffi:use-foreign-library wcmapi)

(cffi:defcfun ("WcmSetProperty" wcm-set-property :convention :stdcall) :uint32
  (p-interface :pointer)   ; GUID* optional
  (str-profile-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (property :int32)   ; WCM_PROPERTY
  (p-reserved :pointer)   ; void* optional
  (dw-data-size :uint32)   ; DWORD
  (pb-data :pointer))   ; BYTE* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WcmSetProperty = Win32::API::More->new('wcmapi',
    'DWORD WcmSetProperty(LPVOID pInterface, LPCWSTR strProfileName, int Property, LPVOID pReserved, DWORD dwDataSize, LPVOID pbData)');
# my $ret = $WcmSetProperty->Call($pInterface, $strProfileName, $Property, $pReserved, $dwDataSize, $pbData);
# pInterface : GUID* optional -> LPVOID
# strProfileName : LPCWSTR optional -> LPCWSTR
# Property : WCM_PROPERTY -> int
# pReserved : void* optional -> LPVOID
# dwDataSize : DWORD -> DWORD
# pbData : BYTE* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型