JetGetSystemParameter-Funktion
Letzte Änderung: Freitag, 27. Februar 2015
Gilt für: Windows | Windows Server
JetGetSystemParameter-Funktion
Die JetGetSystemParameter -Funktion liest die zahlreiche Konfigurationseinstellungen des Datenbankmoduls.
JET_ERR JET_API JetGetSystemParameter(
__in JET_INSTANCE instance,
__in JET_SESID sesid,
__in unsigned long paramid,
__in_out_opt JET_API_PTR* plParam,
__out_opt JET_PSTR szParam,
__in unsigned long cbMax
);
Parameter
Instance
Die Instanz, die für diesen Aufruf verwenden.
Für Windows 2000 wird dieser Parameter ignoriert und sollte immer NULLsein.
Dieser Parameter ist für Windows XP und späteren Versionen etwas überladen. Wenn die Engine im legacy-Modus (Windows 2000-Kompatibilitätsmodus) betrieben wird, die nur eine einzige Instanz unterstützen, wird dieser Parameter kann NULL sein, oder die JetInitzurückgegebene tatsächliche Instanz enthalten kann. In beiden Fällen werden alle Parameter Systemeinstellungen aus, dass eine Instanz gelesen. Wenn das Modul mit mehreren Instanzen betrieben wird, kann dieser Parameter NULL oder ein Zeiger auf eine Instanz mit JetInit oder JetCreateInstanceerstellt sein. Wenn dieser Parameter NULL dann der globalen System Parametereinstellung (oder Standard) ist, wird gelesen. Wenn dieser Parameter eine Instanz der Systemparameter für diese Instanz wird wird gelesen.
sesid
Die Sitzung für diesen Aufruf verwenden.
Wenn angegeben, wird die angegebene Instanz ignoriert, und die Instanz dieser Sitzung verwendet werden.
paramid
Die ID des Parameters System gelesen werden.
Eine vollständige Liste der Systemparameter und deren Eigenschaften finden Sie unter System-Parameter .
plParam
Der Ausgabepuffer, der den Wert des Parameters ausgewählten System empfängt, wenn der Systemparameter von einem ganzzahligen Typ ist.
szParam
Der Ausgabepuffer, der den Wert des Parameters ausgewählten System empfängt, wenn der Systemparameter vom Typ String ist.
cbMax
Die maximale Größe in Byte des Ausgabepuffers Zeichenfolge.
Return Value
Diese Funktion gibt den Datentyp der JET_ERR mit einem der folgenden Rückgabecodes. Weitere Informationen zu den möglichen ESE-Fehlern finden Sie unter Extensible Storage Engine-Fehler und Fehler behandeln Parameter.
Rückgabecode |
Beschreibung |
|---|---|
JET_errSuccess |
Der Vorgang wurde erfolgreich abgeschlossen. |
JET_errClientRequestToStopJetService |
Es ist nicht möglich, um den Vorgang abzuschließen, da alle Aktivitäten in der Instanz dieser Sitzung aufgrund eines Aufrufs von JetStopServiceeingestellt hat. |
JET_errInitInProgress |
Es ist nicht möglich, um den Vorgang abzuschließen, da die Sitzung zugeordnete Instanz initialisiert wird. |
JET_errInstanceUnavailable |
Es ist nicht möglich, um den Vorgang abzuschließen, da die Sitzung zugeordnete Instanz ein schwerwiegender Fehler, der erfordert aufgetreten ist, dass der Zugriff auf alle Daten gesperrt werden, um die Integrität der Daten zu schützen. Dieser Fehler wird nur von Windows XP und späteren Versionen zurückgegeben werden. |
JET_errInvalidParameter |
Einer der bereitgestellten Parameter einen unerwarteten Wert enthalten oder enthalten einen Wert, der nicht mit dem Wert eines anderen Parameters kombiniert keinen Sinn. Dies kann passieren, für JetGetSystemParameter bei:
|
JET_errNotInitialized |
Es ist nicht möglich, um den Vorgang abzuschließen, da die Instanz dieser Sitzung noch nicht initialisiert wurde. |
JET_errRestoreInProgress |
Es ist nicht möglich, um den Vorgang abzuschließen, da ein Wiederherstellungsvorgang ausgeführt auf die Instanz der Sitzung zugeordnet wird. |
JET_errTermInProgress |
Es ist nicht möglich, um den Vorgang abzuschließen, da die Sitzung zugeordnete Instanz heruntergefahren wird. |
JET_errInvalidSesid |
Das Sitzungshandle ist ungültig oder verweist auf eine geschlossene Sitzung. Dieser Fehler wird nicht unter allen Umständen zurückgegeben. Ziehpunkte werden auf einer best Effort-Basis überprüft. |
JET_errInvalidInstance |
Das Instanzenhandle ist ungültig oder verweist auf eine Instanz, die heruntergefahren wurde. Dieser Fehler wird nicht unter allen Umständen zurückgegeben. Ziehpunkte werden auf einer best Effort-Basis überprüft. Windows Vista:Dieser Fehler wird nur von Windows Vista und späteren Versionen zurückgegeben werden. |
JET_wrnBufferTruncated |
Der Vorgang wurde erfolgreich abgeschlossen, aber der Ausgabepuffer war zu klein für das gesamte System Parametereinstellung erhalten. Der Ausgabepuffer wurde mit so viel wie passen würde das System Parametereinstellung gefüllt. Wenn der Ausgabepuffer mindestens ein Zeichen lang ist werden die Zeichenfolge in diesem Ausgabepuffer Null beendet. HinweisDieser Fehler wird nicht von allen Versionen zurückgegeben. Finden Sie im Abschnitt "Hinweise" für Weitere Informationen. |
JET_errBufferTooSmall |
Der Vorgang ist fehlgeschlagen, da der Ausgabepuffer zu klein, um die gesamte System-Parametereinstellung empfangen wurde. HinweisDieser Fehler wird in einigen Fällen Anwendungskompatibilität beibehalten nicht zurückgegeben. Finden Sie im Abschnitt "Hinweise" für Weitere Informationen. Windows Vista:Dieser Fehler wird nur von Windows Vista und späteren Versionen zurückgegeben werden. |
Bei Erfolg wird der Wert dieses SystemParameters der Ausgabepuffer für den gewünschten Systemparameter fest.
Bei einem Fehler wird der Zustand der ausgangspuffer nicht definiert sein.
Anmerkungen
Es ist ein wichtiges Problem in dieser API, die in allen Versionen vorhanden ist. Ein Systemparameter mit einem Zeichenfolgenwert angefordert, und der Ausgabepuffer ist zu klein, um die gesamte System-Parametereinstellung empfangen, wird die JET_wrnBufferTruncated nicht zurückgegeben. JET_errSuccess wird stattdessen zurückgegeben. Wenn die Länge der zurückgegebenen Zeichenfolge auf die Größe des Ausgabepuffers abzüglich des NULL -Terminators gleich ist, sollte der Aufrufer reagieren, als wenn JET_wrnBufferTruncated zurückgegeben wurden. Wenn Sie ein Ausgabepuffer Größe Null-Zeichenfolge angegeben ist, sollte der Aufrufer reagieren, als wenn JET_errInvalidParameter zurückgegeben wurden.
Voraussetzungen
-Client, |
Erfordert Windows Vista, Windows XP oder Windows 2000 Professional. |
Server |
Erfordert WindowsServer 2008, WindowsServer 2003 oder Windows 2000 Server. |
Kopfzeile |
In Esent.h deklariert. |
Library |
Verwenden Sie ESENT.lib. |
DLL |
"ESENT.dll" erfordert. |
Unicode |
Implementiert als JetGetSystemParameterW (Unicode) und JetGetSystemParameterA (ANSI). |
Siehe auch
JET_API_PTR
JET_ERR
JET_INSTANCE
JET_SESID
JetCreateInstance
JetInit
JetSetSystemParameter
JetStopService
Systemparameter