STRRET

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

Windows Mobile Not SupportedWindows Embedded CE Supported

8/28/2008

This structure contains strings returned from the IShellFolder interface methods.

Syntax

typedef struct _STRRET {
  UINT uType; 
  union { 
    LPWSTR pOleStr;
    UINT uOffset;
    char cStr[MAX_PATH];
  } DUMMYUNIONNAME; 
} STRRET, *LPSTRRET;

Members

  • uType
    Value that specifies the desired format of the string. The following table shows the possible values.

    Value Description

    STRRET_CSTR

    The string is returned in the cStr member.

    STRRET_OFFSET

    The uOffset member value indicates the number of bytes from the beginning of the item identifier list where the string is located.

    STRRET_WSTR

    The string is at the address pointed to in the pOleStr member.

  • pOleStr
    Pointer to the OLE string. This memory must be allocated with the shell's allocator. For more information, see SHGetMalloc. It is the calling application's responsibility to use the shell's allocator to free this memory when it is no longer needed.
  • uOffset
    Offset into item identifier list.
  • cStr
    Buffer to receive the display name.

Requirements

Header shtypes.h
Windows Embedded CE Windows CE .NET 4.2 and later

See Also

Reference

Standard Shell Structures
IShellFolder::GetDisplayNameOf
SHGetMalloc