CJumpList 類別

發行項
10/12/2023

CJumpList是當您以滑鼠右鍵按一下工作列中圖示時所顯示的快捷方式清單。

語法

class CJumpList;

成員

公用建構函式

名稱	描述
CJumpList：：CJumpList	建構 `CJumpList` 物件。
CJumpList：：~CJumpList	終結 `CJumpList` 物件。

名稱	描述
CJumpList：：AbortList	在不認可的情況下中止清單建置交易。
CJumpList：：AddDestination	已多載。將目的地新增至清單。
CJumpList：：AddKnownCategory	將已知類別附加至清單。
CJumpList：：AddTask	已多載。將專案新增至標準工作類別。
CJumpList：：AddTasks	將專案新增至標準工作類別。
CJumpList：：AddTaskSeparator	在工作之間加入分隔符號。
CJumpList：：ClearAll	移除到目前為止已新增至目前實例 `CJumpList` 的所有工作和目的地。
CJumpList：：ClearAllDestinations	移除到目前為止已新增至目前實例 `CJumpList` 的所有目的地。
CJumpList：：CommitList	結束清單建置交易，並將報告的清單認可至相關聯的存放區（在此案例中為登錄。
CJumpList：：GetDestinationList	擷取目的地清單的介面指標。
CJumpList：：GetMaxSlots	擷取專案數目上限，包括可在呼叫應用程式的目的地功能表中顯示的類別標頭。
CJumpList：：GetRemovedItems	傳回代表已移除目的地的專案陣列。
CJumpList：：InitializeList	開始清單建置交易。
CJumpList：：SetAppID	設定要建置之清單的應用程式使用者模型識別碼。

繼承階層架構

CJumpList

需求

標頭： afxadv.h

CJumpList：：~CJumpList

終結 CJumpList 物件。

~CJumpList();

CJumpList：：AbortList

在不認可的情況下中止清單建置交易。

void AbortList();

備註

呼叫這個方法的效果與終結的效果相同， CJumpList 而不呼叫 CommitList 。

CJumpList：：AddDestination

將目的地新增至清單。

BOOL AddDestination(
    LPCTSTR lpcszCategoryName,
    LPCTSTR strDestinationPath);

BOOL AddDestination(
    LPCTSTR strCategoryName,
    IShellItem* pShellItem);

BOOL AddDestination(
    LPCTSTR strCategoryName,
    IShellLink* pShellLink);

參數

lpcszCategoryName
指定類別名稱。如果指定的類別不存在，則會建立它。

strDestinationPath
指定目的地檔案的路徑。

strCategoryName
指定類別名稱。如果指定的類別不存在，則會建立它。

pShellItem
指定代表要加入之目的地的 Shell 專案。

pShellLink
指定殼層連結，代表要新增的目的地。

傳回值

備註

實例 CJumpList 會在內部累積新增的目的地，然後在中 CommitList 認可它們。

CJumpList：：AddKnownCategory

將已知類別附加至清單。

BOOL AddKnownCategory(KNOWNDESTCATEGORY category);

參數

category
指定已知的類別類型。可以是KDC_RECENT或KDC_KNOWN。

傳回值

備註

已知類別是「經常」和「最近」類別，我們將針對每個使用 SHAddToRecentDocs 的應用程式自動計算這些類別（或間接使用它，因為殼層在某些情況下會代表應用程式呼叫它）。

CJumpList：：AddTask

將專案新增至標準工作類別。

BOOL AddTask(
    LPCTSTR strTargetExecutablePath,
    LPCTSTR strCommandLineArgs,
    LPCTSTR strTitle,
    LPCTSTR strIconLocation,
    int iIconIndex);

BOOL AddTask(IShellLink* pShellLink);

參數

strTargetExecutablePath
指定目標工作路徑。

strCommandLineArgs
指定 strTargetExecutablePath 所指定可執行檔的命令列引數。

strTitle
將在目的地清單中顯示的工作名稱。

strIconLocation
將顯示在 [目的地清單] 以及標題中的圖示位置。

iIconIndex
圖示索引。

pShellLink
殼層連結，表示要加入的工作。

傳回值

備註

的 CJumpList 實例會累積指定的工作，並在期間 CommitList 將它們新增至目的地清單。工作專案會出現在應用程式目的地功能表底部的類別中。當此類別填入 UI 時，此類別優先于所有其他類別。

CJumpList：：AddTasks

將專案新增至標準工作類別。

BOOL AddTasks(IObjectArray* pObjectCollection);

參數

pObjectCollection
要加入的工作集合。

傳回值

備註

CJumpList 的實例會累積指定的工作，並在期間 CommitList 將它們新增至目的地清單。工作專案會出現在應用程式目的地功能表底部的類別中。當此類別填入 UI 時，此類別優先于所有其他類別。

CJumpList：：AddTaskSeparator

在工作之間加入分隔符號。

BOOL AddTaskSeparator();

傳回值

如果成功，則為非零，如果不是，則為 0。

CJumpList：：CJumpList

建構 CJumpList 物件。

CJumpList(BOOL bAutoCommit = TRUE);

參數

bAutoCommit
如果此參數為 FALSE，則清單不會在解構函式中自動認可。

CJumpList：：ClearAll

移除到目前為止已新增至目前實例 CJumpList 的所有工作和目的地。

void ClearAll();

備註

此方法會清除並釋放所有資料和內部介面。

CJumpList：：ClearAllDestinations

移除到目前為止已新增至 CJumpList 實例的所有目的地。

void ClearAllDestinations();

備註

如果您需要移除目前目的地清單建置會話中新增的所有目的地，並再次新增其他目的地，請呼叫此函式。如果內部 ICustomDestinationList 已初始化，則會保持運作。

CJumpList：：CommitList

結束清單建置交易，並將報告的清單認可至相關聯的存放區（在此案例中為登錄）。

BOOL CommitList();

傳回值

備註

認可是不可部分完成的。如果認可失敗，則會傳回錯誤。呼叫時 CommitList ，將會清除目前移除的專案清單。呼叫這個方法會重設物件，使其沒有作用中的清單建置交易。若要更新清單， BeginList 必須再次呼叫。

CJumpList：：GetDestinationList

擷取目的地清單的介面指標。

ICustomDestinationList* GetDestinationList();

傳回值

備註

如果跳躍清單尚未初始化，或已認可或中止，則傳回的值會是 Null。

CJumpList：：GetMaxSlots

擷取專案數目上限，包括可在呼叫應用程式的目的地功能表中顯示的類別標頭。

UINT GetMaxSlots() const;

傳回值

備註

應用程式只能報告一些專案和類別標頭，並結合到這個值。如果呼叫 AppendCategory 、 AppendKnownCategory 或 AddUserTasks 超過這個數位，則會傳回失敗。

CJumpList：：GetRemovedItems

傳回代表已移除目的地的專案陣列。

IObjectArray* GetRemovedItems();

傳回值

備註

已移除的目的地會在跳躍清單的初始化期間擷取。產生新的目的地清單時，應用程式應該會先處理移除的目的地清單，清除移除清單列舉值所傳回之任何專案的追蹤資料。如果應用程式嘗試提供剛在目前呼叫 BeginList 啟動的交易中移除的專案，則重新新增該專案的方法呼叫將會失敗，以確保應用程式遵守已移除的清單。

CJumpList：：InitializeList

開始清單建置交易。

BOOL InitializeList();

傳回值

備註

除非您想要使用 GetDestinationList 擷取的指標 ICustomDestinationList 、使用 GetMaxSlots 的可用位置數目，或使用來擷取已移除的專案 GetRemovedItems 清單，否則您不需要明確呼叫此方法。

CJumpList：：SetAppID

設定要建置之清單的應用程式使用者模型識別碼。

void SetAppID(LPCTSTR strAppID);

參數

strAppID
指定應用程式使用者模型識別碼的字串。

另請參閱

類別

共用方式為