SHAddToRecentDocs

Other versions of this page are also available for the following:

Windows Mobile Not SupportedWindows Embedded CE Supported

8/28/2008

This function adds a document to the shell's list of recently used documents or clears all documents from the list. The user gains access to the list through the Start menu of a taskbar or other top-level application.

Syntax

WINSHELLAPI void WINAPI SHAddToRecentDocs(
  UINT uFlags, 
  LPCVOID pv 
);

Parameters

  • uFlags
    [in] Flag that indicates the meaning of the pv parameter. The following table shows the possible values.

    Value Description

    SHARD_PATH

    The pv parameter contains the address of a path string.

    SHARD_PIDL

    The pv parameter contains the address of an item identifier list (PIDL) that identifies a file object. PIDLs that identify nonfile objects are not allowed.

  • pv
    [in] Void pointer to a character buffer that contains the path and file name of the document, or the address of an ITEMIDLIST structure that contains an item identifier list that uniquely identifies the document. If this parameter is NULL, the function clears all documents from the list.

Return Value

None.

Remarks

In Windows Embedded CE, you cannot add more than ten documents to the recently used documents list. The OEM's shell implementation controls the visual display of the recently used documents list and can limit the list's length.

Requirements

Header shellapi.h
Library coredll.lib
Windows Embedded CE Windows CE 1.0 and later

See Also

Reference

Standard Shell Functions