IAccPropServer::GetPropValue-Methode (oleacc.h)

Ruft einen Eigenschaftswert für ein barrierefreies Element ab.

Syntax

HRESULT GetPropValue(
  [in]  const BYTE *pIDString,
  [in]  DWORD      dwIDStringLen,
  [in]  MSAAPROPID idProp,
  [out] VARIANT    *pvarValue,
  [out] BOOL       *pfHasProp
);

Parameter

[in] pIDString

Typ: const BYTE*

Enthält eine Zeichenfolge, die die angeforderte Eigenschaft angibt.

[in] dwIDStringLen

Typ: DWORD

Gibt die Länge der vom pIDString-Parameter angegebenen Identitätszeichenfolge an

[in] idProp

Typ: MSAAPROPID

Gibt eine GUID an, die die gewünschte Eigenschaft angibt.

[out] pvarValue

Typ: VARIANT*

Gibt den Wert der überschriebenen Eigenschaft an. Dieser Parameter ist nur gültig, wenn pfHasPropTRUE ist. Der Server muss dies auf VT_EMPTY festlegen, wenn pfHasProp auf FALSE festgelegt ist.

[out] pfHasProp

Typ: BOOL*

Gibt an, ob der Server einen Wert für die angeforderte Eigenschaft angibt. Der Server sollte dies auf TRUE festlegen, wenn er eine überschreibende Eigenschaft zurückgibt, oder auf FALSE , wenn er keine Eigenschaft zurückgibt (in diesem Fall sollte er auch pvarValue auf VT_EMPTY festlegen).

Rückgabewert

Typ: HRESULT

Gibt S_OK zurück, außer bei außergewöhnlichen Fehlerbedingungen wie z. B. wenig Arbeitsspeicher. Wenn die angegebene Eigenschaft nicht überschrieben wird, sollte pfHasProp auf FALSE und pvarValue auf VT_EMPTY vom Server festgelegt werden.

Hinweise

Wenn ein einzelnes Rückrufobjekt zum Kommentieren mehrerer barrierefreier Elemente registriert wird, kann die Identitätszeichenfolge verwendet werden, um zu bestimmen, auf welches Element sich diese Anforderung bezieht.

Wenn das barrierefreie Element HWND-basiert, kann IAccPropServices::D ecomposeHwndIdentityString verwendet werden, um HWND/idObject/idChild aus der Identitätszeichenfolge zu extrahieren.

Wenn der Rückruf über einen Wert verfügt, der für die angegebene Eigenschaft zurückgegeben werden soll, sollte er ihn in pvarValue zurückgeben und pfHasProp auf TRUE festlegen. Andernfalls sollte pvarValue auf VT_EMPTY und pfHasProp auf FALSE festgelegt werden. In diesem fall wird der ursprüngliche IAccessible-Schnittstellenzeiger verwendet, um einen Wert für diese Eigenschaft abzurufen.

Anforderungen