IAddrBook::SetPAB

The IAddrBook::SetPAB method designates a particular container to be the personal address book (PAB).

Quick Info

See IAddrBook : IMAPIProp.

HRESULT SetPAB(
  ULONG cbEntryID,     
  LPENTRYID lpEntryID  
);
 

Parameters

cbEntryID

[in] Count of bytes in the entry identifier pointed to by the lpEntryID parameter.

lpEntryID

[in] Pointer to the entry identifier of the container to be designated as the PAB. The lpEntryID parameter cannot be NULL.

Return Values

S_OK

The specified container has been established as the PAB.

Remarks

Clients and service providers call the IAddrBook::SetPAB method to designate a particular container to be the PAB. The PAB is a container that is made up of entries copied from other containers as well as new entries.

Because information about the PAB is written in the profile, a particular container can be the PAB for multiple sessions. A call to SetPAB establishes a container as the PAB until that container is made unavailable or a new container becomes the PAB through a subsequent call to SetPAB.

Clients and providers need not call the IMAPIProp::SaveChanges method to make the PAB change permanent.

See Also

IAddrBook::GetPAB, IAddrBook::GetSearchPath, PR_CONTAINER_FLAGS