IMSProvider::SpoolerLogonIMSProvider::SpoolerLogon

適用されます: OutlookApplies to: Outlook

メッセージ ストアに、MAPI スプーラーをログに記録します。Logs the MAPI spooler on to a message store.

HRESULT SpoolerLogon(
  LPMAPISUP lpMAPISup,
  ULONG_PTR ulUIParam,
  LPSTR lpszProfileName,
  ULONG cbEntryID,
  LPENTRYID lpEntryID,
  ULONG ulFlags,
  LPCIID lpInterface,
  ULONG cbSpoolSecurity,
  LPBYTE lpbSpoolSecurity,
  LPMAPIERROR FAR * lppMAPIError,
  LPMSLOGON FAR * lppMSLogon,
  LPMDB FAR * lppMDB     
);

ParametersParameters

lpMAPISuplpMAPISup

[in]MAPI へのポインターは、メッセージ ・ ストアのオブジェクトをサポートします。[in] A pointer to the MAPI support object for the message store.

ulUIParamulUIParam

[in]ダイアログ ボックスまたはウィンドウの親ウィンドウへのハンドルを表示します。[in] A handle to the parent window of any dialog boxes or windows this method displays.

lpszProfileNamelpszProfileName

[in]MAPI スプーラーのログオンに使用されているプロファイルの名前を含む文字列へのポインター。[in] A pointer to a string that contains the name of the profile being used for the MAPI spooler logon. この文字列のダイアログ ボックスに表示される、ログ ファイルに書き出されます。 または単に無視されます。This string can be displayed in dialog boxes, written out to a log file, or simply ignored. _UlFlags_パラメーターに MAPI_UNICODE フラグが設定されている場合は、Unicode 形式である必要があります。It must be in Unicode format if the MAPI_UNICODE flag is set in the ulFlags parameter.

cbEntryIDcbEntryID

[in]_LpEntryID_パラメーターで指定されたエントリの識別子のバイト単位のサイズです。[in] The size, in bytes, of the entry identifier pointed to by the lpEntryID parameter.

lpEntryIDlpEntryID

[in]メッセージ ・ ストアのエントリの識別子へのポインター。[in] A pointer to the entry identifier for the message store. _LpEntryID_パラメーターに NULL を渡すことは、メッセージ ストアが選択されていないと、メッセージ ストアを選択するユーザーを有効にする] ダイアログ ボックスを表示できることを示します。Passing NULL in the lpEntryID parameter indicates that a message store has not yet been selected and that dialog boxes that enable the user to select a message store can be presented.

ulFlagsulFlags

[in]ログオンを実行する方法を制御するフラグのビットマスクです。[in] A bitmask of flags that controls how the logon is performed. 次のフラグを設定することができます。The following flags can be set:

MAPI_DEFERRED_ERRORSMAPI_DEFERRED_ERRORS

呼び出しは、基になるオブジェクトが呼び出し元の実装に使用可能でない場合でも、成功するために許可されています。The call is allowed to succeed even if the underlying object is not available to the calling implementation. オブジェクトが使用できない場合は、オブジェクトへの後続の呼び出しはエラーを発生させる可能性があります。If the object is not available, a subsequent call to the object might raise an error.

MAPI_UNICODEMAPI_UNICODE

渡された文字列は、Unicode 形式では。The passed-in strings are in Unicode format. MAPI_UNICODE が設定されていない場合は、ANSI 形式の文字列です。If MAPI_UNICODE is not set, the strings are in ANSI format.

MDB_NO_DIALOGMDB_NO_DIALOG

ログオン ダイアログ ボックスが表示できないようにします。Prevents the display of logon dialog boxes. このフラグが設定されている場合、ログオンが成功しない場合、エラー値 MAPI_E_LOGON_FAILED が返されます。If this flag is set, the error value MAPI_E_LOGON_FAILED is returned if the logon is unsuccessful. このフラグが設定されていない場合、メッセージ ストア プロバイダーはユーザー名またはパスワード、またはストアへの接続を確立するために必要な処理を実行するディスクを挿入するのにを修正するを求めることができます。If this flag is not set, the message store provider can prompt the user to correct a name or password, to insert a disk, or to perform other actions necessary to establish connection to the store.

MDB_WRITEMDB_WRITE

要求の読み取り/書き込みのアクセス許可Requests read/write permission.

lpInterfacelpInterface

[in]メッセージ ・ ストアへのログオン用のインターフェイス id (IID) へのポインター。[in] A pointer to the interface identifier (IID) for the message store to log on to. NULL を渡すには、メッセージ ・ ストア (IMsgStore) の MAPI インターフェイスが返されることを示します。Passing NULL indicates the MAPI interface for the message store (IMsgStore) is returned. などに対する (IID_IMAPIProp) は、メッセージ ストアの適切なインターフェイスの識別子を_lpInterface_パラメーターを設定することもできます。The lpInterface parameter can also be set to an identifier for an appropriate interface for the message store (for example IID_IUnknown or IID_IMAPIProp).

cbSpoolSecuritycbSpoolSecurity

[in]_LppbSpoolSecurity_パラメーターの検証データのバイト単位のサイズへのポインター。[in] A pointer to the size, in bytes, of validation data in the lppbSpoolSecurity parameter.

lpbSpoolSecuritylpbSpoolSecurity

[in]検証データへのポインターへのポインター。[in] A pointer to a pointer to validation data. SpoolerLogonメソッドでは、このデータを使用して、メッセージ ストア プロバイダーのIMSProvider::Logonメソッドを使用してログオンするのに以前と同じストアに、MAPI スプーラーをログに記録します。The SpoolerLogon method uses this data to log the MAPI spooler on to the same store as the message store provider previously logged on to by using the IMSProvider::Logon method.

lppMAPIErrorlppMAPIError

[out]返されたMAPIERROR構造体、存在する場合エラーが発生するバージョン、コンポーネント、およびコンテキストの情報が含まれているへのポインターへのポインター。[out] A pointer to a pointer to the returned MAPIERROR structure, if any, that contains version, component, and context information for an error. 取得するMAPIERROR構造体がない場合、 _lppMAPIError_パラメーターを NULL に設定できます。The lppMAPIError parameter can be set to NULL if there is no MAPIERROR structure to return.

lppMSLogonlppMSLogon

[out]メッセージへのポインターへのポインターでは、MAPI にログオンするためのログオン オブジェクトを格納します。[out] A pointer to the pointer to the message store logon object for MAPI to log on to.

lppMDBlppMDB

[out]メッセージへのポインターへのポインターでは、MAPI スプーラーとクライアント アプリケーションにログオンするためのオブジェクトを格納します。[out] A pointer to the pointer to the message store object for the MAPI spooler and client applications to log on to.

�߂�lReturn value

S_OKS_OK

�ʘb���������A�\�������l�܂��͒l���Ԃ���܂��BThe call succeeded and has returned the expected value or values.

MAPI_E_UNCONFIGUREDMAPI_E_UNCONFIGURED

プロファイルにログオンを完了するのに十分な情報が含まれていません。The profile does not contain enough information for the logon to complete. この値が返された場合は、MAPI メッセージ ストア プロバイダーのメッセージ サービスのエントリ ポイント関数を呼び出します。When this value is returned, MAPI calls the message store provider's message service entry point function.

MAPI_W_ERRORS_RETURNEDMAPI_W_ERRORS_RETURNED

呼び出しが成功したが、メッセージ ストア プロバイダーが使用可能なエラー情報を持ちます。The call succeeded, but the message store provider has error information available. この警告が返されると、呼び出しを成功として処理する必要があります。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. プロバイダーからエラー情報を取得するには、 IMAPISession::GetLastErrorメソッドを呼び出します。To get the error information from the provider, call the IMAPISession::GetLastError method.

備考Remarks

MAPI スプーラーでは、メッセージ ストアにログオンするためのIMSProvider::SpoolerLogonメソッドを呼び出します。The MAPI spooler calls the IMSProvider::SpoolerLogon method to log on to a message store. MAPI スプーラーは、中に、ログオンした後に、 _lppMDB_パラメーターでは、メッセージ ストア プロバイダーによって返されるメッセージのストア オブジェクトを使用してください。The MAPI spooler should use the message store object returned by the message store provider in the lppMDB parameter during and after logon.

IMSProvider::Logonメソッドを使用して、一貫性のプロバイダーは、 _lppMSLogon_パラメーターにもデータのメッセージ ストア ログオン オブジェクトを返します。For consistency with the IMSProvider::Logon method, the provider also returns a message store logon object in the lppMSLogon parameter. ストア オブジェクトとログオン オブジェクトの使用は同一の一般的なストア ログオンします。オブジェクトが 2 つのインターフェイスを公開する 1 つのオブジェクトであるかのように動作するよう、ログオン オブジェクトとストア オブジェクトとの間の 1 対 1 対応がかかることがあります。The use of the store object and the logon object are identical for usual store logon; there should be a one-to-one correspondence between the logon object and the store object such that the objects act as if they are one object that exposes two interfaces. 2 つのオブジェクトは、同時解放と連携して作成されます。The two objects are created together and freed together.

ストア プロバイダーは、ストアを MAPI スプーラーで使用されていることを示すために返されるメッセージのストア オブジェクトを内部的にマーク必要があります。The store provider should internally mark the returned message store object to indicate that the store is being used by the MAPI spooler. このストア オブジェクトのメソッドのいくつかがメッセージをクライアント アプリケーションに提供するオブジェクトを格納するいるとは異なる動作します。Some of the methods for this store object behave differently than for the message store object provided to client applications. この内部のマークを保持することは、MAPI スプーラーに固有の動作をトリガーする最も一般的な方法です。Keeping this internal mark is the most common way of triggering the behavior specific to the MAPI spooler.

関連項目See also

IMSProvider::LogonIMSProvider::Logon

MAPIERRORMAPIERROR

IMSProvider: IUnknownIMSProvider : IUnknown