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

CoInstall

関数
指定したクラスに必要なコードをインストールする。
DLLOLE32.dll呼出規約winapi

シグネチャ

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

HRESULT CoInstall(
    IBindCtx* pbc,
    DWORD dwFlags,
    uCLSSPEC* pClassSpec,
    QUERYCONTEXT* pQuery,
    LPWSTR pszCodeBase
);

パラメーター

名前方向説明
pbcIBindCtx*in将来の使用のために予約されています。この値は NULL でなければなりません。
dwFlagsDWORDin将来の使用のために予約されています。この値は 0 でなければなりません。
pClassSpecuCLSSPEC*inuCLSSPEC 共用体へのポインターです。tyspec メンバーは TYSPEC_CLSID に設定し、clsid メンバーにはインストールする CLSID を設定する必要があります。詳細については、TYSPEC を参照してください。
pQueryQUERYCONTEXT*inQUERYCONTEXT 構造体へのポインターです。dwContext フィールドには目的の CLSCTX 値を設定する必要があります。詳細については、QUERYCONTEXT を参照してください。
pszCodeBaseLPWSTRin将来の使用のために予約されています。この値は NULL でなければなりません。

戻り値の型: HRESULT

公式ドキュメント

要求された COM サーバーアプリケーションをインストールします。

戻り値

この関数は標準的な戻り値 E_INVALIDARG に加えて、次の値を返します。

用語 説明
S_OK 成功を示します。
CS_E_PACKAGE_NOTFOUND pClassSpectyspec フィールドが TYSPEC_CLSID に設定されていませんでした。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT CoInstall(
    IBindCtx* pbc,
    DWORD dwFlags,
    uCLSSPEC* pClassSpec,
    QUERYCONTEXT* pQuery,
    LPWSTR pszCodeBase
);
[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int CoInstall(
    IntPtr pbc,   // IBindCtx*
    uint dwFlags,   // DWORD
    IntPtr pClassSpec,   // uCLSSPEC*
    IntPtr pQuery,   // QUERYCONTEXT*
    [MarshalAs(UnmanagedType.LPWStr)] string pszCodeBase   // LPWSTR
);
<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function CoInstall(
    pbc As IntPtr,   ' IBindCtx*
    dwFlags As UInteger,   ' DWORD
    pClassSpec As IntPtr,   ' uCLSSPEC*
    pQuery As IntPtr,   ' QUERYCONTEXT*
    <MarshalAs(UnmanagedType.LPWStr)> pszCodeBase As String   ' LPWSTR
) As Integer
End Function
' pbc : IBindCtx*
' dwFlags : DWORD
' pClassSpec : uCLSSPEC*
' pQuery : QUERYCONTEXT*
' pszCodeBase : LPWSTR
Declare PtrSafe Function CoInstall Lib "ole32" ( _
    ByVal pbc As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pClassSpec As LongPtr, _
    ByVal pQuery As LongPtr, _
    ByVal pszCodeBase As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CoInstall = ctypes.windll.ole32.CoInstall
CoInstall.restype = ctypes.c_int
CoInstall.argtypes = [
    ctypes.c_void_p,  # pbc : IBindCtx*
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # pClassSpec : uCLSSPEC*
    ctypes.c_void_p,  # pQuery : QUERYCONTEXT*
    wintypes.LPCWSTR,  # pszCodeBase : LPWSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
CoInstall = Fiddle::Function.new(
  lib['CoInstall'],
  [
    Fiddle::TYPE_VOIDP,  # pbc : IBindCtx*
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pClassSpec : uCLSSPEC*
    Fiddle::TYPE_VOIDP,  # pQuery : QUERYCONTEXT*
    Fiddle::TYPE_VOIDP,  # pszCodeBase : LPWSTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "ole32")]
extern "system" {
    fn CoInstall(
        pbc: *mut core::ffi::c_void,  // IBindCtx*
        dwFlags: u32,  // DWORD
        pClassSpec: *mut uCLSSPEC,  // uCLSSPEC*
        pQuery: *mut QUERYCONTEXT,  // QUERYCONTEXT*
        pszCodeBase: *mut u16  // LPWSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OLE32.dll")]
public static extern int CoInstall(IntPtr pbc, uint dwFlags, IntPtr pClassSpec, IntPtr pQuery, [MarshalAs(UnmanagedType.LPWStr)] string pszCodeBase);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_CoInstall' -Namespace Win32 -PassThru
# $api::CoInstall(pbc, dwFlags, pClassSpec, pQuery, pszCodeBase)
#uselib "OLE32.dll"
#func global CoInstall "CoInstall" sptr, sptr, sptr, sptr, sptr
; CoInstall pbc, dwFlags, varptr(pClassSpec), varptr(pQuery), pszCodeBase   ; 戻り値は stat
; pbc : IBindCtx* -> "sptr"
; dwFlags : DWORD -> "sptr"
; pClassSpec : uCLSSPEC* -> "sptr"
; pQuery : QUERYCONTEXT* -> "sptr"
; pszCodeBase : LPWSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "OLE32.dll"
#cfunc global CoInstall "CoInstall" sptr, int, var, var, wstr
; res = CoInstall(pbc, dwFlags, pClassSpec, pQuery, pszCodeBase)
; pbc : IBindCtx* -> "sptr"
; dwFlags : DWORD -> "int"
; pClassSpec : uCLSSPEC* -> "var"
; pQuery : QUERYCONTEXT* -> "var"
; pszCodeBase : LPWSTR -> "wstr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT CoInstall(IBindCtx* pbc, DWORD dwFlags, uCLSSPEC* pClassSpec, QUERYCONTEXT* pQuery, LPWSTR pszCodeBase)
#uselib "OLE32.dll"
#cfunc global CoInstall "CoInstall" intptr, int, var, var, wstr
; res = CoInstall(pbc, dwFlags, pClassSpec, pQuery, pszCodeBase)
; pbc : IBindCtx* -> "intptr"
; dwFlags : DWORD -> "int"
; pClassSpec : uCLSSPEC* -> "var"
; pQuery : QUERYCONTEXT* -> "var"
; pszCodeBase : LPWSTR -> "wstr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procCoInstall = ole32.NewProc("CoInstall")
)

// pbc (IBindCtx*), dwFlags (DWORD), pClassSpec (uCLSSPEC*), pQuery (QUERYCONTEXT*), pszCodeBase (LPWSTR)
r1, _, err := procCoInstall.Call(
	uintptr(pbc),
	uintptr(dwFlags),
	uintptr(pClassSpec),
	uintptr(pQuery),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszCodeBase))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function CoInstall(
  pbc: Pointer;   // IBindCtx*
  dwFlags: DWORD;   // DWORD
  pClassSpec: Pointer;   // uCLSSPEC*
  pQuery: Pointer;   // QUERYCONTEXT*
  pszCodeBase: PWideChar   // LPWSTR
): Integer; stdcall;
  external 'OLE32.dll' name 'CoInstall';
result := DllCall("OLE32\CoInstall"
    , "Ptr", pbc   ; IBindCtx*
    , "UInt", dwFlags   ; DWORD
    , "Ptr", pClassSpec   ; uCLSSPEC*
    , "Ptr", pQuery   ; QUERYCONTEXT*
    , "WStr", pszCodeBase   ; LPWSTR
    , "Int")   ; return: HRESULT
●CoInstall(pbc, dwFlags, pClassSpec, pQuery, pszCodeBase) = DLL("OLE32.dll", "int CoInstall(void*, dword, void*, void*, char*)")
# 呼び出し: CoInstall(pbc, dwFlags, pClassSpec, pQuery, pszCodeBase)
# pbc : IBindCtx* -> "void*"
# dwFlags : DWORD -> "dword"
# pClassSpec : uCLSSPEC* -> "void*"
# pQuery : QUERYCONTEXT* -> "void*"
# pszCodeBase : LPWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef CoInstallNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Void>, Pointer<Void>, Pointer<Utf16>);
typedef CoInstallDart = int Function(Pointer<Void>, int, Pointer<Void>, Pointer<Void>, Pointer<Utf16>);
final CoInstall = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<CoInstallNative, CoInstallDart>('CoInstall');
// pbc : IBindCtx* -> Pointer<Void>
// dwFlags : DWORD -> Uint32
// pClassSpec : uCLSSPEC* -> Pointer<Void>
// pQuery : QUERYCONTEXT* -> Pointer<Void>
// pszCodeBase : LPWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CoInstall(
  pbc: Pointer;   // IBindCtx*
  dwFlags: DWORD;   // DWORD
  pClassSpec: Pointer;   // uCLSSPEC*
  pQuery: Pointer;   // QUERYCONTEXT*
  pszCodeBase: PWideChar   // LPWSTR
): Integer; stdcall;
  external 'OLE32.dll' name 'CoInstall';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CoInstall"
  c_CoInstall :: Ptr () -> Word32 -> Ptr () -> Ptr () -> CWString -> IO Int32
-- pbc : IBindCtx* -> Ptr ()
-- dwFlags : DWORD -> Word32
-- pClassSpec : uCLSSPEC* -> Ptr ()
-- pQuery : QUERYCONTEXT* -> Ptr ()
-- pszCodeBase : LPWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let coinstall =
  foreign "CoInstall"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> (ptr uint16_t) @-> returning int32_t)
(* pbc : IBindCtx* -> (ptr void) *)
(* dwFlags : DWORD -> uint32_t *)
(* pClassSpec : uCLSSPEC* -> (ptr void) *)
(* pQuery : QUERYCONTEXT* -> (ptr void) *)
(* pszCodeBase : LPWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)

(cffi:defcfun ("CoInstall" co-install :convention :stdcall) :int32
  (pbc :pointer)   ; IBindCtx*
  (dw-flags :uint32)   ; DWORD
  (p-class-spec :pointer)   ; uCLSSPEC*
  (p-query :pointer)   ; QUERYCONTEXT*
  (psz-code-base (:string :encoding :utf-16le)))   ; LPWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CoInstall = Win32::API::More->new('OLE32',
    'int CoInstall(LPVOID pbc, DWORD dwFlags, LPVOID pClassSpec, LPVOID pQuery, LPCWSTR pszCodeBase)');
# my $ret = $CoInstall->Call($pbc, $dwFlags, $pClassSpec, $pQuery, $pszCodeBase);
# pbc : IBindCtx* -> LPVOID
# dwFlags : DWORD -> DWORD
# pClassSpec : uCLSSPEC* -> LPVOID
# pQuery : QUERYCONTEXT* -> LPVOID
# pszCodeBase : LPWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型