IValueProvider::Value Property

Gets the value of the control.

Syntax

HRESULT IValueProvider::get_Value(BSTR *pRetVal);

Parameters

  • pRetVal
    [retval][out] The address of a BSTR that receives the value as a string. This parameter is passed uninitialized.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

Single-line edit controls support programmatic access to their contents by implementing IValueProvider (in addition to ITextProvider). However, multi-line edit controls do not implement IValueProvider.

To retrieve the textual contents of multi-line edit controls, the controls must implement ITextProvider. However, ITextProvider does not support setting the value of a control.

IValueProvider does not support the retrieval of formatting information or substring values. Implement ITextProvider in these scenarios.

See Also

UI Automation Providers Overview