Export (0) Print
Expand All

IAccPropServices::ClearHwndProps method

This method wraps SetPropValue, SetPropServer, and ClearProps, and provides a convenient entry point for callers who are annotating HWND-based accessible elements.

Syntax


HRESULT ClearHwndProps(
  [in]  HWND hwnd,
  [in]  DWORD idObject,
  [in]  DWORD idChild,
  [in]  const MSAAPROPID *paProps,
  [in]  int cProps
);

Parameters

For descriptions of other parameters, see the corresponding SetPropValue, SetPropServer, or ClearProps method.

hwnd [in]

Type: HWND

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

idObject [in]

Type: DWORD

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

idChild [in]

Type: DWORD

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

paProps [in]

Type: const MSAAPROPID*

Specifies an array of properties that is to be reset. These properties will revert to the default behavior that they displayed before they were annotated.

cProps [in]

Type: int

Specifies the number of properties in the paProps array.

Return value

Type: HRESULT

If successful, returns S_OK, even if the specified properties were never annotated on the accessible object; clearing already-cleared properties is considered a success.

Returns E_INVALIDARG if any of the properties in the paProps array are not supported.

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

For descriptions of return values, see the corresponding SetPropValue, SetPropServer, or ClearProps method.

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.

Additionally, SetHwndPropStr takes a regular Unicode string as a parameter; the caller does not need to specially allocate a BSTR.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Redistributable

Active Accessibility 2.0 RDK on Windows NT 4.0 with SP6 and later and Windows 98

Header

Oleacc.h (include OleAcc.h Include Initguid.h first.)

DLL

Oleacc.dll

See also

IAccPropServices
ClearProps
SetHwndProp
SetHwndPropServer
SetHwndPropStr

 

 

Community Additions

ADD
Show:
© 2014 Microsoft