IMultipleViewProvider::GetViewName method

Retrieves the name of a control-specific view.

Syntax

HRESULT GetViewName(
  int  viewId,
  BSTR *pRetVal
);

Parameters

viewId

Type: int

A view identifier.

pRetVal

Type: BSTR*

Receives a localized name for the view. This parameter is passed uninitialized.

Return Value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

View identifiers can be retrieved by using IMultipleViewProvider::GetSupportedViews.

The collection of view identifiers must be identical for all instances of a control.

View names must be suitable for use in text-to-speech, Braille, and other accessible applications.

Requirements

   
Minimum supported client Windows XP [desktop apps | UWP apps]
Minimum supported server Windows Server 2003 [desktop apps | UWP apps]
Target Platform Windows
Header uiautomationcore.h (include UIAutomation.h)
DLL Uiautomationcore.dll

See Also

IMultipleViewProvider

UI Automation Providers Overview