Edit

IAccPropServices::ComposeHwndIdentityString method (oleacc.h)

  • Article

Callers use ComposeHwndIdentityString to retrieve an identity string.

Syntax

HRESULT ComposeHwndIdentityString(
  [in]  HWND  hwnd,
  [in]  DWORD idObject,
  [in]  DWORD idChild,
  [out] BYTE  **ppIDString,
  [out] DWORD *pdwIDStringLen
);

Parameters

[in] hwnd

Type: HWND

Specifies the HWND of the accessible element that the caller wants to identify.

[in] idObject

Type: DWORD

Specifies the object ID of the accessible element.

[in] idChild

Type: DWORD

Specifies the child ID of the accessible element.

[out] ppIDString

Type: BYTE**

Pointer to a buffer that receives the identity string. The callee allocates this buffer using CoTaskMemAlloc. When finished, the caller must free the buffer by calling CoTaskMemFree.

[out] pdwIDStringLen

Type: DWORD*

Pointer to a buffer that receives the length of the identity string.

Return value

Type: HRESULT

If successful, returns S_OK.

Returns E_INVALIDARG if hwnd, idObject, or idChild is not valid.

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

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