Share via

IRawElementProviderSimple::ProviderOptions Property

  • Article

Gets a value that specifies the type of UI Automation provider; for example, whether it is a client-side or server-side provider.

Syntax

HRESULT IRawElementProviderSimple::get_ProviderOptions(ProviderOptions *pRetVal);

Parameters

  • pRetVal
    The address of a variable that receives a bitwise combination of values from the ProviderOptions enumerated type. This parameter is passed uninitialized.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

The method must return either ProviderOptions_ServerSideProvider or ProviderOptions_ClientSideProvider.

Microsoft UI Automation handles the various types of providers differently. For example, events from a server-side provider are broadcast to all listening clients, but events from client-side providers remain in the client.

Example

The following example implements this method for a server-side UI Automation provider.

HRESULT STDMETHODCALLTYPE Provider::get_ProviderOptions( ProviderOptions* pRetVal )
{
    *pRetVal = ProviderOptions_ServerSideProvider;
    return S_OK;
}

See Also

IRawElementProviderSimple