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

SetupSetFileQueueAlternatePlatformA

関数
ファイルキューに代替プラットフォーム情報を設定する(ANSI)。
DLLSETUPAPI.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// SETUPAPI.dll  (ANSI / -A)
#include <windows.h>

BOOL SetupSetFileQueueAlternatePlatformA(
    void* QueueHandle,
    SP_ALTPLATFORM_INFO_V2* AlternatePlatformInfo,   // optional
    LPCSTR AlternateDefaultCatalogFile   // optional
);

パラメーター

名前型方向説明
QueueHandlevoid*in対象のセットアップファイルキューハンドル。
AlternatePlatformInfoSP_ALTPLATFORM_INFO_V2*inoptional代替プラットフォーム情報を指すSP_ALTPLATFORM_INFO_V2へのポインタ。NULLで設定解除する。
AlternateDefaultCatalogFileLPCSTRinoptional代替の既定カタログファイル名(ANSI)。NULL可。

戻り値の型: BOOL

各言語での呼び出し定義

// SETUPAPI.dll  (ANSI / -A)
#include <windows.h>

BOOL SetupSetFileQueueAlternatePlatformA(
    void* QueueHandle,
    SP_ALTPLATFORM_INFO_V2* AlternatePlatformInfo,   // optional
    LPCSTR AlternateDefaultCatalogFile   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetupSetFileQueueAlternatePlatformA(
    IntPtr QueueHandle,   // void*
    IntPtr AlternatePlatformInfo,   // SP_ALTPLATFORM_INFO_V2* optional
    [MarshalAs(UnmanagedType.LPStr)] string AlternateDefaultCatalogFile   // LPCSTR optional
);
<DllImport("SETUPAPI.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupSetFileQueueAlternatePlatformA(
    QueueHandle As IntPtr,   ' void*
    AlternatePlatformInfo As IntPtr,   ' SP_ALTPLATFORM_INFO_V2* optional
    <MarshalAs(UnmanagedType.LPStr)> AlternateDefaultCatalogFile As String   ' LPCSTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' QueueHandle : void*
' AlternatePlatformInfo : SP_ALTPLATFORM_INFO_V2* optional
' AlternateDefaultCatalogFile : LPCSTR optional
Declare PtrSafe Function SetupSetFileQueueAlternatePlatformA Lib "setupapi" ( _
    ByVal QueueHandle As LongPtr, _
    ByVal AlternatePlatformInfo As LongPtr, _
    ByVal AlternateDefaultCatalogFile As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetupSetFileQueueAlternatePlatformA = ctypes.windll.setupapi.SetupSetFileQueueAlternatePlatformA
SetupSetFileQueueAlternatePlatformA.restype = wintypes.BOOL
SetupSetFileQueueAlternatePlatformA.argtypes = [
    ctypes.POINTER(None),  # QueueHandle : void*
    ctypes.c_void_p,  # AlternatePlatformInfo : SP_ALTPLATFORM_INFO_V2* optional
    wintypes.LPCSTR,  # AlternateDefaultCatalogFile : LPCSTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupSetFileQueueAlternatePlatformA = Fiddle::Function.new(
  lib['SetupSetFileQueueAlternatePlatformA'],
  [
    Fiddle::TYPE_VOIDP,  # QueueHandle : void*
    Fiddle::TYPE_VOIDP,  # AlternatePlatformInfo : SP_ALTPLATFORM_INFO_V2* optional
    Fiddle::TYPE_VOIDP,  # AlternateDefaultCatalogFile : LPCSTR optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "setupapi")]
extern "system" {
    fn SetupSetFileQueueAlternatePlatformA(
        QueueHandle: *mut (),  // void*
        AlternatePlatformInfo: *mut SP_ALTPLATFORM_INFO_V2,  // SP_ALTPLATFORM_INFO_V2* optional
        AlternateDefaultCatalogFile: *const u8  // LPCSTR optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool SetupSetFileQueueAlternatePlatformA(IntPtr QueueHandle, IntPtr AlternatePlatformInfo, [MarshalAs(UnmanagedType.LPStr)] string AlternateDefaultCatalogFile);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupSetFileQueueAlternatePlatformA' -Namespace Win32 -PassThru
# $api::SetupSetFileQueueAlternatePlatformA(QueueHandle, AlternatePlatformInfo, AlternateDefaultCatalogFile)
#uselib "SETUPAPI.dll"
#func global SetupSetFileQueueAlternatePlatformA "SetupSetFileQueueAlternatePlatformA" sptr, sptr, sptr
; SetupSetFileQueueAlternatePlatformA QueueHandle, varptr(AlternatePlatformInfo), AlternateDefaultCatalogFile   ; 戻り値は stat
; QueueHandle : void* -> "sptr"
; AlternatePlatformInfo : SP_ALTPLATFORM_INFO_V2* optional -> "sptr"
; AlternateDefaultCatalogFile : LPCSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "SETUPAPI.dll"
#cfunc global SetupSetFileQueueAlternatePlatformA "SetupSetFileQueueAlternatePlatformA" sptr, var, str
; res = SetupSetFileQueueAlternatePlatformA(QueueHandle, AlternatePlatformInfo, AlternateDefaultCatalogFile)
; QueueHandle : void* -> "sptr"
; AlternatePlatformInfo : SP_ALTPLATFORM_INFO_V2* optional -> "var"
; AlternateDefaultCatalogFile : LPCSTR optional -> "str"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; BOOL SetupSetFileQueueAlternatePlatformA(void* QueueHandle, SP_ALTPLATFORM_INFO_V2* AlternatePlatformInfo, LPCSTR AlternateDefaultCatalogFile)
#uselib "SETUPAPI.dll"
#cfunc global SetupSetFileQueueAlternatePlatformA "SetupSetFileQueueAlternatePlatformA" intptr, var, str
; res = SetupSetFileQueueAlternatePlatformA(QueueHandle, AlternatePlatformInfo, AlternateDefaultCatalogFile)
; QueueHandle : void* -> "intptr"
; AlternatePlatformInfo : SP_ALTPLATFORM_INFO_V2* optional -> "var"
; AlternateDefaultCatalogFile : LPCSTR optional -> "str"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupSetFileQueueAlternatePlatformA = setupapi.NewProc("SetupSetFileQueueAlternatePlatformA")
)

// QueueHandle (void*), AlternatePlatformInfo (SP_ALTPLATFORM_INFO_V2* optional), AlternateDefaultCatalogFile (LPCSTR optional)
r1, _, err := procSetupSetFileQueueAlternatePlatformA.Call(
	uintptr(QueueHandle),
	uintptr(AlternatePlatformInfo),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(AlternateDefaultCatalogFile))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetupSetFileQueueAlternatePlatformA(
  QueueHandle: Pointer;   // void*
  AlternatePlatformInfo: Pointer;   // SP_ALTPLATFORM_INFO_V2* optional
  AlternateDefaultCatalogFile: PAnsiChar   // LPCSTR optional
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupSetFileQueueAlternatePlatformA';
result := DllCall("SETUPAPI\SetupSetFileQueueAlternatePlatformA"
    , "Ptr", QueueHandle   ; void*
    , "Ptr", AlternatePlatformInfo   ; SP_ALTPLATFORM_INFO_V2* optional
    , "AStr", AlternateDefaultCatalogFile   ; LPCSTR optional
    , "Int")   ; return: BOOL
●SetupSetFileQueueAlternatePlatformA(QueueHandle, AlternatePlatformInfo, AlternateDefaultCatalogFile) = DLL("SETUPAPI.dll", "bool SetupSetFileQueueAlternatePlatformA(void*, void*, char*)")
# 呼び出し: SetupSetFileQueueAlternatePlatformA(QueueHandle, AlternatePlatformInfo, AlternateDefaultCatalogFile)
# QueueHandle : void* -> "void*"
# AlternatePlatformInfo : SP_ALTPLATFORM_INFO_V2* optional -> "void*"
# AlternateDefaultCatalogFile : LPCSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "setupapi" fn SetupSetFileQueueAlternatePlatformA(
    QueueHandle: ?*anyopaque, // void*
    AlternatePlatformInfo: [*c]SP_ALTPLATFORM_INFO_V2, // SP_ALTPLATFORM_INFO_V2* optional
    AlternateDefaultCatalogFile: [*c]const u8 // LPCSTR optional
) callconv(std.os.windows.WINAPI) i32;
proc SetupSetFileQueueAlternatePlatformA(
    QueueHandle: pointer,  # void*
    AlternatePlatformInfo: ptr SP_ALTPLATFORM_INFO_V2,  # SP_ALTPLATFORM_INFO_V2* optional
    AlternateDefaultCatalogFile: cstring  # LPCSTR optional
): int32 {.importc: "SetupSetFileQueueAlternatePlatformA", stdcall, dynlib: "SETUPAPI.dll".}
pragma(lib, "setupapi");
extern(Windows)
int SetupSetFileQueueAlternatePlatformA(
    void* QueueHandle,   // void*
    SP_ALTPLATFORM_INFO_V2* AlternatePlatformInfo,   // SP_ALTPLATFORM_INFO_V2* optional
    const(char)* AlternateDefaultCatalogFile   // LPCSTR optional
);
ccall((:SetupSetFileQueueAlternatePlatformA, "SETUPAPI.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{SP_ALTPLATFORM_INFO_V2}, Cstring),
      QueueHandle, AlternatePlatformInfo, AlternateDefaultCatalogFile)
# QueueHandle : void* -> Ptr{Cvoid}
# AlternatePlatformInfo : SP_ALTPLATFORM_INFO_V2* optional -> Ptr{SP_ALTPLATFORM_INFO_V2}
# AlternateDefaultCatalogFile : LPCSTR optional -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetupSetFileQueueAlternatePlatformA(
    void* QueueHandle,
    void* AlternatePlatformInfo,
    const char* AlternateDefaultCatalogFile);
]]
local setupapi = ffi.load("setupapi")
-- setupapi.SetupSetFileQueueAlternatePlatformA(QueueHandle, AlternatePlatformInfo, AlternateDefaultCatalogFile)
-- QueueHandle : void*
-- AlternatePlatformInfo : SP_ALTPLATFORM_INFO_V2* optional
-- AlternateDefaultCatalogFile : LPCSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SETUPAPI.dll');
const SetupSetFileQueueAlternatePlatformA = lib.func('__stdcall', 'SetupSetFileQueueAlternatePlatformA', 'int32_t', ['void *', 'void *', 'str']);
// SetupSetFileQueueAlternatePlatformA(QueueHandle, AlternatePlatformInfo, AlternateDefaultCatalogFile)
// QueueHandle : void* -> 'void *'
// AlternatePlatformInfo : SP_ALTPLATFORM_INFO_V2* optional -> 'void *'
// AlternateDefaultCatalogFile : LPCSTR optional -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SETUPAPI.dll", {
  SetupSetFileQueueAlternatePlatformA: { parameters: ["pointer", "pointer", "buffer"], result: "i32" },
});
// lib.symbols.SetupSetFileQueueAlternatePlatformA(QueueHandle, AlternatePlatformInfo, AlternateDefaultCatalogFile)
// QueueHandle : void* -> "pointer"
// AlternatePlatformInfo : SP_ALTPLATFORM_INFO_V2* optional -> "pointer"
// AlternateDefaultCatalogFile : LPCSTR optional -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetupSetFileQueueAlternatePlatformA(
    void* QueueHandle,
    void* AlternatePlatformInfo,
    const char* AlternateDefaultCatalogFile);
C, "SETUPAPI.dll");
// $ffi->SetupSetFileQueueAlternatePlatformA(QueueHandle, AlternatePlatformInfo, AlternateDefaultCatalogFile);
// QueueHandle : void*
// AlternatePlatformInfo : SP_ALTPLATFORM_INFO_V2* optional
// AlternateDefaultCatalogFile : LPCSTR 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.ASCII_OPTIONS);
    boolean SetupSetFileQueueAlternatePlatformA(
        Pointer QueueHandle,   // void*
        Pointer AlternatePlatformInfo,   // SP_ALTPLATFORM_INFO_V2* optional
        String AlternateDefaultCatalogFile   // LPCSTR optional
    );
}
@[Link("setupapi")]
lib LibSETUPAPI
  fun SetupSetFileQueueAlternatePlatformA = SetupSetFileQueueAlternatePlatformA(
    QueueHandle : Void*,   # void*
    AlternatePlatformInfo : SP_ALTPLATFORM_INFO_V2*,   # SP_ALTPLATFORM_INFO_V2* optional
    AlternateDefaultCatalogFile : UInt8*   # LPCSTR optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetupSetFileQueueAlternatePlatformANative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Utf8>);
typedef SetupSetFileQueueAlternatePlatformADart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Utf8>);
final SetupSetFileQueueAlternatePlatformA = DynamicLibrary.open('SETUPAPI.dll')
    .lookupFunction<SetupSetFileQueueAlternatePlatformANative, SetupSetFileQueueAlternatePlatformADart>('SetupSetFileQueueAlternatePlatformA');
// QueueHandle : void* -> Pointer<Void>
// AlternatePlatformInfo : SP_ALTPLATFORM_INFO_V2* optional -> Pointer<Void>
// AlternateDefaultCatalogFile : LPCSTR optional -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetupSetFileQueueAlternatePlatformA(
  QueueHandle: Pointer;   // void*
  AlternatePlatformInfo: Pointer;   // SP_ALTPLATFORM_INFO_V2* optional
  AlternateDefaultCatalogFile: PAnsiChar   // LPCSTR optional
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupSetFileQueueAlternatePlatformA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetupSetFileQueueAlternatePlatformA"
  c_SetupSetFileQueueAlternatePlatformA :: Ptr () -> Ptr () -> CString -> IO CInt
-- QueueHandle : void* -> Ptr ()
-- AlternatePlatformInfo : SP_ALTPLATFORM_INFO_V2* optional -> Ptr ()
-- AlternateDefaultCatalogFile : LPCSTR optional -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setupsetfilequeuealternateplatforma =
  foreign "SetupSetFileQueueAlternatePlatformA"
    ((ptr void) @-> (ptr void) @-> string @-> returning int32_t)
(* QueueHandle : void* -> (ptr void) *)
(* AlternatePlatformInfo : SP_ALTPLATFORM_INFO_V2* optional -> (ptr void) *)
(* AlternateDefaultCatalogFile : LPCSTR optional -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library setupapi (t "SETUPAPI.dll"))
(cffi:use-foreign-library setupapi)

(cffi:defcfun ("SetupSetFileQueueAlternatePlatformA" setup-set-file-queue-alternate-platform-a :convention :stdcall) :int32
  (queue-handle :pointer)   ; void*
  (alternate-platform-info :pointer)   ; SP_ALTPLATFORM_INFO_V2* optional
  (alternate-default-catalog-file :string))   ; LPCSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetupSetFileQueueAlternatePlatformA = Win32::API::More->new('SETUPAPI',
    'BOOL SetupSetFileQueueAlternatePlatformA(LPVOID QueueHandle, LPVOID AlternatePlatformInfo, LPCSTR AlternateDefaultCatalogFile)');
# my $ret = $SetupSetFileQueueAlternatePlatformA->Call($QueueHandle, $AlternatePlatformInfo, $AlternateDefaultCatalogFile);
# QueueHandle : void* -> LPVOID
# AlternatePlatformInfo : SP_ALTPLATFORM_INFO_V2* optional -> LPVOID
# AlternateDefaultCatalogFile : LPCSTR optional -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型