IPerPropertyBrowsing::MapPropertyToPage method (ocidl.h)

  • Article

Retrieves the CLSID of the property page associated with the specified property.

Syntax

HRESULT MapPropertyToPage(
  [in]  DISPID dispID,
  [out] CLSID  *pClsid
);

Parameters

[in] dispID

The dispatch identifier of the property.

[out] pClsid

A pointer to the CLSID identifying the property page associated with the property specified by dispID. If this method fails, *pClsid is set to CLSID_NULL.

Return value

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

Return code Description
S_OK
 The method completed successfully.
E_NOTIMPL
 The object does not support property pages at all or does not support mapping properties to the page CLSID. In other words, this feature of specific property browsing is not supported.
E_POINTER
 The address in pClsid is not valid. For example, it may be NULL.

Remarks

The CLSID returned from this method can be passed to OleCreatePropertyFrameIndirect to specify the initial page to display in the property sheet.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header ocidl.h

See also

IPerPropertyBrowsing