Key WRL APIs by Category

 

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

The latest version of this topic can be found at Key WRL APIs by Category.

The following tables list primary Windows Runtime C++ Template Library classes, structs, functions, and macros. Constructs in helper namespaces and classes are omitted. These lists augment the API documentation, which is arranged by namespace.

Classes

TitleDescription
ActivationFactory ClassEnables one or more classes to be activated by the Windows Runtime.
AsyncBase ClassImplements the Windows Runtime asynchronous state machine.
ClassFactory ClassImplements the basic functionality of the IClassFactory interface.
ComPtr ClassCreates a smart pointer type that represents the interface specified by the template parameter. ComPtr automatically maintains a reference count for the underlying interface pointer and releases the interface when the reference count goes to zero.
Event Class (Windows Runtime C++ Template Library)Represents an event.
EventSource ClassRepresents an event. EventSource member functions add, remove, and invoke event handlers.
FtmBase ClassRepresents a free-threaded marshaler object.
HandleT ClassRepresents a handle to an object.
HString ClassProvides support for manipulating HSTRING handles.
HStringReference ClassRepresents an HSTRING that is created from an existing string.
Module ClassRepresents a collection of related objects.
Module::GenericReleaseNotifier ClassInvokes an event handler when the last object in the current module is released. The event handler is specified by on a lambda, functor, or pointer-to-function.
Module::MethodReleaseNotifier ClassInvokes an event handler when the last object in the current module is released. The event handler is specified by an object and its pointer-to-a-method member.
Module::ReleaseNotifier ClassInvokes an event handler when the last object in a module is released.
RoInitializeWrapper ClassInitializes the Windows Runtime.
RuntimeClass ClassRepresents an instantiated class that inherits the specified number of interfaces, and provides the specified Windows Runtime, classic COM, and weak reference support.
SimpleActivationFactory ClassProvides a fundamental mechanism to create a Windows Runtime or classic COM base class.
SimpleClassFactory ClassProvides a fundamental mechanism to create a base class.
WeakRef ClassRepresents a weak reference that can be used by only the Windows Runtime, not classic COM. A weak reference represents an object that might or might not be accessible.

Structures

TitleDescription
ChainInterfaces StructureSpecifies verification and initialization functions that can be applied to a set of interface IDs.
CloakedIid StructureIndicates to the RuntimeClass, Implements and ChainInterfaces templates that the specified interface is not accessible in the IID list.
Implements StructureImplements QueryInterface and GetIid for the specified interfaces.
MixIn StructureEnsures that a runtime class derives from Windows Runtime interfaces, if any, and then classic COM interfaces.

Functions

TitleDescription
ActivateInstance FunctionRegisters and retrieves an instance of a specified type defined in a specified class ID.
AsWeak FunctionRetrieves a weak reference to a specified instance.
Callback FunctionCreates an object whose member function is a callback method.
CreateActivationFactory FunctionCreates a factory that produces instances of the specified class that can be activated by the Windows Runtime.
CreateClassFactory FunctionCreates a factory that produces instances of the specified class.
GetActivationFactory FunctionRetrieves an activation factory for the type specified by the template parameter.
Make FunctionInitializes the specified Windows Runtime class.

Macros

TitleDescription
ActivatableClass MacrosPopulates an internal cache that contains a factory that can create an instance of the specified class.
InspectableClass MacroSets the runtime class name and trust level.

Windows Runtime C++ Template Library (WRL)

Show: