Share via

Функция JetGetLS

  • Статья

Применимо к: Windows | Windows Server

Функция JetGetLS

Функция JetGetLS позволяет приложению получить дескриптор контекста, называемый локальным хранилищем, который связан с курсором или таблицей, связанной с этим курсором. Этот дескриптор контекста должен быть ранее задан с помощью JetSetLS. JetGetLS также можно использовать для одновременного получения текущего дескриптора контекста для курсора или таблицы и сброса этого дескриптора контекста.

Windows XP: JetGetLS представлен в Windows XP.

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

Параметры

sesid

Сеанс, используемый для этого вызова.

tableid

Курсор, используемый для этого вызова.

pls

Выходной буфер, который получает дескриптор контекста, связанный с курсором или таблицей.

grbit

Группа битов, задающая ноль или несколько следующих параметров.

Значение

Значение

JET_bitLSCursor

Указывает, что необходимо извлечь дескриптор контекста, связанный с заданным курсором.

Если ни JET_bitLSCursor, ни JET_bitLSTable не указаны, то предполагается JET_bitLSCursor.

Этот параметр нельзя использовать с JET_bitLSTable. Операция завершится ошибкой с JET_errInvalidgrbit, если предпринята попытка.

JET_bitLSTable

Указывает, что необходимо извлечь дескриптор контекста, связанный с таблицей, содержащей заданный курсор. Использовать этот параметр с JET_bitLSCursor недопустимо. Операция завершится ошибкой с JET_errInvalidgrbit, если предпринята попытка.

JET_bitLSReset

Указывает, что дескриптор контекста для выбранного объекта должен быть сброшен до JET_LSNil. Текущее значение дескриптора контекста возвращается в выходном буфере.

Возвращаемое значение

Эта функция возвращает тип данных JET_ERR с одним из следующих кодов возврата. Дополнительные сведения о возможных ошибках ESE см. в разделах Ошибки подсистемы расширяемого хранилища и Параметры обработки ошибок.

Код возврата

Описание

JET_errSuccess

Операция выполнена успешно.

JET_errClientRequestToStopJetService

Невозможно выполнить операцию, так как все действия экземпляра, связанного с сеансом, прекратились в результате вызова JetStopService.

JET_errInstanceUnavailable

Невозможно выполнить операцию, так как экземпляр, связанный с сеансом, столкнулся с неустранимой ошибкой, требующей отмены доступа ко всем данным для защиты целостности этих данных.

Эта ошибка будет возвращена только в Windows XP и более поздних выпусках.

JET_errInvalidgrbit

Один из запрошенных вариантов был недопустимым, использовался незаконным образом или не был реализован.

Это может произойти для JetGetLS , если заданы JET_bitLSCursor и JET_bitLSTable.

JET_errLSNotSet

Не удалось вернуть дескриптор контекста, так как в настоящее время с запрошенным объектом не связан дескриптор контекста.

Примечание Эта ошибка не возвращается, если JET_bitLSReset указан, но с запрошенным объектом не связан дескриптор контекста.

JET_errNotInitialized

Невозможно выполнить операцию, так как экземпляр, связанный с сеансом, еще не инициализирован.

JET_errRestoreInProgress

Невозможно выполнить операцию, так как операция восстановления выполняется в экземпляре, связанном с сеансом.

JET_errTermInProgress

Невозможно выполнить операцию, так как экземпляр, связанный с сеансом, завершает работу.

При успешном выполнении дескриптор контекста был успешно извлечен из запрошенного объекта. Если JET_bitLSReset указано, этот дескриптор контекста также был успешно удален из объекта . Изменение состояния базы данных не произойдет.

В случае сбоя состояние запрошенного объекта не изменилось. Изменение состояния базы данных не произойдет.

Требования

Требование Значение

Клиент

Требуется Windows Vista или Windows XP.

Сервер

Требуется Windows Server 2008 или Windows Server 2003.

Верхняя часть

Объявлено в Esent.h.

Библиотека

Используйте ESENT.lib.

DLL

Требуется ESENT.dll.

См. также:

JET_ERR
JET_GRBIT
JET_LS
JET_SESID
JET_TABLEID
JetSetLS