IAccPropServices::ClearProps-Methode (oleacc.h)

Artikel
03/04/2024

Server verwenden ClearProps, um Standardwerte für Eigenschaften barrierefreier Elemente wiederherzustellen, die sie zuvor mit Anmerkungen versehen hatten.

Wenn Server den HWND des Objekts kennen, das sie löschen möchten, können sie IAccPropServices::ClearHwndProps verwenden.

Syntax

HRESULT ClearProps(
  [in] const BYTE       *pIDString,
  [in] DWORD            dwIDStringLen,
  [in] const MSAAPROPID *paProps,
  [in] int              cProps
);

Parameter

[in] pIDString

Typ: const BYTE*

Gibt das barrierefreie Element an, dessen Anmerkungen entfernt werden sollen.

[in] dwIDStringLen

Typ: DWORD

Länge von pIDString

[in] paProps

Typ: const MSAAPROPID*

Gibt ein Array von Eigenschaften an, das zurückgesetzt werden soll. Diese Eigenschaften werden auf das Standardverhalten zurückgesetzt, das vor dem Festlegen von Anmerkungen gültig war.

[in] cProps

Typ: int

Größe des paProps-Arrays .

Rückgabewert

Typ: HRESULT

Gibt bei erfolgreicher Ausführung S_OK zurück, auch wenn die angegebenen Eigenschaften nie für das zugängliche Objekt mit Anmerkungen versehen wurden. Das Löschen bereits gelöschter Eigenschaften gilt als erfolgreich.

Gibt E_INVALIDARG zurück, wenn eine der Eigenschaften im paProps-Array nicht unterstützt wird.

Kann andere Fehlercodes unter außergewöhnlichen Fehlerbedingungen wie z. B. wenig Arbeitsspeicher zurückgeben.

Hinweise

Eine Liste der unterstützten Eigenschaften und der erwarteten Typen finden Sie im Abschnitt Support.

Wenn Sie die Anmerkung für eine Eigenschaft löschen, werden alle zugeordneten Ressourcen freigegeben. Wenn ein Rückrufeigenschaftenserver verwendet wurde (siehe SetPropServer), wird er freigegeben.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	oleacc.h (Include OleAcc.h Include Initguid.h first.)
DLL	Oleacc.dll
Verteilbare Komponente	Active Accessibility 2.0 RDK unter Windows NT 4.0 mit SP6 und höher und Windows 98

Freigeben über