共用方式為

IDesktopGadget：：RunGadget 方法 (shobjidl.h)

  • 發行項

將已安裝的小工具新增至桌面。

語法

HRESULT RunGadget(
  [in] LPCWSTR gadgetPath
);

參數

[in] gadgetPath

類型： LPCWSTR

.) 資料夾完整 (絕對) 路徑的指標。 未使用 Windows 封裝的小工具只能從下列兩個位置的其中一個執行。 在任何其他位置安裝小工具會導致此方法失敗，併發生拒絕存取錯誤。

注意 此路徑不應包含環境變數;必須提供完整展開的路徑。 ExpandEnvironmentStrings 可用來展開此參數中所需表單的路徑。
 

(%ProgramFiles%\Windows 側邊欄\共用小工具)

這是非 Microsoft 小工具安裝的建議路徑，可供所有使用者使用。

(%LOCALAPPDATA%\Microsoft\Windows 側邊欄\小工具)

這個位置應該用於單一使用者安裝小工具。

傳回值

類型： HRESULT

如果成功，則傳回S_OK，否則傳回錯誤值，包括下列專案：

傳回碼 描述
SCHED_E_ALREADY_RUNNING
 小工具已在執行中。
E_INVALIDARG
 發生錯誤，其中牽涉到一些小工具資料夾所指向的路徑。

備註

此處的「執行中」一個小工具表示該小工具已新增至桌面。

RunGadget 只能在已安裝至系統的小工具上呼叫。 它無法在已經執行的小工具上呼叫，任何指定時間只能透過此方法執行一個小工具實例。

因為小工具安裝沒有自己的 UI，所以這個方法通常會當做安裝程式的最後一個步驟執行，或做為與小工具相關聯之應用程式第一次啟動的一部分。 將小工具安裝到 %ProgramFiles%\Windows 提要工具\共用小工具需要系統管理許可權。 因此，建議在 Microsoft Installer (MSI) 安裝期間執行安裝小工具。

重要 應用程式不應該呼叫 RunGadget ，而不需要先要求使用者取得許可權。 如果選取選項給使用者做為核取方塊，則預設應該取消選取該核取方塊。
 
小工具會新增至桌面，位於系統所決定的位置。 呼叫端無法指定位置。

個別使用者應用程式應該安裝其每個使用者的小工具。 每部電腦應用程式應該安裝其每部電腦的小工具。 這可確保使用者的統一體驗。

範例

下列範例顯示 使用中的 IDesktopGadget：：RunGadget 。

HRESULT RunMyGadget(PCWSTR pszGadgetPath)
{
    IDesktopGadget *pDG;

    HRESULT hr = CoCreateInstance(CLSID_DesktopGadget, 
                                  NULL, 
                                  CLSCTX_INPROC_SERVER, 
                                  IID_PPV_ARGS(&pDG));
    if (SUCCEEDED(hr))
    {
        hr = pDG->RunGadget(pszGadgetPath);
        pDG->Release();
    }

    return hr;
}

需求

   
最低支援的用戶端 Windows 7 [僅限傳統型應用程式]
最低支援的伺服器 Windows Server 2008 R2 [僅限桌面應用程式]
目標平台 Windows
標頭 shobjidl.h