IAddrBook::GetDefaultDir
The IAddrBook::GetDefaultDir
method returns the entry identifier for the address book container that is
initially made available.
Quick Info
See IAddrBook
: IMAPIProp.
HRESULT GetDefaultDir(
|
ULONG FAR * lpcbEntryID, |
|
|
LPENTRYID FAR * lppEntryID |
|
|
) |
|
Parameters
lpcbEntryID
[out] Pointer
to the count of bytes in the entry identifier pointed to by the lppEntryID parameter.
lppEntryID
[out] Pointer
to a pointer to the entry identifier of the default container.
Return Values
S_OK
The entry
identifier of the default container was successfully returned.
Remarks
Client
applications and service providers call the IAddrBook::GetDefaultDir
method to retrieve the entry identifier of the default address book container.
The default container is what the user sees displayed in the address book when
the address book is first opened. If a default container has not been set by a
call to the IAddrBook::SetDefaultDir method, MAPI assigns as
the default container the first container with names that is not the Personal
Address Book (PAB). If such a container cannot be found, the PAB becomes the
default container.
To set the
default directory, a client or provider calls the IAddrBook::SetDefaultDir
method. Clients and providers need not call the IMAPIProp::SaveChanges method; because changes to
the address book are not transacted, changes are immediately made permanent.
See Also