MAPI
Interfaces
The
documentation for each interface consists of an introductory section that
includes a brief description of the interface s purpose followed by a Quick
Info table, which 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. |
|
Corresponding
pointer type: |
The pointer
type for the object that exposes the interface. |
|
Transaction
model: |
If
non-transacted, changes take effect immediately; if transacted, changes do
not take effect until SaveChanges is called. |
Following the
Quick Info 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.
Following the
Vtable Order table, the interface s methods are then covered in alphabetical
order. For each method, the documentation includes a brief purpose statement
for the method and its syntax followed by this information:
|
Heading |
Content |
|
Parameters |
A
description of each parameter in the method. |
|
Return
Values |
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 the MAPI Programmer s Reference. |