wa-sqlite
    Preparing search index...

    Interface SQLiteVFS

    SQLite Virtual File System object

    Objects with this interface can be passed to SQLiteAPI.vfs_register to define a new filesystem.

    There are synchronous and asynchronous example VFS classes in the repository.

    interface SQLiteVFS {
        mxPathname?: number;
        xAccess(
            pVfs: number,
            zName: number,
            flags: number,
            pResOut: number,
        ): number | Promise<number>;
        xCheckReservedLock(
            pFile: number,
            pResOut: number,
        ): number | Promise<number>;
        xClose(pFile: number): number | Promise<number>;
        xDelete(
            pVfs: number,
            zName: number,
            syncDir: number,
        ): number | Promise<number>;
        xDeviceCharacteristics(pFile: number): number | Promise<number>;
        xFileControl(
            pFile: number,
            op: number,
            pArg: number,
        ): number | Promise<number>;
        xFileSize(pFile: number, pSize: number): number | Promise<number>;
        xFullPathname(
            pVfs: number,
            zName: number,
            nOut: number,
            zOut: number,
        ): number | Promise<number>;
        xGetLastError(
            pVfs: number,
            nBuf: number,
            zBuf: number,
        ): number | Promise<number>;
        xLock(pFile: number, lockType: number): number | Promise<number>;
        xOpen(
            pVfs: number,
            zName: number,
            pFile: number,
            flags: number,
            pOutFlags: number,
        ): number | Promise<number>;
        xRead(
            pFile: number,
            pData: number,
            iAmt: number,
            iOffsetLo: number,
            iOffsetHi: number,
        ): number | Promise<number>;
        xSectorSize(pFile: number): number | Promise<number>;
        xSync(pFile: number, flags: number): number | Promise<number>;
        xTruncate(
            pFile: number,
            sizeLo: number,
            sizeHi: number,
        ): number | Promise<number>;
        xUnlock(pFile: number, lockType: number): number | Promise<number>;
        xWrite(
            pFile: number,
            pData: number,
            iAmt: number,
            iOffsetLo: number,
            iOffsetHi: number,
        ): number | Promise<number>;
    }
    Index
    mxPathname?
    xAccess xCheckReservedLock xClose xDelete xDeviceCharacteristics xFileControl xFileSize xFullPathname xGetLastError xLock xOpen xRead xSectorSize xSync xTruncate xUnlock xWrite
    mxPathname?: number

    Maximum length of a file path in UTF-8 bytes (default 64)

    • Parameters

      • pVfs: number
      • zName: number
      • flags: number
      • pResOut: number

      Returns number | Promise<number>

      https://sqlite.org/c3ref/vfs.html

    • Parameters

      • pVfs: number
      • zName: number
      • syncDir: number

      Returns number | Promise<number>

      https://sqlite.org/c3ref/vfs.html

    • Parameters

      • pFile: number
      • op: number
      • pArg: number

      Returns number | Promise<number>

      https://sqlite.org/c3ref/io_methods.html

    • Parameters

      • pVfs: number
      • zName: number
      • nOut: number
      • zOut: number

      Returns number | Promise<number>

      https://sqlite.org/c3ref/vfs.html

    • Parameters

      • pVfs: number
      • nBuf: number
      • zBuf: number

      Returns number | Promise<number>

      https://sqlite.org/c3ref/vfs.html

    • Parameters

      • pVfs: number
      • zName: number
      • pFile: number
      • flags: number
      • pOutFlags: number

      Returns number | Promise<number>

      https://sqlite.org/c3ref/vfs.html

    • Parameters

      • pFile: number
      • pData: number
      • iAmt: number
      • iOffsetLo: number
      • iOffsetHi: number

      Returns number | Promise<number>

      https://sqlite.org/c3ref/io_methods.html

    • Parameters

      • pFile: number
      • sizeLo: number
      • sizeHi: number

      Returns number | Promise<number>

      https://sqlite.org/c3ref/io_methods.html

    • Parameters

      • pFile: number
      • pData: number
      • iAmt: number
      • iOffsetLo: number
      • iOffsetHi: number

      Returns number | Promise<number>

      https://sqlite.org/c3ref/io_methods.html

    Settings
    Member Visibility

    On This Page
    Properties
    Methods