xlAutoAddxlAutoAdd

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

ユーザーが Excel セッション中にアドイン マネージャーを使用して XLL をアクティブ化するたびに、Microsoft Excel によって追加されます。Excel が起動して、あらかじめインストールされたアドインを読み込む際には、この関数は呼び出されません。Added by Microsoft Excel whenever the user activates the XLL during an Excel session by using the Add-In Manager. This function is not called when Excel starts up and loads a pre-installed add-in.

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

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

int WINAPI xlAutoAdd(void);

パラメーターParameters

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

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

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

注釈Remarks

アドイン マネージャーが任意のタスクを追加するときに、そのタスクを XLL が実行する必要がある場合は、この関数を使用します。Use this function if there is anything your XLL needs to do when it is added by the Add-In Manager.

Example

この関数の実装例については、\SAMPLES\EXAMPLE\EXAMPLE.C\SAMPLES\GENERIC\GENERIC.C を参照してください。次のコードは、\SAMPLES\EXAMPLE\EXAMPLE.C から抜粋しています。See \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 xlAutoAdd(void)
{
    XCHAR szBuf[255];
    wsprintfW((LPWSTR)szBuf, L"Thank you for adding Example.XLL\n"
            L"build date %hs, time %hs",__DATE__, __TIME__);
/* Display a dialog indicating that the XLL was successfully added */
    Excel12f(xlcAlert, 0, 2, TempStr12(szBuf), TempInt12(2));
    return 1;
}

関連項目See also

xlAutoRemovexlAutoRemove

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