IAccPropServices::DecomposeHmenuIdentityString method (oleacc.h)

Use this method to determine the HMENU, object ID, and child ID for the accessible element identified by the identity string.

Syntax

HRESULT DecomposeHmenuIdentityString(
  [in]  const BYTE *pIDString,
  [in]  DWORD      dwIDStringLen,
  [out] HMENU      *phmenu,
  [out] DWORD      *pidChild
);

Parameters

[in] pIDString

Type: const BYTE*

Pointer to a buffer containing identity string of an HMENU-based accessible element.

[in] dwIDStringLen

Type: DWORD

Specifies the length of the identity string specified by pIDString.

[out] phmenu

Type: HMENU*

Pointer to a buffer that receives the HMENU of the accessible element.

[out] pidChild

Type: DWORD*

Pointer to a buffer that receives the child ID of the accessible element.

Return value

Type: HRESULT

If successful, returns S_OK.

Returns E_INVALIDARG if phmenu or pidChild are not valid, or if the given identity string is not a HMENU-based identity string.

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

Remarks

This method succeeds only if the provided identity string is an HMENU-based identity string. This method is useful in an IAccPropServer callback server that was registered with ANNO_CONTAINER scope because it allows the server to determine, from the given identity string, the child element (idChild) for which the client is calling the server.

Requirements