IShellFolder::GetDisplayNameOf  KM10H8

[Now Supported on Windows NT]

Retrieves the display name for the specified file object or subfolder, returning it in a STRRET structure.

HRESULT GetDisplayNameOf(

    LPCITEMIDLIST pidl,

// Pointer to an ITEMIDLIST

    DWORD uFlags,

// Type of display to return

    LPSTRRET lpName

// Pointer to a STRRET structure

       );

 

 

Parameters

pidl

Pointer to an ITEMIDLIST16GUB2N structure that uniquely identifies the file object or subfolder relative to the parent folder.

uFlags

Value indicating the type of display name to return. For a list of possible values, see the description of the SHGNO enumerated type.

lpName

Pointer to a STRRETFLTBO2 structure in which to return the display name. The string returned in this structure depends on the type of display name requested.

 

Return Values

Returns NOERROR if successful or an OLE-defined error value otherwise.

Remarks

If the ID contains the display name (in the local character set), it returns the offset to the name. If not, it returns a pointer to the display name string (UNICODE) allocated by the task allocator, or it fills in a buffer. The type of string returned depends on the type of display specified. Values identifying different types of display names are contained in the enumeration SHGNO.

See Also

IShellFolder, ITEMIDLIST, STRRET, SHGNO