Gammu API  1.38.0
Backup

Data Structures

struct  GSM_SMS_Backup
 
struct  GSM_Backup
 
struct  GSM_Backup_Info
 

Macros

#define GSM_BACKUP_MAX_PHONEPHONEBOOK   1001
 
#define GSM_BACKUP_MAX_SIMPHONEBOOK   251
 
#define GSM_BACKUP_MAX_CALLER   101
 
#define GSM_BACKUP_MAX_SMSC   10
 
#define GSM_BACKUP_MAX_WAPBOOKMARK   40
 
#define GSM_BACKUP_MAX_WAPSETTINGS   30
 
#define GSM_BACKUP_MAX_MMSSETTINGS   30
 
#define GSM_BACKUP_MAX_SYNCMLSETTINGS   30
 
#define GSM_BACKUP_MAX_CHATSETTINGS   30
 
#define GSM_BACKUP_MAX_RINGTONES   30
 
#define GSM_BACKUP_MAX_PROFILES   10
 
#define GSM_BACKUP_MAX_FMSTATIONS   20
 
#define GSM_BACKUP_MAX_GPRSPOINT   10
 
#define GSM_BACKUP_MAX_NOTE   50
 

Enumerations

enum  GSM_BackupFormat {
  GSM_Backup_Auto = 0, GSM_Backup_AutoUnicode = 1, GSM_Backup_LMB, GSM_Backup_VCalendar,
  GSM_Backup_VCard, GSM_Backup_LDIF, GSM_Backup_ICS, GSM_Backup_Gammu,
  GSM_Backup_GammuUCS2, GSM_Backup_VNote
}
 

Functions

GSM_Error GSM_ReadSMSBackupFile (const char *FileName, GSM_SMS_Backup *backup)
 
GSM_Error GSM_AddSMSBackupFile (const char *FileName, GSM_SMS_Backup *backup)
 
void GSM_ClearSMSBackup (GSM_SMS_Backup *backup)
 
void GSM_FreeSMSBackup (GSM_SMS_Backup *backup)
 
GSM_Error GSM_SaveBackupFile (char *FileName, GSM_Backup *Backup, GSM_BackupFormat Format)
 
GSM_BackupFormat GSM_GuessBackupFormat (const char *FileName, const gboolean UseUnicode)
 
GSM_Error GSM_ReadBackupFile (const char *FileName, GSM_Backup *backup, GSM_BackupFormat Format)
 
void GSM_ClearBackup (GSM_Backup *backup)
 
void GSM_FreeBackup (GSM_Backup *backup)
 
void GSM_GetBackupFormatFeatures (GSM_BackupFormat Format, GSM_Backup_Info *info)
 
void GSM_GetBackupFileFeatures (GSM_BackupFormat Format, GSM_Backup_Info *info, GSM_Backup *backup)
 

Detailed Description

Backups manipulations.

Macro Definition Documentation

§ GSM_BACKUP_MAX_CALLER

#define GSM_BACKUP_MAX_CALLER   101

Maximal number of caller groups in backup.

Todo:
This should not be hardcoded.

Definition at line 114 of file gammu-backup.h.

§ GSM_BACKUP_MAX_CHATSETTINGS

#define GSM_BACKUP_MAX_CHATSETTINGS   30

Maximal number of chat settings in backup.

Todo:
This should not be hardcoded.

Definition at line 162 of file gammu-backup.h.

§ GSM_BACKUP_MAX_FMSTATIONS

#define GSM_BACKUP_MAX_FMSTATIONS   20

Maximal number of FM stations in backup.

Todo:
This should not be hardcoded.

Definition at line 186 of file gammu-backup.h.

§ GSM_BACKUP_MAX_GPRSPOINT

#define GSM_BACKUP_MAX_GPRSPOINT   10

Maximal number of GPRS points in backup.

Todo:
This should not be hardcoded.

Definition at line 194 of file gammu-backup.h.

§ GSM_BACKUP_MAX_MMSSETTINGS

#define GSM_BACKUP_MAX_MMSSETTINGS   30

Maximal number of MMS settings in backup.

Todo:
This should not be hardcoded.

Definition at line 146 of file gammu-backup.h.

§ GSM_BACKUP_MAX_NOTE

#define GSM_BACKUP_MAX_NOTE   50

Maximal number of notes in backup.

Todo:
This should not be hardcoded.

Definition at line 202 of file gammu-backup.h.

§ GSM_BACKUP_MAX_PHONEPHONEBOOK

#define GSM_BACKUP_MAX_PHONEPHONEBOOK   1001

Maximal number of phonebook entries in backup.

Todo:
This should not be hardcoded.

Definition at line 98 of file gammu-backup.h.

§ GSM_BACKUP_MAX_PROFILES

#define GSM_BACKUP_MAX_PROFILES   10

Maximal number of profiles in backup.

Todo:
This should not be hardcoded.

Definition at line 178 of file gammu-backup.h.

§ GSM_BACKUP_MAX_RINGTONES

#define GSM_BACKUP_MAX_RINGTONES   30

Maximal number of ringtones in backup.

Todo:
This should not be hardcoded.

Definition at line 170 of file gammu-backup.h.

§ GSM_BACKUP_MAX_SIMPHONEBOOK

#define GSM_BACKUP_MAX_SIMPHONEBOOK   251

Maximal number of SIM entries in backup.

Todo:
This should not be hardcoded.

Definition at line 106 of file gammu-backup.h.

§ GSM_BACKUP_MAX_SMSC

#define GSM_BACKUP_MAX_SMSC   10

Maximal number of SMSC in backup.

Todo:
This should not be hardcoded.

Definition at line 122 of file gammu-backup.h.

§ GSM_BACKUP_MAX_SYNCMLSETTINGS

#define GSM_BACKUP_MAX_SYNCMLSETTINGS   30

Maximal number of SyncML settings in backup.

Todo:
This should not be hardcoded.

Definition at line 154 of file gammu-backup.h.

§ GSM_BACKUP_MAX_WAPBOOKMARK

#define GSM_BACKUP_MAX_WAPBOOKMARK   40

Maximal number of WAP bookmarks in backup.

Todo:
This should not be hardcoded.

Definition at line 130 of file gammu-backup.h.

§ GSM_BACKUP_MAX_WAPSETTINGS

#define GSM_BACKUP_MAX_WAPSETTINGS   30

Maximal number of WAP settings in backup.

Todo:
This should not be hardcoded.

Definition at line 138 of file gammu-backup.h.

Enumeration Type Documentation

§ GSM_BackupFormat

Backup data.

Enumerator
GSM_Backup_Auto 

Compatibility with old gboolean used instead of format.

File type is guessed for extension, non unicode format used for Gammu backup.

GSM_Backup_AutoUnicode 

Compatibility with old gboolean used instead of format.

File type is guessed for extension, unicode format used for Gammu backup.

GSM_Backup_LMB 

LMB format, compatible with Logo manager, can store phonebooks and logos.

GSM_Backup_VCalendar 

vCalendar standard, can store todo and calendar entries.

GSM_Backup_VCard 

vCard standard, can store phone phonebook entries.

GSM_Backup_LDIF 

LDIF (LDAP Data Interchange Format), can store phone phonebook entries.

GSM_Backup_ICS 

iCalendar standard, can store todo and calendar entries.

GSM_Backup_Gammu 

Gammu own format can store almost anything from phone.

This is ASCII version of the format, Unicode strings are HEX encoded. Use GSM_Backup_GammuUCS2 instead if possible.

GSM_Backup_GammuUCS2 

Gammu own format can store almost anything from phone.

This is UCS2-BE version of the format.

GSM_Backup_VNote 

vNote standard, can store phone notes.

Definition at line 317 of file gammu-backup.h.

Function Documentation

§ GSM_AddSMSBackupFile()

GSM_Error GSM_AddSMSBackupFile ( const char *  FileName,
GSM_SMS_Backup backup 
)

Adds data to SMS backup file.

Parameters
FileNamefile name
backupstructure holding backup data
Returns
Error code

§ GSM_ClearBackup()

void GSM_ClearBackup ( GSM_Backup backup)

Clears backup structure

Parameters
backupstructure where backup data will be stored

§ GSM_ClearSMSBackup()

void GSM_ClearSMSBackup ( GSM_SMS_Backup backup)

Clears SMS backup structure

Parameters
backupstructure where backup data will be stored

§ GSM_FreeBackup()

void GSM_FreeBackup ( GSM_Backup backup)

Deallocates all members of backup structure

Parameters
backupstructure where backup data will be stored

§ GSM_FreeSMSBackup()

void GSM_FreeSMSBackup ( GSM_SMS_Backup backup)

Deallocates all members of SMS backup structure

Parameters
backupstructure where backup data will be stored

§ GSM_GetBackupFileFeatures()

void GSM_GetBackupFileFeatures ( GSM_BackupFormat  Format,
GSM_Backup_Info info,
GSM_Backup backup 
)

Gets information about backup data features (resp. which data it contains).

Parameters
FormatFormat of backup.
infoOutput information about backup features.
backupBackup data to chech.

§ GSM_GetBackupFormatFeatures()

void GSM_GetBackupFormatFeatures ( GSM_BackupFormat  Format,
GSM_Backup_Info info 
)

Gets information about format features.

Parameters
FormatFormat of backup.
infoOutput information about backup features.

§ GSM_GuessBackupFormat()

GSM_BackupFormat GSM_GuessBackupFormat ( const char *  FileName,
const gboolean  UseUnicode 
)

Guesses backup format based on filename.

Parameters
FileNameName of backup filename.
UseUnicodeWhether to prefer unicode variant when guessing.
Returns
Backup format on success -1 on error.

§ GSM_ReadBackupFile()

GSM_Error GSM_ReadBackupFile ( const char *  FileName,
GSM_Backup backup,
GSM_BackupFormat  Format 
)

Reads data from backup file.

Parameters
FileNameName of file (format is detected from it).
backupstructure where backup data will be stored
FormatFormat of backup. For Gammu backups, unicode subformats are ignored.
Returns
Error code

§ GSM_ReadSMSBackupFile()

GSM_Error GSM_ReadSMSBackupFile ( const char *  FileName,
GSM_SMS_Backup backup 
)

Reads SMS backup file.

Parameters
FileNamefile name
backupstructure where backup will be stored
Returns
Error code

§ GSM_SaveBackupFile()

GSM_Error GSM_SaveBackupFile ( char *  FileName,
GSM_Backup Backup,
GSM_BackupFormat  Format 
)

Save backup file.

Parameters
FileNameName of file (format is detected from it).
Backupstructure holding backup data
FormatBackup format.
Returns
Error code