Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

IAccPropServices::ClearProps method

Servers use ClearProps to restore default values to properties of accessible elements that they had previously annotated.

If servers know the HWND of the object they want to clear, they can use IAccPropServices::ClearHwndProps.

Syntax


HRESULT ClearProps(
  [inconst BYTE       *pIDString,
  [in]       DWORD      dwIDStringLen,
  [inconst MSAAPROPID *paProps,
  [in]       int        cProps
);

Parameters

pIDString [in]

Type: const BYTE*

Identify the accessible element that is to be un-annotated.

dwIDStringLen [in]

Type: DWORD

Length of pIDString.

paProps [in]

Type: const MSAAPROPID*

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

cProps [in]

Type: int

Size of 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.

Remarks

See the support section for a list of supported properties and their expected types.

Clearing the annotation for a property will cause any associated resources to be released. If a callback property server was used (see SetPropServer), it will be released.

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

 

 

Community Additions

ADD
Show:
© 2015 Microsoft