MAPI Interfaces
Applies to: Office 2010 | Outlook 2010 | Visual Studio
The documentation for each interface consists of an introductory section that includes a brief description of the interface's purpose followed by a table that contains the following information.
Header file: |
The header file where the interface is defined and that must be included when you compile your source code. |
Exposed by: |
The object that exposes the interface. |
Implemented by: |
A list of the components that provide an implementation of the interface. |
Called by: |
A list of the components that typically call the methods of the interface. |
Interface identifier: |
The interface identifier GUID. |
Pointer type: |
The pointer type for the object that exposes the interface. |
Transaction model: |
For interfaces derived from IMAPIProp. If nontransacted, changes take effect immediately; if transacted, changes do not take effect until IMAPIProp::SaveChanges is called. |
Following the first table is another table that lists all the methods of this interface in vtable order. A vtable is an array of function pointers created by the compiler containing one function pointer for each method of a MAPI object. The methods are listed in the same order that they are declared. Methods inherited from other interfaces are not shown in the Vtable Order table but can be used in the same way as documented in the interface that defines them.
After each interface topic, the interface's methods are then documented in alphabetical order. For each method, the documentation includes a brief purpose statement, a syntax block, and the following information.
Heading |
Content |
|---|---|
Parameters |
A description of each parameter in the method. |
Return Value |
A description of the unique values that the method can return. These are the values that callers should check for in their code. |
Remarks |
A description of why and how the method is used. |
See Also |
Cross-references to other topics in this Reference. |