Edit

Share via

GetCurrentApartmentType function

  • Article

Retrieves the type of apartment in which the caller is executing.

Note

This API is for internal use only. It's not intended for use from developer code.

Syntax

HRESULT GetCurrentApartmentType (
   [in] int                   vFunc,
   [in] IComThreadingInfo*    ptr,
   [out] APTTYPE*             aptType
);

Parameters

vFunc
[in] This parameter is unused.

ptr
[in] A pointer to an IComThreadingInfo instance.

aptType
[out] A pointer to an APTTYPE enumeration value that indicates the caller's apartment.

Return value

Constant Value Description
S_OK 0 The function completed successfully.
E_FAIL 0x80000008 The caller is not executing in an apartment.

Remarks

This function wraps a call to the IComThreadingInfo::GetCurrentApartmentType method.

Requirements

Platforms: See System Requirements.

Header: WMINet_Utils.idl

.NET Framework Versions: Available since 4.7.2

See also