ATSIFIO Function Reference – Version 0.2
AT_U32 ATSIF_SetFileAccessMode(ATSIF_ReadMode _mode)
Description This function is used to select if the entire SIF file should be read or just the header section. The read
mode is decided using the ATSIF_ReadMode enumeration which has the following values:-
ATSIF_ReadAll
ATSIF_ReadHeaderOnly
Arguments ATSIF_ReadMode _mode: The enumeration for selecting the SIF file read mode
Return See list of possible return codes in this document
AT_U32 ATSIF_ReadFromFile(AT_C * _sz_filename)
Description This function is used to open a SIF file where the file name and path are contained in the character array
_sz_filename.
Arguments AT_C * _sz_filename: The character array containing the SIF file path and file name
Return See list of possible return codes in this document
Note If the file is opened with an access mode of ATSIF_ReadAll then ATSIF_CloseFile must be called to free
access to the file.
AT_U32 ATSIF_CloseFile()
Description This function is used to close the currently opened SIF file. This should be called whenever the SIF has
been opened using the ATSIF_ReadAll enumeration and is no longer needed by the calling program.
Arguments none
Return See list of possible return codes in this document
AT_U32 ATSIF_ReadFromByteArray(AT_U8 * _buffer, AT_U32 _ui_bufferSize)
Reserved Function
AT_U32 ATSIF_IsLoaded(AT_32 * _i_loaded)
Description This function is used to determine if a SIF file is currently loaded. _i_loaded will be 0 if there is no file
loaded and 1 if a file is loaded.
Arguments AT_32 * _i_loaded: 0 – No SIF file currently loaded
1 – SIF file currently loaded
Return See list of possible return codes in this document
评论5