Export (0) Print
Expand All

IPerPropertyBrowsing::GetDisplayString method

Retrieves a text string describing the specified property.

Syntax


HRESULT GetDisplayString(
  [in]  DISPID dispID,
  [out] BSTR   *pBstr
);

Parameters

dispID [in]

The dispatch identifier of the property whose display name is requested.

pBstr [out]

A pointer to a variable that receives the display name for the property identified in dispID. The string is allocated by this method using SysAllocString. Upon return, the string is the responsibility of the caller, which must free it with SysFreeString when it is no longer needed.

Return value

This method can return the standard return values E_INVALIDARG, E_OUTOFMEMORY, and E_UNEXPECTED, as well as the following values.

Return codeDescription
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.

 

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

OCIdl.h

IDL

OCIdl.idl

IID

IID_IPerPropertyBrowsing is defined as 376BD3AA-3845-101B-84ED-08002B2EC713

See also

IPerPropertyBrowsing

 

 

Community Additions

ADD
Show:
© 2015 Microsoft