xlAutoRemovexlAutoRemove

適用対象: Excel 2013 | Office 2013 | Visual StudioApplies to: Excel 2013 | Office 2013 | Visual Studio

ユーザーが Excel セッション中にアドイン マネージャーを使用して XLL を非アクティブ化すると、Excel によって呼び出されます。アドインがインストールされている状態で Excel セッションが終了するときには、正常終了でも異常終了でも、この関数は呼び出されません。Called by Microsoft Excel whenever the user deactivates the XLL during an Excel session by using the Add-In Manager. This function is not called when an Excel session closes, normally or abnormally, with the add-in installed.

たとえばこの関数を使用して、アドインが無効になっていることをユーザーに通知するカスタム ダイアログ ボックスを表示したり、レジストリの読み取りと書き込みを行ったりすることができます。This function can be used to display a custom dialog box telling the user that the add-in has been deactivated, or to read from or write to the registry, for example.

Excel では、これらの関数の実装とエクスポートに XLL は必要ありません。Excel does not require an XLL to implement and export this function.

int WINAPI xlAutoRemove(void);

パラメーターParameters

この関数に引数はありません。This function takes no arguments.

プロパティ値/戻り値Property Value/Return Value

この関数を実装する場合、1 (int) を返す必要があります。Your implementation of this function must return 1 (int).

注釈Remarks

アドイン マネージャーによってタスクが削除されたときに XLL がそのタスクを完了する必要がある場合は、この関数を使用します。Use this function if your XLL needs to complete any task when it is removed by the Add-In Manager.

Example

この関数の実装例については、\SAMPLES\EXAMPLE\EXAMPLE.C ファイルと \SAMPLES\GENERIC\GENERIC.C ファイルを参照してください。次のコードは、\SAMPLES\EXAMPLE\EXAMPLE.C から抜粋しています。See the files \SAMPLES\EXAMPLE\EXAMPLE.C and \SAMPLES\GENERIC\GENERIC.C for example implementations of this function. The following code is from \SAMPLES\EXAMPLE\EXAMPLE.C.

int WINAPI xlAutoRemove(void)
{
/* Display a dialog box indicating that the XLL was successfully removed */
   Excel12f(xlcAlert, 0, 2,
      TempStr12(L"Thank you for removing Example.XLL!"),
      TempInt12(2));
   return 1;
}

関連項目See also

xlAutoAddxlAutoAdd

アドイン マネージャーと XLL インターフェイス関数Add-in Manager and XLL Interface Functions