HrAllocAdviseSinkHrAllocAdviseSink

適用されます: OutlookApplies to: Outlook

呼び出し元の実装とイベント通知が開始されるようにコールバック関数で指定されたコンテキストを指定、アドバイズ シンク オブジェクトを作成します。Creates an advise sink object, given a context specified by the calling implementation and a callback function to be triggered by an event notification.

ヘッダー ファイル:Header file:
Mapiutil.hMapiutil.h
によって実装されます。Implemented by:
MAPIMAPI
によって呼び出されます。Called by:
クライアント アプリケーションとサービス ・ プロバイダーClient applications and service providers
STDAPI HrAllocAdviseSink(
  LPNOTIFCALLBACK lpfnCallback,
  LPVOID lpvContext,
  LPMAPIADVISESINK FAR * lppAdviseSink
);

ParametersParameters

lpfnCallbacklpfnCallback

[in]MAPI は、新しく作成されたアドバイズ シンクに通知イベントが発生したときに呼び出されるNOTIFCALLBACKプロトタイプに基づいてコールバック関数へのポインター。[in] Pointer to a callback function based on the NOTIFCALLBACK prototype that MAPI is to call when a notification event occurs for the newly created advise sink.

lpvContextlpvContext

[in]呼び出し元のデータへのポインターは、MAPI では、それを呼び出すときに、コールバック関数に渡されます。[in] Pointer to caller data passed to the callback function when MAPI calls it. 呼び出し元のデータには、重要では、クライアント、またはプロバイダーにアドレスを表すことができます。The caller data can represent an address of significance to the client or provider. 通常、C++ コードでは、 _lpvContext_パラメーターのポインターを表しますオブジェクトのアドレスにします。Typically, for C++ code, the lpvContext parameter represents a pointer to the address of an object.

lppAdviseSinklppAdviseSink

[out]アドバイズ シンク オブジェクトへのポインターへのポインター。[out] Pointer to a pointer to an advise sink object.

Return valueReturn value

なし。None.

備考Remarks

HrAllocAdviseSink関数を使用するには、クライアント アプリケーションまたはサービス プロバイダーに通知を受け取るオブジェクトを作成、そのオブジェクトを使用するNOTIFCALLBACK関数のプロトタイプに基づく通知のコールバック関数を作成および_lpvContext_の値としてHrAllocAdviseSink関数内のオブジェクトへのポインターをパスします。To use the HrAllocAdviseSink function, a client application or service provider creates an object to receive notifications, creates a notification callback function based on the NOTIFCALLBACK function prototype that goes with that object, and passes a pointer to the object in the HrAllocAdviseSink function as the lpvContext value. 通知; を実行してこれを行う通知プロセスの一環としては、MAPI はコンテキストとオブジェクトへのポインターでコールバック関数を呼び出します。Doing so performs a notification; and as part of the notification process, MAPI calls the callback function with the object pointer as the context.

MAPI では、その通知エンジンを非同期的に実装します。MAPI implements its notification engine asynchronously. C++ では、通知コールバック オブジェクトのメソッドがあります。In C++, the notification callback can be an object method. 通知を生成するオブジェクトがクライアントに提供、または通知を要求するプロバイダーは、オブジェクトのためには、そのオブジェクトの個別の参照カウントを保つ必要があるではない場合は、シンクを案内します。If the object generating the notification is not present, the client or provider requesting notification must keep a separate reference count for that object for the object's advise sink.

注意事項

HrAllocAdviseSinkに限って使ってください。クライアント独自のアドバイズ シンクを作成することができます。HrAllocAdviseSink should be used sparingly; it is safer for clients to create their own advise sinks.