CoGetApartmentType

関数

現在のスレッドのアパートメント種別と修飾子を取得する。

DLLOLE32.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT CoGetApartmentType(
    APTTYPE* pAptType,
    APTTYPEQUALIFIER* pAptQualifier
);

パラメーター

名前	型	方向	説明
pAptType	APTTYPE*	out	現在のアパートメントの種類を指定する APTTYPE 列挙値です。
pAptQualifier	APTTYPEQUALIFIER*	out	現在のアパートメントの種類修飾子を指定する APTTYPEQUALIFIER 列挙値です。

戻り値の型: HRESULT

公式ドキュメント

現在のアパートメントの種類と種類修飾子を返します。

戻り値

呼び出しに成功した場合は S_OK を返します。それ以外の場合は、次のいずれかのエラーコードが返されます。

戻り値	説明
E_FAIL	現在のアパートメントの種類と種類修飾子を正常に取得できませんでした。
E_INVALIDARG	無効なパラメーター値が関数に渡されました。具体的には、一方または両方のパラメーターが呼び出し元によって NULL に設定されていました。
CO_E_NOTINITIALIZED	CoGetApartmentType を呼び出す前に、このスレッドで CoInitialize または CoInitializeEx が呼び出されていませんでした。

解説(Remarks)

Windows 7 より前の Windows プラットフォームでは、アパートメントの種類を照会するために、スレッド上で次の操作を行う必要があります。

CoGetContextToken を呼び出して、現在のコンテキストトークンを取得します。
コンテキストトークンを IUnknown* ポインターにキャストします。
そのポインターに対して QueryInterface メソッドを呼び出して、IComThreadingInfo インターフェイスを取得します。
IComThreadingInfo インターフェイスの GetCurrentApartmentType メソッドを呼び出して、現在のアパートメントの種類を取得します。

マルチスレッドのシナリオでは、上記の一連の操作を実行する際に、プロセス内でアクセス違反を引き起こす可能性のある競合状態が存在します。CoGetApartmentType 関数はアクセス違反を引き起こす可能性がないため、こちらの使用を推奨します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT CoGetApartmentType(
    APTTYPE* pAptType,
    APTTYPEQUALIFIER* pAptQualifier
);

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int CoGetApartmentType(
    out int pAptType,   // APTTYPE* out
    out int pAptQualifier   // APTTYPEQUALIFIER* out
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function CoGetApartmentType(
    <Out> ByRef pAptType As Integer,   ' APTTYPE* out
    <Out> ByRef pAptQualifier As Integer   ' APTTYPEQUALIFIER* out
) As Integer
End Function

' pAptType : APTTYPE* out
' pAptQualifier : APTTYPEQUALIFIER* out
Declare PtrSafe Function CoGetApartmentType Lib "ole32" ( _
    ByRef pAptType As Long, _
    ByRef pAptQualifier As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CoGetApartmentType = ctypes.windll.ole32.CoGetApartmentType
CoGetApartmentType.restype = ctypes.c_int
CoGetApartmentType.argtypes = [
    ctypes.c_void_p,  # pAptType : APTTYPE* out
    ctypes.c_void_p,  # pAptQualifier : APTTYPEQUALIFIER* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
CoGetApartmentType = Fiddle::Function.new(
  lib['CoGetApartmentType'],
  [
    Fiddle::TYPE_VOIDP,  # pAptType : APTTYPE* out
    Fiddle::TYPE_VOIDP,  # pAptQualifier : APTTYPEQUALIFIER* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ole32")]
extern "system" {
    fn CoGetApartmentType(
        pAptType: *mut i32,  // APTTYPE* out
        pAptQualifier: *mut i32  // APTTYPEQUALIFIER* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLE32.dll")]
public static extern int CoGetApartmentType(out int pAptType, out int pAptQualifier);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_CoGetApartmentType' -Namespace Win32 -PassThru
# $api::CoGetApartmentType(pAptType, pAptQualifier)

#uselib "OLE32.dll"
#func global CoGetApartmentType "CoGetApartmentType" sptr, sptr
; CoGetApartmentType varptr(pAptType), varptr(pAptQualifier)   ; 戻り値は stat
; pAptType : APTTYPE* out -> "sptr"
; pAptQualifier : APTTYPEQUALIFIER* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLE32.dll"
#cfunc global CoGetApartmentType "CoGetApartmentType" var, var
; res = CoGetApartmentType(pAptType, pAptQualifier)
; pAptType : APTTYPE* out -> "var"
; pAptQualifier : APTTYPEQUALIFIER* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLE32.dll"
#cfunc global CoGetApartmentType "CoGetApartmentType" sptr, sptr
; res = CoGetApartmentType(varptr(pAptType), varptr(pAptQualifier))
; pAptType : APTTYPE* out -> "sptr"
; pAptQualifier : APTTYPEQUALIFIER* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。