Skip to content

Latest commit

 

History

History
109 lines (77 loc) · 4.74 KB

nf-oleacc-iaccpropservices-setpropserver.md

File metadata and controls

109 lines (77 loc) · 4.74 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:oleacc.IAccPropServices.SetPropServer
IAccPropServices::SetPropServer (oleacc.h)
Servers use SetPropServer to specify a callback object to be used to annotate an array of properties for the accessible element.
IAccPropServices interface [Windows Accessibility]
SetPropServer method
IAccPropServices.SetPropServer
IAccPropServices::SetPropServer
SetPropServer
SetPropServer method [Windows Accessibility]
SetPropServer method [Windows Accessibility]
IAccPropServices interface
_msaa_IAccPropServices_SetPropServer
msaa.iaccpropservices_iaccpropservices__setpropserver
oleacc/IAccPropServices::SetPropServer
winauto.iaccpropservices_iaccpropservices__setpropserver
winauto\iaccpropservices_iaccpropservices__setpropserver.htm
WinAuto
15e43a38-4cb3-43ca-a0fc-28faf49057dc
12/05/2018
IAccPropServices interface [Windows Accessibility],SetPropServer method, IAccPropServices.SetPropServer, IAccPropServices::SetPropServer, SetPropServer, SetPropServer method [Windows Accessibility], SetPropServer method [Windows Accessibility],IAccPropServices interface, _msaa_IAccPropServices_SetPropServer, msaa.iaccpropservices_iaccpropservices__setpropserver, oleacc/IAccPropServices::SetPropServer, winauto.iaccpropservices_iaccpropservices__setpropserver
oleacc.h
OleAcc.h Include Initguid.h first.
Windows
Windows XP [desktop apps only]
Windows Server 2003 [desktop apps only]
Oleacc.dll
Windows
Active Accessibility 2.0 RDK on Windows NT 4.0 with SP6 and later and Windows 98
19H1
IAccPropServices::SetPropServer
oleacc/IAccPropServices::SetPropServer
c++
APIRef
kbSyntax
COM
Oleacc.dll
IAccPropServices.SetPropServer

IAccPropServices::SetPropServer

-description

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.

-parameters

-param pIDString [in]

Type: const BYTE*

Identifies the accessible element that is to be annotated.

-param dwIDStringLen [in]

Type: DWORD

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

-param paProps [in]

Type: const MSAAPROPID*

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

-param cProps [in]

Type: int

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

-param pServer [in]

Type: IAccPropServer*

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

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

-returns

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.