STRRET structure (shtypes.h)

Contains strings returned from the IShellFolder interface methods.

Syntax

typedef struct _STRRET {
  UINT  uType;
  union {
    LPWSTR pOleStr;
    UINT   uOffset;
    char   cStr[260];
  } DUMMYUNIONNAME;
} STRRET;

Members

uType

Type: UINT

A value that specifies the desired format of the string. This can be one of the following values.

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 specified by pOleStr member.

DUMMYUNIONNAME

DUMMYUNIONNAME.pOleStr

Type: LPWSTR

A pointer to the string. This memory must be allocated with CoTaskMemAlloc. It is the calling application's responsibility to free this memory with CoTaskMemFree when it is no longer needed.

DUMMYUNIONNAME.uOffset

Type: UINT

The offset into the item identifier list.

DUMMYUNIONNAME.cStr[260]

Type: CHAR[MAX_PATH]

The buffer to receive the display name.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	shtypes.h

See also

IShellFolder::GetDisplayNameOf