IMAPIFormContainer::InstallFormIMAPIFormContainer::InstallForm

適用されます: OutlookApplies to: Outlook

フォーム ライブラリにフォームをインストールします。Installs a form into a form library.

HRESULT InstallForm(
  ULONG_PTR ulUIParam,
  ULONG ulFlags,
  LPCSTR szCfgPathName
);

ParametersParameters

ulUIParamulUIParam

[in]すべてのダイアログ ボックスの親ウィンドウまたはこのメソッドを表示するウィンドウへのハンドル。[in] A handle to the parent window of any dialog boxes or windows that this method displays. _UlUIParam_パラメーターは、クライアント アプリケーションは、 _ulFlags_パラメーターで MAPI_DIALOG フラグを設定しない限り、無視されます。The ulUIParam parameter is ignored unless the client application sets the MAPI_DIALOG flag in the ulFlags parameter. MAPI_DIALOG が渡されてもいない場合は、 _ulUIParam_パラメーターを NULL にできます。The ulUIParam parameter can be NULL if MAPI_DIALOG is not also passed.

ulFlagsulFlags

[in]フォームのインストールを制御するフラグのビットマスクです。[in] A bitmask of flags that controls the installation of the form. 次のフラグを設定することができます。The following flags can be set:

MAPI_DIALOGMAPI_DIALOG

進行状況情報を提供したり、詳細情報をユーザーに確認するダイアログ ボックスが表示されます。Displays a dialog box to provide progress information or prompt the user for more information. このフラグが設定されていない場合、ダイアログ ボックスは表示されません。If this flag is not set, no dialog box is displayed.

MAPI_UNICODEMAPI_UNICODE

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

MAPIFORM_INSTALL_OVERWRITEONCONFLICTMAPIFORM_INSTALL_OVERWRITEONCONFLICT

別のフォームによって、メッセージ クラスは、このフォームで処理するハンドルが既に存在する場合は、既存のフォームをこれと置き換えます。If another form already exists that handles the message class handled by this form, replace the existing form with this one. MAPI_DIALOG フラグが存在しても場合、このフラグは無視されます。This flag is ignored if the MAPI_DIALOG flag is also present.

szCfgPathNameszCfgPathName

[in]フォームの構成ファイルへのパス。[in] The path to the form's configuration file.

�߂�lReturn value

S_OKS_OK

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

MAPI_E_EXTENDED_ERRORMAPI_E_EXTENDED_ERROR

実装エラーが発生しました。An implementation error occurred. エラーに関連付けられているMAPIERROR構造体を取得するには、 IMAPIFormContainer::GetLastErrorメソッドを呼び出します。To get the MAPIERROR structure that is associated with the error, call the IMAPIFormContainer::GetLastError method.

MAPI_E_USER_CANCELMAPI_E_USER_CANCEL

ユーザー] ダイアログ ボックスで [キャンセル] ボタンをクリックすると、通常、フォームのインストールをキャンセルしました。The user canceled the installation of the form, typically by clicking the Cancel button in a dialog box.

実装者へのメモNotes to implementers

フォーム ライブラリのプロバイダーは、 MAPIERROR構造体を入力し、次の条件のいずれかが発生した場合は、MAPI_E_EXTENDED_ERROR を返す必要があります。Form library providers should fill in a MAPIERROR structure and return MAPI_E_EXTENDED_ERROR if any of the following conditions occur:

  • 構成ファイルが見つかりません。The configuration file is not found.

  • 構成ファイルを読み取ることができません。The configuration file is not readable.

  • 構成ファイルが有効ではありません。The configuration file is invalid.

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

クライアント アプリケーションは、フォームをフォームの特定のコンテナーにインストールするのにはIMAPIFormContainer::InstallFormメソッドを呼び出します。Client applications call the IMAPIFormContainer::InstallForm method to install a form into a specific form container. _SzCfgPathName_パラメーターには、フォーム構成ファイル (つまり、フォームとその実装を記述する .cfg ファイルの拡張子を持つファイルの場合) のパスが含まれている必要があります。The szCfgPathName parameter must contain the path of a form configuration file (that is, a file with the .cfg extension that describes the form and its implementation). _UlFlags_パラメーター内のフラグは、以下のいずれかを指定します。The flags in the ulFlags parameter specify the following:

  • MAPI_DIALOG フラグが設定されている場合は、ユーザー インターフェイスが表示されます、インストールの詳細を指定するフォームをインストールしているユーザーを有効にします。If the MAPI_DIALOG flag is set, a user interface is displayed, enabling the user who is installing the form to specify installation details.

  • MAPIFORM_INSTALL_OVERWRITEONCONFLICT フラグが設定されている場合は、同じメッセージ クラスのすべての前のフォームがインストールされているフォームに置き換えられます。If the MAPIFORM_INSTALL_OVERWRITEONCONFLICT flag is set, any previous form for the same message class is replaced with the form being installed. それ以外の場合、フォームのインストールは、存在する場合、現在のフォームの説明に統合されます。Otherwise, the form installation is merged with the current form description, if one exists.

  • MAPI_DIALOG が設定されている場合は、MAPIFORM_INSTALL_OVERWRITEONCONFLICT は無視されます。If MAPI_DIALOG is set, MAPIFORM_INSTALL_OVERWRITEONCONFLICT is ignored.

  • MAPIFORM_INSTALL_OVERWRITEONCONFLICT のフラグでない場合は、差し込み印刷が行われることを意味を設定します。The absence of MAPIFORM_INSTALL_OVERWRITEONCONFLICT in the flag set means that a merge will be done. .Cfg ファイルの現在のフォームの説明ではない新しいプラットフォームをインストールして、その他の変更は行われません。Any new platforms in the .cfg file that are not currently present in the form description will be installed and no other changes will occur.

  • フォーム構成ファイルのパスは、MAPI_UNICODE フラグが設定されている場合は、Unicode 文字列になります。If the MAPI_UNICODE flag is set, the path of the form configuration file is a Unicode string.

InstallFormは、MAPI_E_EXTENDED_ERROR を返し、エラーが発生した状態を判断するのには返されたMAPIERROR構造体をチェックする必要がある場合、クライアントはIMAPIFormContainer::GetLastErrorを呼び出す必要があります。Clients should call IMAPIFormContainer::GetLastError if InstallForm returns MAPI_E_EXTENDED_ERROR, and they should check the returned MAPIERROR structure to determine the condition that raised the error.

MFCMAPI 参照MFCMAPI reference

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

�t�@�C��File �֐�Function �R�����gComment
FormContainerDlg.cppFormContainerDlg.cpp
CFormContainerDlg::OnInstallFormCFormContainerDlg::OnInstallForm
MFCMAPI では、 IMAPIFormContainer::InstallFormメソッドを使用して、フォームのコンテナー内のフォームをインストールします。MFCMAPI uses the IMAPIFormContainer::InstallForm method to install a form in a form container.

関連項目See also

MAPIERRORMAPIERROR

IMAPIFormContainer: IUnknownIMAPIFormContainer : IUnknown

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