IPerPropertyBrowsing::GetDisplayString

Returns a text string describing the property identified with dispID in the caller's user interface. In other words, the returned text is a displayable name describing the property and can be displayed in the caller's user interface. The string itself is a BSTR allocated by this method with SysAllocString. Upon return, the string is the responsibility of the caller, which must free it with SysFreeString when it is no longer needed.

HRESULT GetDisplayString(
  DISPID dispID,  //Dispatch identifier for the property
  BSTR *pbstr     //Receives a pointer to the displayable string 
                  //describing the property
);
 

Parameters

dispID

[in] Dispatch identifier of the property whose display name is requested.

pbstr

[out] Pointer to the BSTR containing the display name for the property identified with dispID.

Return Values

This method supports the standard return values E_INVALIDARG, E_OUTOFMEMORY, and E_UNEXPECTED, as well as the following:

S_OK

The display name was successfully returned.

E_NOTIMPL

The object does not provide display names for individual properties. The caller has the recourse to check the object's type information for the text name of the object in this case.

E_POINTER

The address in pbstr is not valid. For example, it may be NULL.

Remarks

Notes to Implementers

The caller is responsible for freeing the pbstr string with SysFreeString when it is no longer needed.

QuickInfo

  Windows NT: Use version 4.0 or later.
  Windows: Use Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in ocidl.h.