IAccPropServices::SetHwndPropStr method

• 12/05/2018
• 2 minutes to read

This method wraps SetPropValue, providing a more convenient entry point for callers who are annotating HWND-based accessible elements.

Syntax

HRESULT SetHwndPropStr(
  HWND       hwnd,
  DWORD      idObject,
  DWORD      idChild,
  MSAAPROPID idProp,
  LPCWSTR    str
);

Parameters

hwnd

Type: HWND

Identifies the accessible element that is to be annotated. This replaces the identity string.

idObject

Type: DWORD

Identifies the accessible element that is to be annotated. This replaces the identity string.

idChild

Type: DWORD

Identifies the accessible element that is to be annotated. This replaces the identity string.

idProp

Type: MSAAPROPID

Specifies which property of that element is to be annotated.

str

Type: LPCWSTR

Specifies a new value for that property.

Return Value

Type: HRESULT

If successful, returns S_OK.

May return other error codes under exceptional error conditions such as low memory.

Remarks

By using this method, the caller does not have to obtain an identity string; it can specify the hwnd, idObject, and idChild parameters directly.

Requirements

See Also

ClearHwndProps

IAccPropServices

SetHwndProp

SetHwndPropServer

SetPropValue