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

SetupSetPlatformPathOverrideW

関数
プラットフォーム固有パスの上書き設定を行う(Unicode)。
DLLSETUPAPI.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL SetupSetPlatformPathOverrideW(
    LPCWSTR Override   // optional
);

パラメーター

名前方向説明
OverrideLPCWSTRinoptionalプラットフォーム固有のパス展開を上書きする文字列(Unicode)。NULLで上書きを解除する。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SetupSetPlatformPathOverrideW(
    LPCWSTR Override   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetupSetPlatformPathOverrideW(
    [MarshalAs(UnmanagedType.LPWStr)] string Override   // LPCWSTR optional
);
<DllImport("SETUPAPI.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupSetPlatformPathOverrideW(
    <MarshalAs(UnmanagedType.LPWStr)> Override As String   ' LPCWSTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' Override : LPCWSTR optional
Declare PtrSafe Function SetupSetPlatformPathOverrideW Lib "setupapi" ( _
    ByVal Override 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

SetupSetPlatformPathOverrideW = ctypes.windll.setupapi.SetupSetPlatformPathOverrideW
SetupSetPlatformPathOverrideW.restype = wintypes.BOOL
SetupSetPlatformPathOverrideW.argtypes = [
    wintypes.LPCWSTR,  # Override : LPCWSTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupSetPlatformPathOverrideW = Fiddle::Function.new(
  lib['SetupSetPlatformPathOverrideW'],
  [
    Fiddle::TYPE_VOIDP,  # Override : LPCWSTR optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "setupapi")]
extern "system" {
    fn SetupSetPlatformPathOverrideW(
        Override: *const u16  // LPCWSTR optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool SetupSetPlatformPathOverrideW([MarshalAs(UnmanagedType.LPWStr)] string Override);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupSetPlatformPathOverrideW' -Namespace Win32 -PassThru
# $api::SetupSetPlatformPathOverrideW(Override)
#uselib "SETUPAPI.dll"
#func global SetupSetPlatformPathOverrideW "SetupSetPlatformPathOverrideW" wptr
; SetupSetPlatformPathOverrideW Override   ; 戻り値は stat
; Override : LPCWSTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SETUPAPI.dll"
#cfunc global SetupSetPlatformPathOverrideW "SetupSetPlatformPathOverrideW" wstr
; res = SetupSetPlatformPathOverrideW(Override)
; Override : LPCWSTR optional -> "wstr"
; BOOL SetupSetPlatformPathOverrideW(LPCWSTR Override)
#uselib "SETUPAPI.dll"
#cfunc global SetupSetPlatformPathOverrideW "SetupSetPlatformPathOverrideW" wstr
; res = SetupSetPlatformPathOverrideW(Override)
; Override : LPCWSTR optional -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupSetPlatformPathOverrideW = setupapi.NewProc("SetupSetPlatformPathOverrideW")
)

// Override (LPCWSTR optional)
r1, _, err := procSetupSetPlatformPathOverrideW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(Override))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetupSetPlatformPathOverrideW(
  Override: PWideChar   // LPCWSTR optional
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupSetPlatformPathOverrideW';
result := DllCall("SETUPAPI\SetupSetPlatformPathOverrideW"
    , "WStr", Override   ; LPCWSTR optional
    , "Int")   ; return: BOOL
●SetupSetPlatformPathOverrideW(Override) = DLL("SETUPAPI.dll", "bool SetupSetPlatformPathOverrideW(char*)")
# 呼び出し: SetupSetPlatformPathOverrideW(Override)
# Override : LPCWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "setupapi" fn SetupSetPlatformPathOverrideW(
    Override: [*c]const u16 // LPCWSTR optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetupSetPlatformPathOverrideW(
    Override: WideCString  # LPCWSTR optional
): int32 {.importc: "SetupSetPlatformPathOverrideW", stdcall, dynlib: "SETUPAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "setupapi");
extern(Windows)
int SetupSetPlatformPathOverrideW(
    const(wchar)* Override   // LPCWSTR optional
);
ccall((:SetupSetPlatformPathOverrideW, "SETUPAPI.dll"), stdcall, Int32,
      (Cwstring,),
      Override)
# Override : LPCWSTR optional -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetupSetPlatformPathOverrideW(
    const uint16_t* Override);
]]
local setupapi = ffi.load("setupapi")
-- setupapi.SetupSetPlatformPathOverrideW(Override)
-- Override : LPCWSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SETUPAPI.dll');
const SetupSetPlatformPathOverrideW = lib.func('__stdcall', 'SetupSetPlatformPathOverrideW', 'int32_t', ['str16']);
// SetupSetPlatformPathOverrideW(Override)
// Override : LPCWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SETUPAPI.dll", {
  SetupSetPlatformPathOverrideW: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.SetupSetPlatformPathOverrideW(Override)
// Override : LPCWSTR optional -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetupSetPlatformPathOverrideW(
    const uint16_t* Override);
C, "SETUPAPI.dll");
// $ffi->SetupSetPlatformPathOverrideW(Override);
// Override : LPCWSTR 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 Setupapi extends StdCallLibrary {
    Setupapi INSTANCE = Native.load("setupapi", Setupapi.class, W32APIOptions.UNICODE_OPTIONS);
    boolean SetupSetPlatformPathOverrideW(
        WString Override   // LPCWSTR optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("setupapi")]
lib LibSETUPAPI
  fun SetupSetPlatformPathOverrideW = SetupSetPlatformPathOverrideW(
    Override : UInt16*   # LPCWSTR optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetupSetPlatformPathOverrideWNative = Int32 Function(Pointer<Utf16>);
typedef SetupSetPlatformPathOverrideWDart = int Function(Pointer<Utf16>);
final SetupSetPlatformPathOverrideW = DynamicLibrary.open('SETUPAPI.dll')
    .lookupFunction<SetupSetPlatformPathOverrideWNative, SetupSetPlatformPathOverrideWDart>('SetupSetPlatformPathOverrideW');
// Override : LPCWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetupSetPlatformPathOverrideW(
  Override: PWideChar   // LPCWSTR optional
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupSetPlatformPathOverrideW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetupSetPlatformPathOverrideW"
  c_SetupSetPlatformPathOverrideW :: CWString -> IO CInt
-- Override : LPCWSTR optional -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setupsetplatformpathoverridew =
  foreign "SetupSetPlatformPathOverrideW"
    ((ptr uint16_t) @-> returning int32_t)
(* Override : LPCWSTR optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library setupapi (t "SETUPAPI.dll"))
(cffi:use-foreign-library setupapi)

(cffi:defcfun ("SetupSetPlatformPathOverrideW" setup-set-platform-path-override-w :convention :stdcall) :int32
  (override (:string :encoding :utf-16le)))   ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetupSetPlatformPathOverrideW = Win32::API::More->new('SETUPAPI',
    'BOOL SetupSetPlatformPathOverrideW(LPCWSTR Override)');
# my $ret = $SetupSetPlatformPathOverrideW->Call($Override);
# Override : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い