Skip to content

Latest commit

 

History

History
97 lines (71 loc) · 3.78 KB

nf-oleacc-iaccpropservices-clearprops.md

File metadata and controls

97 lines (71 loc) · 3.78 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:oleacc.IAccPropServices.ClearProps
IAccPropServices::ClearProps (oleacc.h)
Servers use ClearProps to restore default values to properties of accessible elements that they had previously annotated.
ClearProps
ClearProps method [Windows Accessibility]
ClearProps method [Windows Accessibility]
IAccPropServices interface
IAccPropServices interface [Windows Accessibility]
ClearProps method
IAccPropServices.ClearProps
IAccPropServices::ClearProps
_msaa_IAccPropServices_ClearProps
msaa.iaccpropservices_iaccpropservices__clearprops
oleacc/IAccPropServices::ClearProps
winauto.iaccpropservices_iaccpropservices__clearprops
winauto\iaccpropservices_iaccpropservices__clearprops.htm
WinAuto
6a3bce93-1d5d-48cf-84f4-cbca445b5451
12/05/2018
ClearProps, ClearProps method [Windows Accessibility], ClearProps method [Windows Accessibility],IAccPropServices interface, IAccPropServices interface [Windows Accessibility],ClearProps method, IAccPropServices.ClearProps, IAccPropServices::ClearProps, _msaa_IAccPropServices_ClearProps, msaa.iaccpropservices_iaccpropservices__clearprops, oleacc/IAccPropServices::ClearProps, winauto.iaccpropservices_iaccpropservices__clearprops
oleacc.h
OleAcc.h Include Initguid.h first.
Windows
Windows XP [desktop apps only]
Windows Server 2003 [desktop apps only]
Oleacc.dll
Windows
Active Accessibility 2.0 RDK on Windows NT 4.0 with SP6 and later and Windows 98
19H1
IAccPropServices::ClearProps
oleacc/IAccPropServices::ClearProps
c++
APIRef
kbSyntax
COM
Oleacc.dll
IAccPropServices.ClearProps

IAccPropServices::ClearProps

-description

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.

-parameters

-param pIDString [in]

Type: const BYTE*

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

-param dwIDStringLen [in]

Type: DWORD

Length of pIDString.

-param 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.

-param cProps [in]

Type: int

Size of paProps array.

-returns

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.