JET_LS

Applies to: Windows | Windows Server

JET_LS

The JET_LS data type contains a context handle to local storage (LS).This handle might be associated with a cursor or a table and might refer to dynamically allocated resources.

Windows XP:  JET_LS is introduced in Windows XP.

    typedef JET_API_PTR JET_LS;

Data Types

JET_LS

A value of JET_LSNil indicates an invalid context handle.

Remarks

A context handle is initially associated with the JET_LS data type, using JetSetLS. The context handle can be retrieved from the JET_LS data type, using JetGetLS.

The context handle can be explicitly disassociated from the JET_LS data type using JetGetLS with JET_bitLSReset. Alternatively, the context handle can be implicitly disassociated from the JET_LS data type when the underlying object is released by the database engine as a result of direct or indirect action by the application. In the implicit case, a runtime callback is issued to the application so that it can clean up the context handle. For more information on implicitly disassociating from the JET_LS data type, see JetSetLS.

The following flags are associated with the JET_LS data type.

Term	Description
JET_bitLSReset	The context handle is disassociated from the object.
JET_bitLSCursor	Set or retrieve the local storage associated with a table cursor.
JET_bitLSTable	Set or retrieve the local storage associated with a table.
JET_LSNil	The context handle is invalid.

Requirements

Requirement	Value
Client	Requires Windows Vista or Windows XP.
Server	Requires Windows Server 2008 or Windows Server 2003.
Header	Declared in Esent.h.

See Also

JetSetLS
JetGetLS