IAccPropServices::SetHmenuPropServer method (oleacc.h)

Article
02/22/2024

This method wraps SetPropServer, providing a convenient entry point for callers who are annotating HMENU-based accessible elements.

Syntax

HRESULT SetHmenuPropServer(
  [in] HMENU            hmenu,
  [in] DWORD            idChild,
  [in] const MSAAPROPID *paProps,
  [in] int              cProps,
  [in] IAccPropServer   *pServer,
  [in] AnnoScope        annoScope
);

Parameters

[in] hmenu

Type: HMENU

Identifies the HMENU-accessible element to be annotated.

[in] idChild

Type: DWORD

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

[in] paProps

Type: const MSAAPROPID*

Specifies an array of properties that is to be handled by the specified callback object.

[in] cProps

Type: int

Specifies the number of properties in the paProps array.

[in] pServer

Type: IAccPropServer*

Specifies the callback object, which will be invoked when a client requests one of the overridden properties.

[in] annoScope

Type: AnnoScope

May be ANNO_THIS, indicating that the annotation affects the indicated accessible element only; or ANNO_CONTAINER, indicating that it applies to the element and its immediate element children.

Return value

Type: HRESULT

If successful, returns S_OK.

Returns E_INVALIDARG if any of the properties in the paProps array are not supported properties, if the identity string is not valid, or if annoScope is not one of ANNO_THIS or ANNO_CONTAINER.

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