SHARD enumeration (shlobj_core.h)

Indicates the interpretation of the data passed by SHAddToRecentDocs in its pv parameter to identify the item whose usage statistics are being tracked.

Syntax

typedef enum {
  SHARD_PIDL,
  SHARD_PATHA,
  SHARD_PATHW,
  SHARD_APPIDINFO,
  SHARD_APPIDINFOIDLIST,
  SHARD_LINK,
  SHARD_APPIDINFOLINK,
  SHARD_SHELLITEM
} SHARD;

Constants

SHARD_PIDL The pv parameter points to a PIDL that identifies the document's file object. PIDLs that identify non-file objects are not accepted.
SHARD_PATHA The pv parameter points to a null-terminated ANSI string with the path and file name of the object.
SHARD_PATHW The pv parameter points to a null-terminated Unicode string with the path and file name of the object.
SHARD_APPIDINFO Windows 7 and later. The pv parameter points to a SHARDAPPIDINFO structure that pairs an IShellItem that identifies the item with an AppUserModelID that associates it with a particular process or application.
SHARD_APPIDINFOIDLIST Windows 7 and later. The pv parameter points to a SHARDAPPIDINFOIDLIST structure that pairs an absolute PIDL that identifies the item with an AppUserModelID that associates it with a particular process or application.
SHARD_LINK Windows 7 and later. The pv parameter is an interface pointer to an IShellLink object.
SHARD_APPIDINFOLINK Windows 7 and later. The pv parameter points to a SHARDAPPIDINFOLINK structure that pairs an IShellLink that identifies the item with an AppUserModelID that associates it with a particular process or application.
SHARD_SHELLITEM Windows 7 and later. The pv parameter is an interface pointer to an IShellItem object.

Remarks

Before Windows 7, SHARD_PIDL, SHARD_PATHA, and SHARD_PATHW were defined as individual constants, not as enumeration members.

When providing an IShellLink through either SHARD_LINK or SHARD_APPIDINFOLINK, the IShellLink instance must provide the following:

• Either a PIDL (IShellLink::SetIDList) or the target path (IShellLink::SetPath or IShellLink::SetRelativePath)
• Command-line arguments (IShellLink::SetArguments)
• Icon location (IShellLink::SetIconLocation)

The display name must be set through the item's System.Title (PKEY_Title) property. The property can directly hold the display name or it can be an indirect string representation, such as "@shell32.dll,-1324", to use a stored string. An indirect string enables the item name to be displayed in the user's selected language.

Optionally, the description field (IShellLink::SetDescription) can be set to provide a custom tooltip for the item in the Jump List.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional, Windows XP, Windows 7 [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	shlobj_core.h (include Shlobj.h)

See also

SHAddToRecentDocs