JetGetLS-Funktion

Artikel
06/12/2023

Gilt für: Windows | Windows Server

JetGetLS-Funktion

Mit der JetGetLS-Funktion kann die Anwendung das Kontexthandle abrufen, das als lokaler Speicher bezeichnet wird und einem Cursor oder der diesem Cursor zugeordneten Tabelle zugeordnet ist. Dieses Kontexthandle muss zuvor mithilfe von JetSetLS festgelegt worden sein. JetGetLS kann auch verwendet werden, um gleichzeitig das aktuelle Kontexthandle für einen Cursor oder eine Tabelle abzurufen und dieses Kontexthandle zurückzusetzen.

Windows XP: JetGetLS wird in Windows XP eingeführt.

    JET_ERR JET_API JetGetLS(
      __in          JET_SESID sesid,
      __in          JET_TABLEID tableid,
      __out         JET_LS* pls,
      __in          JET_GRBIT grbit
    );

Parameter

sesid

Die Sitzung, die für diesen Aufruf verwendet werden soll.

tableid

Der Cursor, der für diesen Aufruf verwendet werden soll.

pls

Der Ausgabepuffer, der das Kontexthandle empfängt, das derzeit dem Cursor oder der Tabelle zugeordnet ist.

grbit

Eine Gruppe von Bits, die null oder mehr der folgenden Optionen angibt.

Wert	Bedeutung
JET_bitLSCursor	Gibt an, dass das dem angegebenen Cursor zugeordnete Kontexthandle abgerufen werden soll. Wenn weder JET_bitLSCursor noch JET_bitLSTable angegeben wird, wird von JET_bitLSCursor ausgegangen. Diese Option kann nicht mit JET_bitLSTable verwendet werden. Der Vorgang schlägt mit JET_errInvalidgrbit fehl, wenn dies versucht wird.
JET_bitLSTable	Gibt an, dass das Kontexthandle abgerufen werden soll, das der Tabelle zugeordnet ist, die den angegebenen Cursor enthält. Es ist unzulässig, diese Option mit JET_bitLSCursor zu verwenden. Der Vorgang schlägt mit JET_errInvalidgrbit fehl, wenn dies versucht wird.
JET_bitLSReset	Gibt an, dass das Kontexthandle für das ausgewählte Objekt auf JET_LSNil zurückgesetzt werden soll. Der aktuelle Wert des Kontexthandles wird im Ausgabepuffer zurückgegeben.

Wert

Bedeutung

JET_bitLSCursor

Gibt an, dass das dem angegebenen Cursor zugeordnete Kontexthandle abgerufen werden soll.

Wenn weder JET_bitLSCursor noch JET_bitLSTable angegeben wird, wird von JET_bitLSCursor ausgegangen.

Diese Option kann nicht mit JET_bitLSTable verwendet werden. Der Vorgang schlägt mit JET_errInvalidgrbit fehl, wenn dies versucht wird.

JET_bitLSTable

Gibt an, dass das Kontexthandle abgerufen werden soll, das der Tabelle zugeordnet ist, die den angegebenen Cursor enthält. Es ist unzulässig, diese Option mit JET_bitLSCursor zu verwenden. Der Vorgang schlägt mit JET_errInvalidgrbit fehl, wenn dies versucht wird.

JET_bitLSReset

Gibt an, dass das Kontexthandle für das ausgewählte Objekt auf JET_LSNil zurückgesetzt werden soll. Der aktuelle Wert des Kontexthandles wird im Ausgabepuffer zurückgegeben.

Rückgabewert

Diese Funktion gibt den Datentyp JET_ERR mit einem der folgenden Rückgabecodes zurück. Weitere Informationen zu möglichen ESE-Fehlern finden Sie unter Erweiterbare Speichermodulfehler und Fehlerbehandlungsparameter.

Rückgabecode	Beschreibung
JET_errSuccess	Der Vorgang wurde erfolgreich abgeschlossen.
JET_errClientRequestToStopJetService	Es ist nicht möglich, den Vorgang abzuschließen, da alle Aktivitäten auf der instance, die der Sitzung zugeordnet sind, aufgrund eines Aufrufs von JetStopService beendet wurden.
JET_errInstanceUnavailable	Es ist nicht möglich, den Vorgang abzuschließen, da für die instance, die der Sitzung zugeordnet ist, ein schwerwiegender Fehler aufgetreten ist, der erfordert, dass der Zugriff auf alle Daten widerrufen wird, um die Integrität dieser Daten zu schützen. Dieser Fehler wird nur von Windows XP und späteren Versionen zurückgegeben.
JET_errInvalidgrbit	Eine der angeforderten Optionen war ungültig, auf unzulässige Weise verwendet oder nicht implementiert. Dies kann bei JetGetLS passieren, wenn sowohl JET_bitLSCursor als auch JET_bitLSTable festgelegt sind.
JET_errLSNotSet	Das Kontexthandle konnte nicht zurückgegeben werden, da dem angeforderten Objekt derzeit kein Kontexthandle zugeordnet ist. Hinweis Dieser Fehler wird nicht zurückgegeben, wenn JET_bitLSReset angegeben ist, aber kein Kontexthandle dem angeforderten Objekt zugeordnet wurde.
JET_errNotInitialized	Es ist nicht möglich, den Vorgang abzuschließen, da die der Sitzung zugeordnete instance noch nicht initialisiert wurde.
JET_errRestoreInProgress	Es ist nicht möglich, den Vorgang abzuschließen, da ein Wiederherstellungsvorgang für die instance ausgeführt wird, die der Sitzung zugeordnet ist.
JET_errTermInProgress	Es ist nicht möglich, den Vorgang abzuschließen, da die der Sitzung zugeordnete instance heruntergefahren wird.

Bei Erfolg wurde das Kontexthandle erfolgreich aus dem angeforderten Objekt abgerufen. Wenn JET_bitLSReset angegeben wurde, wurde dieses Kontexthandle ebenfalls erfolgreich aus dem Objekt entfernt. Es wird keine Änderung des Datenbankzustands vorgenommen.

Bei einem Fehler ist keine Änderung des Zustands des angeforderten Objekts aufgetreten. Es wird keine Änderung des Datenbankzustands vorgenommen.

Anforderungen

Anforderung	Wert
Client	Erfordert Windows Vista oder Windows XP.
Server	Erfordert Windows Server 2008 oder Windows Server 2003.
Kopfzeile	Deklariert in Esent.h.
Bibliothek	Verwenden Sie ESENT.lib.
DLL	Erfordert ESENT.dll.

Weitere Informationen

JET_ERR
JET_GRBIT
JET_LS
JET_SESID
JET_TABLEID
JetSetLS

Freigeben über

JetGetLS-Funktion