LegacyFilePosition

All Known Subinterfaces:

FilePosition
```
public interface LegacyFilePosition
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`extract(byte[] p_buffer, int p_size, byte[] p_key, int p_keyNumber, boolean p_field)` Extract from the key given.
`int`	`extract(byte[] p_buffer, int p_size, byte[] p_key, int p_keyNumber, int p_timeout, boolean p_field)` Extract from the key given.
`int`	`extract(byte[] p_buffer, int p_size, byte[] p_key, int p_keylen, int p_keyNumber, int p_timeout, boolean p_field)` Extract from the key given.
`int`	`extract(byte[] p_buffer, int p_size, byte[] p_key, int p_keylen, java.lang.String p_keyName, int p_timeout, boolean p_field)` Extract from the key given.
`int`	`extract(byte[] p_buffer, int p_size, byte[] p_key, java.lang.String p_keyName, boolean p_field)` Extract from the key given.
`int`	`extract(byte[] p_buffer, int p_size, byte[] p_key, java.lang.String p_keyName, int p_timeout, boolean p_field)` Extract from the key given.
`int`	`extract(byte[] p_buffer, int p_size, int p_timeout, boolean p_field)` Extract from the current position.
`int`	`extract(byte[] p_buffer, int p_size, int p_keyNumber, int p_timeout, boolean p_field)` Extract from the current position.
`int`	`extract(byte[] p_buffer, int p_size, long p_index, boolean p_field)` Extract from the index given.
`int`	`extract(byte[] p_buffer, int p_size, long p_index, int p_timeout, boolean p_field)` Extract from the index given.
`int`	`extract(byte[] p_buffer, int p_size, java.lang.String p_keyName, int p_timeout, boolean p_field)` Extract from the current position.
`int`	`getFirstKey(byte[] p_buffer)` Get first key in current key number.
`int`	`getFirstKey(byte[] p_buffer, int p_keylen)` Get first key in current key number.
`int`	`getFirstKey(byte[] p_buffer, int p_keylen, int p_timeout)` Get first key in current key number.
`int`	`getKey(byte[] p_buffer)` Get key at the current position.
`int`	`getKey(byte[] p_buffer, int p_keylen)` Get key at the current position.
`int`	`getKey(byte[] p_buffer, int p_keylen, int p_timeout)` Get key at the current position.
`int`	`getKey(long p_index, byte[] p_buffer, int p_keylen)` Get key at index.
`int`	`getKey(long p_index, byte[] p_buffer, int p_keylen, int p_timeout)` Get key at the index.
`int`	`getLastKey(byte[] p_buffer)` Get last key in current key number.
`int`	`getLastKey(byte[] p_buffer, int p_keylen)` Get last key in current key number.
`int`	`getLastKey(byte[] p_buffer, int p_keylen, int p_timeout)` Get last key in current key number.
`int`	`getNextKey(byte[] p_buffer)` Get next key at the current position.
`int`	`getNextKey(byte[] p_buffer, int p_keylen)` Get next key at the current position.
`int`	`getNextKey(byte[] p_buffer, int p_keylen, int p_timeout)` Get next key at the current position.
`int`	`getNextKey(long p_index, byte[] p_buffer, int p_keylen)` Get next key at index.
`int`	`getNextKey(long p_index, byte[] p_buffer, int p_keylen, int p_timeout)` Get next key at index.
`int`	`getNumKey(byte[] p_buffer, int p_keylen, int p_keyNumber)` Get key at the current position.
`int`	`getNumKey(byte[] p_buffer, int p_keylen, int p_keyNumber, int p_timeout)` Get key at the current position.
`int`	`getNumKey(byte[] p_buffer, int p_keylen, java.lang.String p_keyName)` Get key at the current position.
`int`	`getNumKey(byte[] p_buffer, int p_keylen, java.lang.String p_keyName, int p_timeout)` Get key at the current position.
`int`	`getPreviousKey(byte[] p_buffer)` Get previous key at the current position.
`int`	`getPreviousKey(byte[] p_buffer, int p_keylen)` Get previous key at the current position.
`int`	`getPreviousKey(byte[] p_buffer, int p_keylen, int p_timeout)` Get previous key at the current position.
`int`	`getPreviousKey(long p_index, byte[] p_buffer, int p_keylen)` Get previous key at index.
`int`	`getPreviousKey(long p_index, byte[] p_buffer, int p_keylen, int p_timeout)` Get previous key at index.
`int`	`read(byte[] p_buffer, int p_size, byte[] p_key, int p_keyNumber, boolean p_find, long p_move, boolean p_field)` Read from the key given and change the position either forwards or backwards.
`int`	`read(byte[] p_buffer, int p_size, byte[] p_key, int p_keyNumber, boolean p_find, long p_move, int p_timeout, boolean p_field)` Read from the key given and change the position either forwards or backwards.
`int`	`read(byte[] p_buffer, int p_size, byte[] p_key, int p_keylen, int p_keyNumber, boolean p_find, long p_move, boolean p_field)` Read from the key given and change the position either forwards or backwards.
`int`	`read(byte[] p_buffer, int p_size, byte[] p_key, int p_keylen, int p_keyNumber, boolean p_find, long p_move, int p_timeout, boolean p_field)` Read from the key given and change the position either forwards or backwards.
`int`	`read(byte[] p_buffer, int p_size, byte[] p_key, int p_keylen, java.lang.String p_keyName, boolean p_find, long p_move, boolean p_field)` Read from the key given and change the position either forwards or backwards.
`int`	`read(byte[] p_buffer, int p_size, byte[] p_key, int p_keylen, java.lang.String p_keyName, boolean p_find, long p_move, int p_timeout, boolean p_field)` Read from the key given and change the position either forwards or backwards.
`int`	`read(byte[] p_buffer, int p_size, byte[] p_key, java.lang.String p_keyName, boolean p_find, long p_move, boolean p_field)` Read from the key given and change the position either forwards or backwards.
`int`	`read(byte[] p_buffer, int p_size, byte[] p_key, java.lang.String p_keyName, boolean p_find, long p_move, int p_timeout, boolean p_field)` Read from the key given and change the position either forwards or backwards.
`int`	`read(byte[] p_buffer, int p_size, int p_keyNumber, long p_move, int p_timeout, boolean p_field)` Read from the current position and change the position either forwards or backwards.
`int`	`read(byte[] p_buffer, int p_size, long p_move, boolean p_field)` Read from the current position and change the position either forwards or backwards.
`int`	`read(byte[] p_buffer, int p_size, long p_move, int p_timeout, boolean p_field)` Read from the current position and change the position either forwards or backwards.
`int`	`read(byte[] p_buffer, int p_size, long p_index, long p_move, boolean p_field)` Read from the index given and change the position either forwards or backwards.
`int`	`read(byte[] p_buffer, int p_size, long p_index, long p_move, int p_timeout, boolean p_field)` Read from the index given and change the position either forwards or backwards.
`int`	`read(byte[] p_buffer, int p_size, java.lang.String p_keyName, long p_move, int p_timeout, boolean p_field)` Read from the current position and change the position either forwards or backwards.
`void`	`remove(byte[] p_key, boolean p_dom)` Remove the record indicated by a key.
`void`	`remove(byte[] p_key, boolean p_dom, int p_timeout)` Remove the record indicated by a key.
`void`	`remove(byte[] p_key, int p_keylen, boolean p_dom)` Remove the record indicated by a key.
`void`	`remove(byte[] p_key, int p_keylen, boolean p_dom, int p_timeout)` Remove the record indicated by a key.
`void`	`remove(long p_index)` Remove the record indicated by an index.
`void`	`update(byte[] p_oldKey, int p_oldkeylen, byte[] p_old, int p_oldSize, byte[] p_newKey, int p_newkeylen, byte[] p_new, int p_newSize, int p_timeout)` Function to call for safe record updates on files with a specified key (old and new).
`void`	`update(byte[] p_key, int p_keylen, byte[] p_old, int p_oldSize, byte[] p_new, int p_newSize, int p_timeout)` Function to call for safe record updates on files with a specified key.
`void`	`update(byte[] p_old, int p_oldSize, byte[] p_new, int p_newSize, int p_timeout)` Function to call for safe record updates.
`void`	`update(long p_index, byte[] p_old, int p_oldSize, byte[] p_new, int p_newSize, int p_timeout)` Function to call for safe record updates on files with indexes.
`void`	`write(byte[] p_buffer, int p_size, byte[] p_key, int p_keylen, long p_move, boolean p_dom)` Write a record at the position given by a key.
`void`	`write(byte[] p_buffer, int p_size, byte[] p_key, int p_keylen, long p_move, boolean p_dom, boolean p_ignoreKeyIfCant)` Write a record at the position given by a key.
`void`	`write(byte[] p_buffer, int p_size, byte[] p_key, int p_keylen, long p_move, boolean p_dom, int p_timeout)` Write a record at the position given by a key.
`void`	`write(byte[] p_buffer, int p_size, byte[] p_key, int p_keylen, long p_move, boolean p_dom, int p_timeout, boolean p_ignoreKeyIfCant)` Write a record at the position given by a key.
`void`	`write(byte[] p_buffer, int p_size, byte[] p_key, long p_move, boolean p_dom)` Write a record at the position given by a key.
`void`	`write(byte[] p_buffer, int p_size, byte[] p_key, long p_move, boolean p_dom, boolean p_ignoreKeyIfCant)` Write a record at the position given by a key.
`void`	`write(byte[] p_buffer, int p_size, byte[] p_key, long p_move, boolean p_dom, int p_timeout)` Write a record at the position given by a key.
`void`	`write(byte[] p_buffer, int p_size, byte[] p_key, long p_move, boolean p_dom, int p_timeout, boolean p_ignoreKeyIfCant)` Write a record at the position given by a key.
`void`	`write(byte[] p_buffer, int p_size, long p_move, boolean p_dom, boolean p_allowoverwrite)` Write a record at the current position except for multi keyed MKEYED files where the key will be derived from the record.
`void`	`write(byte[] p_buffer, int p_size, long p_move, boolean p_dom, int p_timeout, boolean p_allowoverwrite)` Write a record at the current position except for multi keyed MKEYED files where the key will be derived from the record.
`void`	`write(byte[] p_buffer, int p_size, long p_index, long p_move, boolean p_dom)` Write a record at the position given by an index.
`void`	`write(byte[] p_buffer, int p_size, long p_index, long p_move, boolean p_dom, int p_timeout)` Write a record at the position given by an index.

- Method Detail
  - read
```
int read(byte[] p_buffer,
         int p_size,
         long p_move,
         boolean p_field)
  throws FilesystemException
```
    Read from the current position and change the position either forwards or backwards.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the read. If this is negative the position will be moved backwards.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - read
```
int read(byte[] p_buffer,
         int p_size,
         long p_move,
         int p_timeout,
         boolean p_field)
  throws FilesystemException
```
    Read from the current position and change the position either forwards or backwards.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the read. If this is negative the position will be moved backwards.
    
    p_timeout - Timeout value in seconds for the read operation.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - read
```
int read(byte[] p_buffer,
         int p_size,
         int p_keyNumber,
         long p_move,
         int p_timeout,
         boolean p_field)
  throws FilesystemException
```
    Read from the current position and change the position either forwards or backwards. If the key number given is not the current key number then the current position will be the first key of the specified key number.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_keyNumber - Key number to use for iteration. If the key number is different than the one currently being used the iteration will start at the beginning of the key specified.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the read. If this is negative the position will be moved backwards.
    
    p_timeout - Timeout value in seconds for the read operation.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - read
```
int read(byte[] p_buffer,
         int p_size,
         java.lang.String p_keyName,
         long p_move,
         int p_timeout,
         boolean p_field)
  throws FilesystemException
```
    Read from the current position and change the position either forwards or backwards. If the key number given is not the current key number then the current position will be the first key of the specified key number.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_keyName - Key name to use for iteration. If the key name is different than the one currently being used the iteration will start at the beginning of the key specified.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the read. If this is negative the position will be moved backwards.
    
    p_timeout - Timeout value in seconds for the read operation.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - read
```
int read(byte[] p_buffer,
         int p_size,
         byte[] p_key,
         int p_keyNumber,
         boolean p_find,
         long p_move,
         boolean p_field)
  throws FilesystemException
```
    Read from the key given and change the position either forwards or backwards. File types without keys will give an error.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_key - Key value to search for on the read.
    
    p_keyNumber - Number of the key chain to search.
    
    p_find - true if the position should not be changed if the key is not found.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the read. If this is negative the position will be moved backwards.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - read
```
int read(byte[] p_buffer,
         int p_size,
         byte[] p_key,
         java.lang.String p_keyName,
         boolean p_find,
         long p_move,
         boolean p_field)
  throws FilesystemException
```
    Read from the key given and change the position either forwards or backwards. File types without keys will give an error.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_key - Key value to search for on the read.
    
    p_keyName - Name of the key chain to search.
    
    p_find - true if the position should not be changed if the key is not found.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the read. If this is negative the position will be moved backwards.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - read
```
int read(byte[] p_buffer,
         int p_size,
         byte[] p_key,
         int p_keyNumber,
         boolean p_find,
         long p_move,
         int p_timeout,
         boolean p_field)
  throws FilesystemException
```
    Read from the key given and change the position either forwards or backwards. File types without keys will give an error.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_key - Key value to search for on the read.
    
    p_keyNumber - Number of the key chain to search.
    
    p_find - true if the position should not be changed if the key is not found.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the read. If this is negative the position will be moved backwards.
    
    p_timeout - Timeout value in seconds for the read operation.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - read
```
int read(byte[] p_buffer,
         int p_size,
         byte[] p_key,
         java.lang.String p_keyName,
         boolean p_find,
         long p_move,
         int p_timeout,
         boolean p_field)
  throws FilesystemException
```
    Read from the key given and change the position either forwards or backwards. File types without keys will give an error.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_key - Key value to search for on the read.
    
    p_keyName - Name of the key chain to search.
    
    p_find - true if the position should not be changed if the key is not found.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the read. If this is negative the position will be moved backwards.
    
    p_timeout - Timeout value in seconds for the read operation.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - read
```
int read(byte[] p_buffer,
         int p_size,
         byte[] p_key,
         int p_keylen,
         int p_keyNumber,
         boolean p_find,
         long p_move,
         boolean p_field)
  throws FilesystemException
```
    Read from the key given and change the position either forwards or backwards. File types without keys will give an error.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_key - Key value to search for on the read.
    
    p_keylen - Length of the actual key in the key byte array.
    
    p_keyNumber - Number of the key chain to search.
    
    p_find - true if the position should not be changed if the key is not found.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the read. If this is negative the position will be moved backwards.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - read
```
int read(byte[] p_buffer,
         int p_size,
         byte[] p_key,
         int p_keylen,
         java.lang.String p_keyName,
         boolean p_find,
         long p_move,
         boolean p_field)
  throws FilesystemException
```
    Read from the key given and change the position either forwards or backwards. File types without keys will give an error.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_key - Key value to search for on the read.
    
    p_keylen - Length of the actual key in the key byte array.
    
    p_keyName - Name of the key chain to search.
    
    p_find - true if the position should not be changed if the key is not found.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the read. If this is negative the position will be moved backwards.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - read
```
int read(byte[] p_buffer,
         int p_size,
         byte[] p_key,
         int p_keylen,
         int p_keyNumber,
         boolean p_find,
         long p_move,
         int p_timeout,
         boolean p_field)
  throws FilesystemException
```
    Read from the key given and change the position either forwards or backwards. File types without keys will give an error.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_key - Key value to search for on the read.
    
    p_keylen - Length of the actual key in the key byte array.
    
    p_keyNumber - Number of the key chain to search.
    
    p_find - true if the position should not be changed if the key is not found.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the read. If this is negative the position will be moved backwards.
    
    p_timeout - Timeout value in seconds for the read operation.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - read
```
int read(byte[] p_buffer,
         int p_size,
         byte[] p_key,
         int p_keylen,
         java.lang.String p_keyName,
         boolean p_find,
         long p_move,
         int p_timeout,
         boolean p_field)
  throws FilesystemException
```
    Read from the key given and change the position either forwards or backwards. File types without keys will give an error.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_key - Key value to search for on the read.
    
    p_keylen - Length of the actual key in the key byte array.
    
    p_keyName - Name of the key chain to search.
    
    p_find - true if the position should not be changed if the key is not found.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the read. If this is negative the position will be moved backwards.
    
    p_timeout - Timeout value in seconds for the read operation.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - read
```
int read(byte[] p_buffer,
         int p_size,
         long p_index,
         long p_move,
         boolean p_field)
  throws FilesystemException
```
    Read from the index given and change the position either forwards or backwards. File types without indexes will give an error.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_index - Index to jump to for the read.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the read. If this is negative the position will be moved backwards.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - read
```
int read(byte[] p_buffer,
         int p_size,
         long p_index,
         long p_move,
         int p_timeout,
         boolean p_field)
  throws FilesystemException
```
    Read from the index given and change the position either forwards or backwards. File types without indexes will give an error.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_index - Index to jump to for the read.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the read. If this is negative the position will be moved backwards.
    
    p_timeout - Timeout value in seconds for the read operation.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - extract
```
int extract(byte[] p_buffer,
            int p_size,
            int p_timeout,
            boolean p_field)
     throws FilesystemException
```
    Extract from the current position.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_timeout - Timeout value in seconds for the read operation.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - extract
```
int extract(byte[] p_buffer,
            int p_size,
            int p_keyNumber,
            int p_timeout,
            boolean p_field)
     throws FilesystemException
```
    Extract from the current position. If the key number given is not the current key number then the current position will be the first key of the specified key number.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_keyNumber - Key number to use for iteration. If the key number is different than the one currently being used the iteration will start at the beginning of the key specified.
    
    p_timeout - Timeout value in seconds for the read operation.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - extract
```
int extract(byte[] p_buffer,
            int p_size,
            java.lang.String p_keyName,
            int p_timeout,
            boolean p_field)
     throws FilesystemException
```
    Extract from the current position. If the key number given is not the current key number then the current position will be the first key of the specified key number.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_keyName - Key name to use for iteration. If the key number is different than the one currently being used the iteration will start at the beginning of the key specified.
    
    p_timeout - Timeout value in seconds for the read operation.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - extract
```
int extract(byte[] p_buffer,
            int p_size,
            byte[] p_key,
            int p_keyNumber,
            boolean p_field)
     throws FilesystemException
```
    Extract from the key given. File types without keys will give an error.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_key - Key value to search for on the read.
    
    p_keyNumber - Number of the key chain to search.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - extract
```
int extract(byte[] p_buffer,
            int p_size,
            byte[] p_key,
            java.lang.String p_keyName,
            boolean p_field)
     throws FilesystemException
```
    Extract from the key given. File types without keys will give an error.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_key - Key value to search for on the read.
    
    p_keyName - Name of the key chain to search.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - extract
```
int extract(byte[] p_buffer,
            int p_size,
            byte[] p_key,
            int p_keyNumber,
            int p_timeout,
            boolean p_field)
     throws FilesystemException
```
    Extract from the key given. File types without keys will give an error.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_key - Key value to search for on the read.
    
    p_keyNumber - Number of the key chain to search.
    
    p_timeout - Timeout value in seconds for the read operation.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - extract
```
int extract(byte[] p_buffer,
            int p_size,
            byte[] p_key,
            java.lang.String p_keyName,
            int p_timeout,
            boolean p_field)
     throws FilesystemException
```
    Extract from the key given. File types without keys will give an error.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_key - Key value to search for on the read.
    
    p_keyName - Name of the key chain to search.
    
    p_timeout - Timeout value in seconds for the read operation.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - extract
```
int extract(byte[] p_buffer,
            int p_size,
            byte[] p_key,
            int p_keylen,
            int p_keyNumber,
            int p_timeout,
            boolean p_field)
     throws FilesystemException
```
    Extract from the key given. File types without keys will give an error.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_key - Key value to search for on the read.
    
    p_keylen - Length of the actual key in the key byte array.
    
    p_keyNumber - Number of the key chain to search.
    
    p_timeout - Timeout value in seconds for the read operation.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - extract
```
int extract(byte[] p_buffer,
            int p_size,
            byte[] p_key,
            int p_keylen,
            java.lang.String p_keyName,
            int p_timeout,
            boolean p_field)
     throws FilesystemException
```
    Extract from the key given. File types without keys will give an error.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_key - Key value to search for on the read.
    
    p_keylen - Length of the actual key in the key byte array.
    
    p_keyName - Name of the key chain to search.
    
    p_timeout - Timeout value in seconds for the read operation.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - extract
```
int extract(byte[] p_buffer,
            int p_size,
            long p_index,
            boolean p_field)
     throws FilesystemException
```
    Extract from the index given. File types without indexes will give an error.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_index - Index to jump to for the read.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - extract
```
int extract(byte[] p_buffer,
            int p_size,
            long p_index,
            int p_timeout,
            boolean p_field)
     throws FilesystemException
```
    Extract from the index given. File types without indexes will give an error.
    
    Parameters:
    
    p_buffer - Buffer to fill with the bytes read.
    
    p_size - Maximum number of bytes to read into the buffer.
    
    p_index - Index to jump to for the read.
    
    p_timeout - Timeout value in seconds for the read operation.
    
    p_field - true if data should be read until either a field terminator or size bytes is reached. File types other than STRING will give an error if this is true.
    
    Returns:
    
    Number of bytes actually read.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - write
```
void write(byte[] p_buffer,
           int p_size,
           long p_move,
           boolean p_dom,
           boolean p_allowoverwrite)
    throws FilesystemException
```
    Write a record at the current position except for multi keyed MKEYED files where the key will be derived from the record.
    
    Parameters:
    
    p_buffer - Record bytes.
    
    p_size - Number of bytes to write from the buffer.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the write. If this is negative the position will be moved backwards. The move is relative to the location of the record written.
    
    p_dom - true if an error should be given for a duplicate key.
    
    p_allowoverwrite - true if overwriting of the current record in DIRECT and single-keyed MKEYED files should be allowed (without specifying a key).
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - write
```
void write(byte[] p_buffer,
           int p_size,
           long p_move,
           boolean p_dom,
           int p_timeout,
           boolean p_allowoverwrite)
    throws FilesystemException
```
    Write a record at the current position except for multi keyed MKEYED files where the key will be derived from the record.
    
    Parameters:
    
    p_buffer - Record bytes.
    
    p_size - Number of bytes to write from the buffer.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the write. If this is negative the position will be moved backwards. The move is relative to the location of the record written.
    
    p_dom - true if an error should be given for a duplicate key.
    
    p_timeout - Timeout value in seconds for the write operation.
    
    p_allowoverwrite - true if overwriting of the current record in DIRECT and single-keyed MKEYED files should be allowed (without specifying a key).
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - write
```
void write(byte[] p_buffer,
           int p_size,
           byte[] p_key,
           long p_move,
           boolean p_dom)
    throws FilesystemException
```
    Write a record at the position given by a key. File types without keys and multi-keyed MKEYED and XKEYED files will give an error.
    
    Parameters:
    
    p_buffer - Record bytes.
    
    p_size - Number of bytes to write from the buffer.
    
    p_key - Key to use in writing the record.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the write. If this is negative the position will be moved backwards. The move is relative to the location of the record written.
    
    p_dom - true if an error should be given for a duplicate key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - write
```
void write(byte[] p_buffer,
           int p_size,
           byte[] p_key,
           long p_move,
           boolean p_dom,
           int p_timeout)
    throws FilesystemException
```
    Write a record at the position given by a key. File types without keys and multi-keyed MKEYED and XKEYED files will give an error.
    
    Parameters:
    
    p_buffer - Record bytes.
    
    p_size - Number of bytes to write from the buffer.
    
    p_key - Key to use in writing the record.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the write. If this is negative the position will be moved backwards. The move is relative to the location of the record written.
    
    p_dom - true if an error should be given for a duplicate key.
    
    p_timeout - Timeout value in seconds for the write operation.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - write
```
void write(byte[] p_buffer,
           int p_size,
           byte[] p_key,
           long p_move,
           boolean p_dom,
           boolean p_ignoreKeyIfCant)
    throws FilesystemException
```
    Write a record at the position given by a key. File types without keys will give an error. Multi-keyed MKEYED and XKEYED files will give an error only if the p_ignoreKeyIfCant parameter is false.
    
    Parameters:
    
    p_buffer - Record bytes.
    
    p_size - Number of bytes to write from the buffer.
    
    p_key - Key to use in writing the record.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the write. If this is negative the position will be moved backwards. The move is relative to the location of the record written.
    
    p_dom - true if an error should be given for a duplicate key.
    
    p_ignoreKeyIfCant - true if multi-keyed files should just ignore the provided key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - write
```
void write(byte[] p_buffer,
           int p_size,
           byte[] p_key,
           long p_move,
           boolean p_dom,
           int p_timeout,
           boolean p_ignoreKeyIfCant)
    throws FilesystemException
```
    Write a record at the position given by a key. File types without keys will give an error. Multi-keyed MKEYED and XKEYED files will give an error only if the p_ignoreKeyIfCant parameter is false.
    
    Parameters:
    
    p_buffer - Record bytes.
    
    p_size - Number of bytes to write from the buffer.
    
    p_key - Key to use in writing the record.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the write. If this is negative the position will be moved backwards. The move is relative to the location of the record written.
    
    p_dom - true if an error should be given for a duplicate key.
    
    p_timeout - Timeout value in seconds for the write operation.
    
    p_ignoreKeyIfCant - true if multi-keyed files should just ignore the provided key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - write
```
void write(byte[] p_buffer,
           int p_size,
           byte[] p_key,
           int p_keylen,
           long p_move,
           boolean p_dom)
    throws FilesystemException
```
    Write a record at the position given by a key. File types without keys and multi-keyed MKEYED and XKEYED files will give an error.
    
    Parameters:
    
    p_buffer - Record bytes.
    
    p_size - Number of bytes to write from the buffer.
    
    p_key - Key to use in writing the record.
    
    p_keylen - Length of the actual key in the key byte array.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the write. If this is negative the position will be moved backwards. The move is relative to the location of the record written.
    
    p_dom - true if an error should be given for a duplicate key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - write
```
void write(byte[] p_buffer,
           int p_size,
           byte[] p_key,
           int p_keylen,
           long p_move,
           boolean p_dom,
           int p_timeout)
    throws FilesystemException
```
    Write a record at the position given by a key. File types without keys and multi-keyed MKEYED and XKEYED files will give an error.
    
    Parameters:
    
    p_buffer - Record bytes.
    
    p_size - Number of bytes to write from the buffer.
    
    p_key - Key to use in writing the record.
    
    p_keylen - Length of the actual key in the key byte array.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the write. If this is negative the position will be moved backwards. The move is relative to the location of the record written.
    
    p_dom - true if an error should be given for a duplicate key.
    
    p_timeout - Timeout value in seconds for the write operation.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - write
```
void write(byte[] p_buffer,
           int p_size,
           byte[] p_key,
           int p_keylen,
           long p_move,
           boolean p_dom,
           boolean p_ignoreKeyIfCant)
    throws FilesystemException
```
    Write a record at the position given by a key. File types without keys will give an error. Multi-keyed MKEYED and XKEYED files will give an error only if the p_ignoreKeyIfCant parameter is false.
    
    Parameters:
    
    p_buffer - Record bytes.
    
    p_size - Number of bytes to write from the buffer.
    
    p_key - Key to use in writing the record.
    
    p_keylen - Length of the actual key in the key byte array.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the write. If this is negative the position will be moved backwards. The move is relative to the location of the record written.
    
    p_dom - true if an error should be given for a duplicate key.
    
    p_ignoreKeyIfCant - true if multi-keyed files should just ignore the provided key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - write
```
void write(byte[] p_buffer,
           int p_size,
           byte[] p_key,
           int p_keylen,
           long p_move,
           boolean p_dom,
           int p_timeout,
           boolean p_ignoreKeyIfCant)
    throws FilesystemException
```
    Write a record at the position given by a key. File types without keys will give an error. Multi-keyed MKEYED and XKEYED files will give an error only if the p_ignoreKeyIfCant parameter is false.
    
    Parameters:
    
    p_buffer - Record bytes.
    
    p_size - Number of bytes to write from the buffer.
    
    p_key - Key to use in writing the record.
    
    p_keylen - Length of the actual key in the key byte array.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the write. If this is negative the position will be moved backwards. The move is relative to the location of the record written.
    
    p_dom - true if an error should be given for a duplicate key.
    
    p_timeout - Timeout value in seconds for the write operation.
    
    p_ignoreKeyIfCant - true if multi-keyed files should just ignore the provided key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - write
```
void write(byte[] p_buffer,
           int p_size,
           long p_index,
           long p_move,
           boolean p_dom)
    throws FilesystemException
```
    Write a record at the position given by an index. File types without indexes will give an error.
    
    Parameters:
    
    p_buffer - Record bytes.
    
    p_size - Number of bytes to write from the buffer.
    
    p_index - Index to use in writing the record.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the write. If this is negative the position will be moved backwards. The move is relative to the location of the record written.
    
    p_dom - true if an error should be given for a duplicate key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - write
```
void write(byte[] p_buffer,
           int p_size,
           long p_index,
           long p_move,
           boolean p_dom,
           int p_timeout)
    throws FilesystemException
```
    Write a record at the position given by an index. File types without indexes will give an error.
    
    Parameters:
    
    p_buffer - Record bytes.
    
    p_size - Number of bytes to write from the buffer.
    
    p_index - Index to use in writing the record.
    
    p_move - Number of records (or bytes in STRING file) to move the position after the write. If this is negative the position will be moved backwards. The move is relative to the location of the record written.
    
    p_dom - true if an error should be given for a duplicate key.
    
    p_timeout - Timeout value in seconds for the write operation.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - remove
```
void remove(byte[] p_key,
            boolean p_dom)
     throws FilesystemException
```
    Remove the record indicated by a key. File types without keys will give an error.
    
    Parameters:
    
    p_key - Key of the record to remove.
    
    p_dom - true if an error should be given for a missing key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - remove
```
void remove(byte[] p_key,
            boolean p_dom,
            int p_timeout)
     throws FilesystemException
```
    Remove the record indicated by a key. File types without keys will give an error.
    
    Parameters:
    
    p_key - Key of the record to remove.
    
    p_dom - true if an error should be given for a missing key.
    
    p_timeout - Timeout value in seconds for the operation.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - remove
```
void remove(byte[] p_key,
            int p_keylen,
            boolean p_dom)
     throws FilesystemException
```
    Remove the record indicated by a key. File types without keys will give an error.
    
    Parameters:
    
    p_key - Key of the record to remove.
    
    p_keylen - Length of the actual key in the key byte array.
    
    p_dom - true if an error should be given for a missing key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - remove
```
void remove(byte[] p_key,
            int p_keylen,
            boolean p_dom,
            int p_timeout)
     throws FilesystemException
```
    Remove the record indicated by a key. File types without keys will give an error.
    
    Parameters:
    
    p_key - Key of the record to remove.
    
    p_keylen - Length of the actual key in the key byte array.
    
    p_dom - true if an error should be given for a missing key.
    
    p_timeout - Timeout value in seconds for the operation.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getKey
```
int getKey(byte[] p_buffer)
    throws FilesystemException
```
    Get key at the current position.
    
    Parameters:
    
    p_buffer - Buffer in which to place the key.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getKey
```
int getKey(long p_index,
           byte[] p_buffer,
           int p_keylen)
    throws FilesystemException
```
    Get key at index.
    
    Parameters:
    
    p_index - Index to get key.
    
    p_buffer - Buffer in which to place the key.
    
    p_keylen - Length of the key buffer provided.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getKey
```
int getKey(byte[] p_buffer,
           int p_keylen)
    throws FilesystemException
```
    Get key at the current position.
    
    Parameters:
    
    p_buffer - Buffer in which to place the key.
    
    p_keylen - Length of the key buffer provided.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getKey
```
int getKey(byte[] p_buffer,
           int p_keylen,
           int p_timeout)
    throws FilesystemException
```
    Get key at the current position.
    
    Parameters:
    
    p_buffer - Buffer in which to place the key.
    
    p_keylen - Length of the key buffer provided.
    
    p_timeout - Timeout value in seconds for the operation.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getKey
```
int getKey(long p_index,
           byte[] p_buffer,
           int p_keylen,
           int p_timeout)
    throws FilesystemException
```
    Get key at the index.
    
    Parameters:
    
    p_index - Index to get key.
    
    p_buffer - Buffer in which to place the key.
    
    p_keylen - Length of the key buffer provided.
    
    p_timeout - Timeout value in seconds for the operation.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getNumKey
```
int getNumKey(byte[] p_buffer,
              int p_keylen,
              int p_keyNumber)
       throws FilesystemException
```
    Get key at the current position.
    
    Parameters:
    
    p_buffer - Buffer in which to place the key.
    
    p_keylen - Length of the key buffer provided.
    
    p_keyNumber - Which key number to get the key for.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getNumKey
```
int getNumKey(byte[] p_buffer,
              int p_keylen,
              java.lang.String p_keyName)
       throws FilesystemException
```
    Get key at the current position.
    
    Parameters:
    
    p_buffer - Buffer in which to place the key.
    
    p_keylen - Length of the key buffer provided.
    
    p_keyName - Which key name to get the key for.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getNumKey
```
int getNumKey(byte[] p_buffer,
              int p_keylen,
              int p_keyNumber,
              int p_timeout)
       throws FilesystemException
```
    Get key at the current position.
    
    Parameters:
    
    p_buffer - Buffer in which to place the key.
    
    p_keylen - Length of the key buffer provided.
    
    p_keyNumber - Which key number to get the key for.
    
    p_timeout - Timeout value in seconds for the operation.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getNumKey
```
int getNumKey(byte[] p_buffer,
              int p_keylen,
              java.lang.String p_keyName,
              int p_timeout)
       throws FilesystemException
```
    Get key at the current position.
    
    Parameters:
    
    p_buffer - Buffer in which to place the key.
    
    p_keylen - Length of the key buffer provided.
    
    p_keyName - Which key name to get the key for.
    
    p_timeout - Timeout value in seconds for the operation.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getFirstKey
```
int getFirstKey(byte[] p_buffer)
         throws FilesystemException
```
    Get first key in current key number.
    
    Parameters:
    
    p_buffer - Buffer in which to place the key.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getFirstKey
```
int getFirstKey(byte[] p_buffer,
                int p_keylen)
         throws FilesystemException
```
    Get first key in current key number.
    
    Parameters:
    
    p_buffer - Buffer in which to place the key.
    
    p_keylen - Length of key buffer provided.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getFirstKey
```
int getFirstKey(byte[] p_buffer,
                int p_keylen,
                int p_timeout)
         throws FilesystemException
```
    Get first key in current key number.
    
    Parameters:
    
    p_buffer - Buffer in which to place the key.
    
    p_keylen - Length of key buffer provided.
    
    p_timeout - Timeout value in seconds for the operation.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getLastKey
```
int getLastKey(byte[] p_buffer)
        throws FilesystemException
```
    Get last key in current key number.
    
    Parameters:
    
    p_buffer - Buffer in which to place the key.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getLastKey
```
int getLastKey(byte[] p_buffer,
               int p_keylen)
        throws FilesystemException
```
    Get last key in current key number.
    
    Parameters:
    
    p_buffer - Buffer in which to place the key.
    
    p_keylen - Length of key buffer provided.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getLastKey
```
int getLastKey(byte[] p_buffer,
               int p_keylen,
               int p_timeout)
        throws FilesystemException
```
    Get last key in current key number.
    
    Parameters:
    
    p_buffer - Buffer in which to place the key.
    
    p_keylen - Length of key buffer provided.
    
    p_timeout - Timeout value in seconds for the operation.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getNextKey
```
int getNextKey(byte[] p_buffer)
        throws FilesystemException
```
    Get next key at the current position.
    
    Parameters:
    
    p_buffer - Buffer in which to place the key.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getNextKey
```
int getNextKey(byte[] p_buffer,
               int p_keylen)
        throws FilesystemException
```
    Get next key at the current position.
    
    Parameters:
    
    p_buffer - Buffer in which to place the key.
    
    p_keylen - Length of key buffer provided.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getNextKey
```
int getNextKey(long p_index,
               byte[] p_buffer,
               int p_keylen)
        throws FilesystemException
```
    Get next key at index.
    
    Parameters:
    
    p_index - Index of key.
    
    p_buffer - Buffer in which to place the key.
    
    p_keylen - Length of key buffer provided.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getNextKey
```
int getNextKey(byte[] p_buffer,
               int p_keylen,
               int p_timeout)
        throws FilesystemException
```
    Get next key at the current position.
    
    Parameters:
    
    p_buffer - Buffer in which to place the key.
    
    p_keylen - Length of key buffer provided.
    
    p_timeout - Timeout value in seconds for the operation.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getNextKey
```
int getNextKey(long p_index,
               byte[] p_buffer,
               int p_keylen,
               int p_timeout)
        throws FilesystemException
```
    Get next key at index.
    
    Parameters:
    
    p_index - Index of key.
    
    p_buffer - Buffer in which to place the key.
    
    p_keylen - Length of key buffer provided.
    
    p_timeout - Timeout value in seconds for the operation.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getPreviousKey
```
int getPreviousKey(byte[] p_buffer)
            throws FilesystemException
```
    Get previous key at the current position.
    
    Parameters:
    
    p_buffer - Buffer in which to place the key.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getPreviousKey
```
int getPreviousKey(byte[] p_buffer,
                   int p_keylen)
            throws FilesystemException
```
    Get previous key at the current position.
    
    Parameters:
    
    p_buffer - Buffer in which to place the key.
    
    p_keylen - Length of key buffer provided.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getPreviousKey
```
int getPreviousKey(long p_index,
                   byte[] p_buffer,
                   int p_keylen)
            throws FilesystemException
```
    Get previous key at index.
    
    Parameters:
    
    p_index - Index of key.
    
    p_buffer - Buffer in which to place the key.
    
    p_keylen - Length of key buffer provided.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getPreviousKey
```
int getPreviousKey(byte[] p_buffer,
                   int p_keylen,
                   int p_timeout)
            throws FilesystemException
```
    Get previous key at the current position.
    
    Parameters:
    
    p_buffer - Buffer in which to place the key.
    
    p_keylen - Length of key buffer provided.
    
    p_timeout - Timeout value in seconds for the operation.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - getPreviousKey
```
int getPreviousKey(long p_index,
                   byte[] p_buffer,
                   int p_keylen,
                   int p_timeout)
            throws FilesystemException
```
    Get previous key at index.
    
    Parameters:
    
    p_index - Index of key.
    
    p_buffer - Buffer in which to place the key.
    
    p_keylen - Length of key buffer provided.
    
    p_timeout - Timeout value in seconds for the operation.
    
    Returns:
    
    Number of bytes in the key.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.
  - update
```
void update(byte[] p_old,
            int p_oldSize,
            byte[] p_new,
            int p_newSize,
            int p_timeout)
     throws FilesystemException
```
    Function to call for safe record updates. This function makes sure that the record has not changed before updating it.
    
    Parameters:
    
    p_old - Old record.
    
    p_oldSize - Old record size.
    
    p_new - New record.
    
    p_newSize - New record size.
    
    Throws:
    
    FilesystemException - if update cannot occur.
  - update
```
void update(byte[] p_key,
            int p_keylen,
            byte[] p_old,
            int p_oldSize,
            byte[] p_new,
            int p_newSize,
            int p_timeout)
     throws FilesystemException
```
    Function to call for safe record updates on files with a specified key. This function makes sure that the record has not changed before updating it.
    
    Parameters:
    
    p_key - Key for update record.
    
    p_keylen - Length of update key.
    
    p_old - Old record.
    
    p_oldSize - Old record size.
    
    p_new - New record.
    
    p_newSize - New record size.
    
    Throws:
    
    FilesystemException - if update cannot occur.
  - update
```
void update(byte[] p_oldKey,
            int p_oldkeylen,
            byte[] p_old,
            int p_oldSize,
            byte[] p_newKey,
            int p_newkeylen,
            byte[] p_new,
            int p_newSize,
            int p_timeout)
     throws FilesystemException
```
    Function to call for safe record updates on files with a specified key (old and new). This function makes sure that the record has not changed before updating it.
    
    Parameters:
    
    p_oldKey - Key for update record.
    
    p_oldkeylen - Length of update key.
    
    p_old - Old record.
    
    p_oldSize - Old record size.
    
    p_newKey - New key for update record.
    
    p_newkeylen - Length on new update key.
    
    p_new - New record.
    
    p_newSize - New record size.
    
    Throws:
    
    FilesystemException - if update cannot occur.
  - update
```
void update(long p_index,
            byte[] p_old,
            int p_oldSize,
            byte[] p_new,
            int p_newSize,
            int p_timeout)
     throws FilesystemException
```
    Function to call for safe record updates on files with indexes. This function makes sure that the record has not changed before updating it.
    
    Parameters:
    
    p_index - Index for update.
    
    p_old - Old record.
    
    p_oldSize - Old record size.
    
    p_new - New record.
    
    p_newSize - New record size.
    
    Throws:
    
    FilesystemException - if update cannot occur.
  - remove
```
void remove(long p_index)
     throws FilesystemException
```
    Remove the record indicated by an index.
    
    Parameters:
    
    p_index - Index of the record to remove.
    
    Throws:
    
    FilesystemException - If a filesystem problem occurs.

Interface LegacyFilePosition

Method Summary

Method Detail

read

read

read

read

read

read

read

read

read

read

read

read

read

read

extract

extract

extract

extract

extract

extract

extract

extract

extract

extract

extract

write

write

write

write

write

write

write

write

write

write

write

write

remove

remove

remove

remove

getKey

getKey

getKey

getKey

getKey

getNumKey

getNumKey

getNumKey

getNumKey

getFirstKey

getFirstKey

getFirstKey

getLastKey

getLastKey

getLastKey

getNextKey

getNextKey

getNextKey

getNextKey

getNextKey

getPreviousKey

getPreviousKey

getPreviousKey

getPreviousKey

getPreviousKey

update

update

update

update

remove