Export (0) Print
Expand All

IAccPropServices::SetPropServer method

Servers use SetPropServer to specify a callback object to be used to annotate an array of properties for the accessible element. You can also specify whether the annotation is to be applied to this accessible element or to the element and its children. This method is used for server annotation.

If server developers know the HWND of the accessible element they want to annotate, they can use IAccPropServices::SetHwndPropServer.

Syntax


HRESULT SetPropServer(
  [in]  const BYTE *pIDString,
  [in]  DWORD dwIDStringLen,
  [in]  const MSAAPROPID *paProps,
  [in]  int cProps,
  [in]  IAccPropServer *pServer,
  [in]  AnnoScope annoScope
);

Parameters

pIDString [in]

Type: const BYTE*

Identifies the accessible element that is to be annotated.

dwIDStringLen [in]

Type: DWORD

Specifies the length of the string identified by the pIDString parameter.

paProps [in]

Type: const MSAAPROPID*

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

cProps [in]

Type: int

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

pServer [in]

Type: IAccPropServer*

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

annoScope [in]

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

See the support section for a list of supported properties and their expected types.

The annotation run time will use AddRef to increment the reference counter for the pServer callback object appropriately. The caller is free to Release it after calling this method. The annotation run time will automatically release the callback object after the accessible element being annotated is no longer being used.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Redistributable

Active Accessibility 2.0 RDK on Windows NT 4.0 with SP6 and later and Windows 98

Header

Oleacc.h (include OleAcc.h Include Initguid.h first.)

DLL

Oleacc.dll

 

 

Community Additions

ADD
Show:
© 2014 Microsoft