IMAPISession::OpenAddressBookIMAPISession::OpenAddressBook

適用されます: OutlookApplies to: Outlook

さらにアクセスするためのIAddrBookポインターを返す MAPI 統合アドレス帳を開きます。Opens the MAPI integrated address book, returning an IAddrBook pointer for further access.

HRESULT OpenAddressBook(
  ULONG_PTR ulUIParam,
  LPCIID lpInterface,
  ULONG ulFlags,
  LPADRBOOK FAR * lppAdrBook
);

ParametersParameters

ulUIParamulUIParam

[in]表示に関連して、共通のアドレス] ダイアログ ボックスおよびその他の親ウィンドウへのハンドル。[in] A handle to the parent window of the common address dialog box and other related displays.

lpInterfacelpInterface

[in]アドレス帳にアクセスするためのインターフェイスを表すインターフェイス識別子 (IID) へのポインター。[in] A pointer to the interface identifier (IID) that represents the interface to be used to access the address book. アドレス帳の標準的なインターフェイスへのポインターを返しますnullを渡すIAddrBook: IMAPIPropPassing null returns a pointer to the address book's standard interface, IAddrBook : IMAPIProp.

ulFlagsulFlags

[in]アドレス帳の開始を制御するフラグのビットマスクです。[in] A bitmask of flags that controls the opening of the address book. 次のフラグを設定することができます。The following flag can be set:

AB_NO_DIALOGAB_NO_DIALOG

ダイアログ ボックスの表示を抑制します。Suppresses the display of dialog boxes. AB_NO_DIALOG フラグが設定されていない場合内蔵のアドレス帳に寄与するアドレス帳プロバイダーで必要な情報がないユーザーに確認することができます。If the AB_NO_DIALOG flag is not set, the address book providers that contribute to the integrated address book can prompt the user for any necessary information.

lppAdrBooklppAdrBook

[out]アドレス帳へのポインターへのポインター。[out] A pointer to a pointer to the address book.

�߂�lReturn value

S_OKS_OK

アドレス帳が正常に開かれました。The address book was successfully opened.

MAPI_W_ERRORS_RETURNEDMAPI_W_ERRORS_RETURNED

呼び出しが成功したが、1 つまたは複数のアドレス帳プロバイダーのコンテナーを開くことができませんでした。The call succeeded, but the containers of one or more address book providers could not be opened. この警告が返されると、呼び出しを成功として処理する必要があります。When this warning is returned, the call should be handled as successful. この警告をテストするには、 HR_FAILEDマクロを使用します。To test for this warning, use the HR_FAILED macro. 詳細については、エラーを処理するためのマクロの使用を参照してください。For more information, see Using Macros for Error Handling.

備考Remarks

IMAPISession::OpenAddressBookメソッドでは、MAPI の統合のアドレス帳をプロファイル内のアドレス帳プロバイダーのすべての最上位のコンテナーのコレクションを開きます。The IMAPISession::OpenAddressBook method opens the MAPI integrated address book, a collection of the top-level containers of all of the address book providers in the profile. _LppAdrBook_パラメーターで返されるポインターをアドレス帳の内容へのアクセスをさらに提供します。The pointer that is returned in the lppAdrBook parameter provides further access to the contents of the address book. これにより、個々 のコンテナーを開き、メッセージング ユーザーの検索、および共通のアドレス] ダイアログ ボックスを表示するなどのタスクを実行する呼び出し元です。This allows the caller to perform tasks such as opening individual containers, finding messaging users, and displaying common address dialog boxes.

呼び出し側への注意Notes to callers

OpenAddressBookは、1 つまたは複数のプロファイルで、アドレス帳プロバイダーをロードすることがある場合に MAPI_W_ERRORS_RETURNED を返します。OpenAddressBook returns MAPI_W_ERRORS_RETURNED if it cannot load one or more of the address book providers in the profile. この値は、警告が表示されないエラーの値です。S_OK の場合と同様に処理します。This value is a warning, not an error value; handle it as you would S_OK. OpenAddressBookは、常に読み込みに失敗をアドレス帳プロバイダーの数に関係なく、 _lppAdrBook_パラメーターに有効なポインターを返します。OpenAddressBook always returns a valid pointer in the lppAdrBook parameter, regardless of how many of the address book providers failed to load. そのため、常にメソッドを呼び出してください、アドレス帳ある時点でログオフする前にします。Therefore, you must always call the address book's IUnknown::Release method at some point before logging off.

OpenAddressBookに MAPI_W_ERRORS_RETURNED が返されるときは、障害のあるプロバイダーに関する情報を格納するMAPIERROR構造体を取得するのにはIMAPISession::GetLastErrorを呼び出します。When OpenAddressBook returns MAPI_W_ERRORS_RETURNED, call IMAPISession::GetLastError to obtain a MAPIERROR structure that contains information about the failing providers. すべてのプロバイダーから提供された情報が含まれる 1 つのMAPIERROR構造体が返されます。A single MAPIERROR structure is returned that contains information supplied by all of the providers.

MFCMAPI 参照MFCMAPI reference

MFCMAPI �T���v�� �R�[�h�ł́A���̕\��Q�Ƃ��Ă��������BFor MFCMAPI sample code, see the following table.

�t�@�C��File �֐�Function �R�����gComment
MAPIObjects.cppMAPIObjects.cpp
CMapiObjects::GetAddrBookCMapiObjects::GetAddrBook
MFCMAPI では、 IMAPISession::OpenAddressBookメソッドを使用して、内蔵のアドレス帳を取得します。MFCMAPI uses the IMAPISession::OpenAddressBook method to obtain the integrated address book.

関連項目See also

IAddrBook: IMAPIPropIAddrBook : IMAPIProp

IMAPISession::GetLastErrorIMAPISession::GetLastError

MAPIERRORMAPIERROR

IMAPISession: IUnknownIMAPISession : IUnknown

[�R��h �T���v���Ƃ��� MFCMAPIMFCMAPI as a Code Sample