IComponent::GetResultViewType

[This is preliminary documentation and subject to change.]

Determines what the result pane view should be.

HRESULT GetResultViewType(
  long cookie,            // unique identifier
  LPOLESTR * ppViewType,  // pointer to address of the view
  long * pViewOptions     // pointer to view options
);
 

Parameters

cookie
[in] Specifies the unique identifier associated with scope items for which the result-view type is required.
ppViewType
[out] Pointer to the address of the returned view type for the specified cookie.
pViewOptions
[out] Pointer to the MMC_VIEW_OPTIONS enumeration, which provides the console with options specified by the owning snap-in. This value can be a combination of the following:
Value Meaning
MMC_VIEW_OPTIONS_
NOLISTVIEWS = 0x0001
Tells the console to refrain from presenting standard list view choices in the View menu. Allows the snap-in to display its own custom views only in the result view pane.
MMC_VIEW_OPTIONS_OWNERDATALIST = 0x0002 Specifies that the result pane list view should be a virtual list.
MMC_VIEW_OPTIONS_MULTISELECT = 0x0004 Allows multiple item selections in the result pane view.
MMC_VIEW_OPTIONS_NONE
= 0
Allows the default view options.

Return Values

S_OK
The returned view type was either an OLE custom control (OCX) CLSID string or a URL.
S_FALSE
The default list view should be used.
E_UNEXPECTED
An unexpected error occurred.
E_OUTOFMEMORY
Not enough memory to complete the operation.

Remarks

The caller will allocate using CoTaskMemAlloc and the called will free it using CoTaskMemFree. These functions are documented in the Platform SDK.

A cookie is a pointer to a structure containing information unique to a specific item that is passed in through the lParam member of a SCOPEDATAITEM structure.

See Also

IComponent, IDataObject