Función JetGetLS

Artículo
05/11/2022
Tiempo de lectura: 3 minutos

Se aplica a: Windows | Windows Server

Función JetGetLS

La función JetGetLS permite a la aplicación recuperar el identificador de contexto conocido como Local Storage que está asociado a un cursor o a la tabla asociada a ese cursor. Este identificador de contexto debe haberse establecido previamente mediante JetSetLS. JetGetLS también se puede usar para capturar simultáneamente el identificador de contexto actual de un cursor o tabla y restablecer ese identificador de contexto.

Windows XP: JetGetLS se introduce en Windows XP.

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

Parámetros

sesid

La sesión que se va a usar para esta llamada.

tableid

Cursor que se va a usar para esta llamada.

pls

Búfer de salida que recibe el identificador de contexto asociado actualmente con el cursor o la tabla.

grbit

Un grupo de bits que especifica cero o más de las siguientes opciones.

Value	Significado
JET_bitLSCursor	Indica que se debe recuperar el identificador de contexto asociado al cursor especificado. Si no se especifica ni JET_bitLSCursor ni JET_bitLSTable, se supone JET_bitLSCursor. Esta opción no se puede usar con JET_bitLSTable. Si se intenta, se producirá un error en la operación con JET_errInvalidgrbit.
JET_bitLSTable	Indica que se debe recuperar el identificador de contexto asociado a la tabla que contiene el cursor especificado. Es ilegal usar esta opción con JET_bitLSCursor. Si se intenta, se producirá un error en la operación con JET_errInvalidgrbit.
JET_bitLSReset	Indica que el identificador de contexto del objeto elegido debe restablecerse a JET_LSNil. El valor actual del identificador de contexto se devuelve en el búfer de salida.

Value

Significado

JET_bitLSCursor

Indica que se debe recuperar el identificador de contexto asociado al cursor especificado.

Si no se especifica ni JET_bitLSCursor ni JET_bitLSTable, se supone JET_bitLSCursor.

Esta opción no se puede usar con JET_bitLSTable. Si se intenta, se producirá un error en la operación con JET_errInvalidgrbit.

JET_bitLSTable

Indica que se debe recuperar el identificador de contexto asociado a la tabla que contiene el cursor especificado. Es ilegal usar esta opción con JET_bitLSCursor. Si se intenta, se producirá un error en la operación con JET_errInvalidgrbit.

JET_bitLSReset

Indica que el identificador de contexto del objeto elegido debe restablecerse a JET_LSNil. El valor actual del identificador de contexto se devuelve en el búfer de salida.

Valor devuelto

Esta función devuelve el JET_ERR tipo de datos con uno de los siguientes códigos de retorno. Para obtener más información sobre los posibles errores de ESE, vea Extensible Storage Engine Errors and Error Handling Parameters.

Código devuelto	Descripción
JET_errSuccess	La operación se ha completado correctamente.
JET_errClientRequestToStopJetService	No es posible completar la operación porque toda la actividad de la instancia asociada a la sesión ha dejado de funcionar como resultado de una llamada a JetStopService.
JET_errInstanceUnavailable	No es posible completar la operación porque la instancia asociada a la sesión ha encontrado un error irrecuperable que requiere que se revoque el acceso a todos los datos para proteger la integridad de esos datos. Este error solo lo devolverá Windows XP y versiones posteriores.
JET_errInvalidgrbit	Una de las opciones solicitadas no era válida, se usaba de forma ilegal o no se implementaba. Esto puede ocurrir para JetGetLS cuando se establecen tanto JET_bitLSCursor como JET_bitLSTable.
JET_errLSNotSet	No se pudo devolver el identificador de contexto porque actualmente no hay ningún identificador de contexto asociado al objeto solicitado. Nota Este error no se devuelve si se especifica JET_bitLSReset aún no se ha asociado ningún identificador de contexto con el objeto solicitado.
JET_errNotInitialized	No es posible completar la operación porque la instancia asociada a la sesión aún no se ha inicializado.
JET_errRestoreInProgress	No es posible completar la operación porque una operación de restauración está en curso en la instancia asociada a la sesión.
JET_errTermInProgress	No es posible completar la operación porque la instancia asociada a la sesión se está cerrando.

Si se ejecuta correctamente, el identificador de contexto se recuperó correctamente del objeto solicitado. Si se especificó JET_bitLSReset, ese identificador de contexto también se quitó correctamente del objeto . No se producirá ningún cambio en el estado de la base de datos.

Si se produce un error, no se ha producido ningún cambio en el estado del objeto solicitado. No se producirá ningún cambio en el estado de la base de datos.

Requisitos

Requisito	Value
Cliente	Requiere Windows Vista o Windows XP.
Server	Requiere Windows Server 2008 o Windows Server 2003.
Encabezado	Declarado en Esent.h.
Library	Use ESENT.lib.
Archivo DLL	Requiere ESENT.dll.

Vea también

JET_ERR
JET_GRBIT
JET_LS
JET_SESID
JET_TABLEID
JetSetLS