GetContextPropertyValue-Funktion (recapis.h)

Artikel
03/01/2024

Gibt einen angegebenen Eigenschaftswert aus dem Erkennungskontext zurück.

Syntax

HRESULT GetContextPropertyValue(
  HRECOCONTEXT hrc,
  GUID         *pGuid,
  ULONG        *pcbSize,
  BYTE         *pProperty
);

Parameter

hrc

Das Handle für den Erkennungskontext.

pGuid

Die abzurufende Eigenschaft. Geben Sie eine vordefinierte GuiD (Globally Unique Identifier) oder eine anwendungsdefinierte GUID an. Eine Liste der vordefinierten Eigenschaften finden Sie unter erkennungseigenschaften-GUIDs.

pcbSize

Bei der Eingabe kann die Größe des pProperty-Puffers in Bytes sein. Bei der Ausgabe ist die Größe des pProperty-Puffers in Bytes.

pProperty

Der vom Benutzer zugewiesene Puffer, um den Eigenschaftswert zu enthalten. Um die Größe des Puffers zu bestimmen, legen Sie pProperty auf NULL fest. verwenden Sie die Größe, um pProperty zuzuweisen.

Rückgabewert

Diese Funktion kann einen dieser Werte zurückgeben.

Rückgabecode	BESCHREIBUNG
S_OK	Erfolg.
E_POINTER	Einer der Parameter ist ein ungültiger Zeiger.
E_FAIL	Es ist ein unbekannter Fehler aufgetreten.
E_INVALIDARG	Es wurde ein ungültiges Argument empfangen.
TPC_E_UNINITIALIZED_PROPERTY	Die Eigenschaft wurde nicht vom Kontext festgelegt. Dies kann vorkommen, wenn die Eigenschaft nur unter bestimmten Umständen festgelegt wird oder wenn die Eigenschaft erst nach einem noch nicht aufgetretenen Ereignis festgelegt werden soll.
TPC_E_INVALID_PROPERTY	Die Erkennung unterstützt die -Eigenschaft nicht.
TPC_E_INSUFFICIENT_BUFFER	Der pProperty-Puffer ist zu klein.

Hinweise

Diese Funktion ist optional.

Sie können die GetContextPropertyValue-Funktion verwenden, um Informationen abzurufen, die die Erkennung an den Aufrufer zurückgibt. Dadurch kann eine benutzerdefinierte Erkennung über Modi und Einstellungen verfügen und Daten zurückgeben, die für diese Erkennung eindeutig sind.

In den Microsoft-Erkennungsfunktionen führt das Aufrufen der GetContextPropertyValue-Funktion mit festgelegtem pcbSize-Parameter auf einen Wert, der größer als erforderlich ist, nicht zu einem falschen Rückgabewert. Stattdessen ändert der Code die Größe automatisch in den erforderlichen Wert für die aktuelle GUID.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows XP Tablet PC Edition [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Nicht unterstützt
Zielplattform	Windows
Kopfzeile	recapis.h
DLL	inkobjcore.dll

Weitere Informationen

GetContextPropertyList-Funktion

SetContextPropertyValue-Funktion

Freigeben über