IAccPropServices::ClearHmenuProps method (oleacc.h)

Article
02/22/2024

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

Syntax

HRESULT ClearHmenuProps(
  [in] HMENU            hmenu,
  [in] DWORD            idChild,
  [in] const MSAAPROPID *paProps,
  [in] int              cProps
);

Parameters

[in] hmenu

Type: HMENU

Identifies the HMENU-based accessible element to be annotated.

[in] idChild

Type: DWORD

Specifies the child ID of the accessible element.

[in] paProps

Type: const MSAAPROPID*

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

[in] cProps

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 other parameters and return values, see the ClearProps method.

Remarks

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

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	oleacc.h (include OleAcc.h Include Initguid.h first.)
DLL	Oleacc.dll
Redistributable	Active Accessibility 2.0 RDK on Windows NT 4.0 with SP6 and later and Windows 98