IApplicationDocumentLists::GetList method
Retrieves an object that represents the collection of destinations listed in the Recent or Frequent category in a Jump List.
Syntax
HRESULT GetList( [in] APPDOCLISTTYPE listtype, [in] UINT cItemsDesired, [in] REFIID riid, [out] void **ppv );
Parameters
- listtype [in]
-
Type: APPDOCLISTTYPE
One of the following values that specifies from which category the list of destinations should be retrieved.
- cItemsDesired [in]
-
Type: UINT
The number of items to retrieve from the list specified in listtype. Set this parameter to 0 to retrieve the full list.
- riid [in]
-
Type: REFIID
A reference to the IID of the interface to retrieve through ppv, typically IID_IObjectArray or IID_IEnumObjects.
- ppv [out]
-
Type: void**
When this method returns, contains the interface pointer requested in riid. This is typically an IObjectArray or IEnumObjects which represents a collection of IShellItem or IShellLink objects (or a mix of the two) that represent the retrieved items from the list.
Return value
Type: HRESULT
If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Remarks
An item can appear in both the Recent and Frequent lists.
If a user pins an item in the Recent or Frequent categories, the item is no longer shown in its original category to avoid duplication in the Jump List. However, the item will still be returned by this method.
Requirements
|
Minimum supported client |
Windows 7 [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows Server 2008 R2 [desktop apps only] |
|
Header |
|
|
IDL |
|
|
Library |
|
|
DLL |
|
See also