Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

STRRET structure

Applies to: desktop apps only

Contains strings returned from the IShellFolder interface methods.

Syntax

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

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.

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.

uOffset

Type: UINT

The offset into the item identifier list.

cStr

Type: CHAR[MAX_PATH]

The buffer to receive the display name.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows 2000 Server

Header
Shtypes.h

See also

IShellFolder::GetDisplayNameOf

 

 

Send comments about this topic to Microsoft

Build date: 3/7/2012

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ