Unit al5memfile

Uses
Classes, Interfaces, Objects and Records
Types
Constants
Variables

Description

Defines the memfile interface.

The memfile interface allows you to treat a fixed block of contiguous memory as a file that can be used with Allegro's I/O functions.

Overview

Functions and Procedures

function al_open_memfile (mem: AL_POINTER; size: AL_INT64; const mode: AL_STR): ALLEGRO_FILEptr; CDECL; external ALLEGRO_MEMFILE_LIB_NAME;
function al_get_allegro_memfile_version: AL_UINT64; CDECL; external ALLEGRO_MEMFILE_LIB_NAME;

Description

Functions and Procedures

function al_open_memfile (mem: AL_POINTER; size: AL_INT64; const mode: AL_STR): ALLEGRO_FILEptr; CDECL; external ALLEGRO_MEMFILE_LIB_NAME;

Returns a file handle to the block of memory. All read and write operations act upon the memory directly, so it must not be freed while the file remains open.

The mode can be any combination of 'r' (readable) and 'w' (writable). Regardless of the mode, the file always opens at position 0. The file size is fixed and cannot be expanded. The file is always read from/written to in binary mode, which means that no newline translation is performed.

It should be closed with al_fclose. After the file is closed, you are responsible for freeing the memory (if needed).

function al_get_allegro_memfile_version: AL_UINT64; CDECL; external ALLEGRO_MEMFILE_LIB_NAME;

Returns the (compiled) version of the addon, in the same format as al_get_allegro_version.


Generated by PasDoc 0.15.0. Generated on 2024-11-10 15:15:06.