IAddrBook::PrepareRecipsIAddrBook::PrepareRecips

適用されます: OutlookApplies to: Outlook

メッセージング システムによって後で使用できる受信者のリストを準備します。Prepares a recipient list for later use by the messaging system.

HRESULT PrepareRecips(
  ULONG ulFlags,
  LPSPropTagArray lpSPropTagArray,
  LPADRLIST lpRecipList
);

�p�����[�^�[Parameters

ulFlagsulFlags

[in]エントリを開く方法を制御するフラグのビットマスクです。[in] A bitmask of flags that controls how the entry is opened. 次のフラグを設定することができます。The following flag can be set:

MAPI_CACHE_ONLYMAPI_CACHE_ONLY

名前解決を実行するのにには、オフライン アドレス帳のみを使用します。Use only the offline address book to perform name resolution. たとえば、このフラグを使用すると、exchange キャッシュ モードでグローバル アドレス一覧 (GAL) を開くと、クライアントとサーバー間のトラフィックを作成することがなく、キャッシュからそのアドレス帳のエントリにアクセスするのにクライアント アプリケーションを許可します。For example, you can use this flag to allow a client application to open the global address list (GAL) in cached exchange mode and to access an entry in that address book from the cache without creating traffic between the client and the server. このフラグは、Exchange のアドレス帳プロバイダーでのみサポートします。This flag is supported only by the Exchange Address Book Provider.

lpSPropTagArraylpSPropTagArray

[in]更新する必要が存在する場合、プロパティを示すプロパティ タグの配列を含むSPropTagArray構造体へのポインター。[in] A pointer to an SPropTagArray structure that contains an array of property tags that indicate the properties, if any, that require updating. _LpSPropTagArray_パラメーターは NULL にできます。The lpSPropTagArray parameter can be NULL.

lpRecipListlpRecipList

[in]受信者のリストを格納するADRLIST構造体へのポインター。[in] A pointer to an ADRLIST structure that contains the list of recipients.

�߂�lReturn value

S_OKS_OK

宛先リストの準備ができました。The recipient list was successfully prepared.

備考Remarks

クライアントとサービス ・ プロバイダーは、以下を実行するPrepareRecipsメソッドを呼び出します。Clients and service providers call the PrepareRecips method to do the following:

  • _LpRecipList_パラメーター内のすべての受信者は、長期的なエントリの識別子であることを確認します。Ensure that all recipients in the lpRecipList parameter have long-term entry identifiers.

  • _LpRecipList_パラメーターでは、各受信者が、 _lpSPropTagArray_パラメーターに表示されるプロパティを持っていると、受信者の一覧の先頭にこれらのプロパティが表示されることを確認します。Ensure that each recipient in the lpRecipList parameter has the properties listed in the lpSPropTagArray parameter and that these properties appear at the start of the recipient list.

MAPI では、長期のエントリ id を各受信者の短期的なエントリの識別子に変換します。MAPI converts each recipient's short-term entry identifiers to long-term entry identifiers. 必要に応じて、適切なアドレス帳プロバイダーから受信者の長期のエントリ id を取得して、追加プロパティが要求されました。If necessary, recipients' long-term entry identifiers are retrieved from the appropriate address book provider and any additional properties are requested.

個々 の受信者エントリ、要求されたプロパティの順序は最初に、後に既にエントリが存在していたすべてのプロパティ。In an individual recipient entry, the requested properties are ordered first, followed by any properties that were already present for the entry. _LpSPropTagArray_パラメーターで要求されたプロパティのいずれかが適切なアドレス帳プロバイダーによって処理されない場合、そのプロパティの型が PT_ERROR に設定されます。If one or more of the requested properties in the lpSPropTagArray parameter are not handled by the appropriate address book provider, their property types will be set to PT_ERROR. プロパティ値は MAPI_E_NOT_FOUND または具体的な理由がなぜ [のプロパティは利用できませんが、別の値に設定されます。Their property values will be set to either to MAPI_E_NOT_FOUND or to another value that gives a more specific reason why the properties are not available. _LpRecipList_パラメーターに含まれる個々 のSPropValue構造体を個別に解放するためにMAPIAllocateBufferMAPIAllocateMore関数を使用して個別に割り当てる必要があります。Each SPropValue structure included in the lpRecipList parameter must be separately allocated by using the MAPIAllocateBuffer and MAPIAllocateMore functions so that it can be freed individually.

PT_ERROR 詳細については、プロパティの型を参照してください。For information about PT_ERROR, see Property Types.

関連項目See also

ADRLISTADRLIST

IMAPIProp::GetPropsIMAPIProp::GetProps

IMessage::ModifyRecipientsIMessage::ModifyRecipients

PidTagEntryId の標準的なプロパティPidTagEntryId Canonical Property

SPropValueSPropValue

SRowSetSRowSet

IAddrBook: IMAPIPropIAddrBook : IMAPIProp