Список методов в категории File:
WriteString2
Описание
Записывает строку в данный файл, который должен быть открыт для записи. Обратите внимание, что эта команда не предназначена для удобочитаемых файлов и должна использоваться только для файлов, которые позже будут прочитаны с помощью ReadString2. Для создания удобочитаемых файлов используйте WriteLine Это использует другой метод от WriteString, который будет быстрее для чтения AGK позже, но он не совместим с ReadString, вы должны использовать ReadString2 для чтения строк, написанных с помощью WriteString2
Определение
void agk::WriteString2( UINT iFileID, const char* str )
Параметры
iFileID - Идентификатор файла для изменения.
str - Строка для записи.
Пример кода
WriteLine
Описание
Записывает завершенную строку CR(\n) в данный файл, который должен быть открыт для записи.
Определение
void agk::WriteLine( UINT iFileID, const char* str )
Параметры
iFileID - Идентификатор файла для изменения.
str - Строка для записи.
Пример кода
WriteString
Описание
Записывает строку с нулевым завершением в данный файл, который должен быть открыт для записи. Обратите внимание, что эта команда не предназначена для удобочитаемых файлов и должна использоваться только для файлов, которые позже будут прочитаны с помощью ReadString. Для создания удобочитаемых файлов используйте WriteLine
Определение
void agk::WriteString( UINT iFileID, const char* str )
Параметры
iFileID - Идентификатор файла для изменения.
str - Строка для записи.
Пример кода
WriteFloat
Описание
Записывает 4-байтовый float в данный файл, который должен быть открыт для записи. Обратите внимание, что эта команда не предназначена для удобочитаемых файлов и должна использоваться только для файлов, которые позже будут прочитаны с помощью ReadFloat. Для создания удобочитаемых файлов используйте WriteLine
Определение
void agk::WriteFloat( UINT iFileID, float f )
Параметры
iFileID - Идентификатор файла для изменения.
f - float, чтобы писать.
Пример кода
WriteInteger
Описание
Записывает 4-байтовое целое число в данный файл, который должен быть открыт для записи. Обратите внимание, что эта команда не предназначена для удобочитаемых файлов и должна использоваться только для файлов, которые позже будут прочитаны с помощью ReadInteger. Для создания удобочитаемых файлов используйте WriteLine
Определение
void agk::WriteInteger( UINT iFileID, int i )
Параметры
iFileID - Идентификатор файла для изменения.
i - Целое число для записи.
Пример кода
WriteByte
Описание
Записывает 1-байтовое целое число без знака (0-255) в данный файл, который должен быть открыт для записи. Обратите внимание, что эта команда не предназначена для удобочитаемых файлов и должна использоваться только для файлов, которые позже будут считываться с помощью ReadByte. Для создания удобочитаемых файлов используйте WriteLine
Определение
void agk::WriteByte( UINT iFileID, int b )
Параметры
iFileID - Идентификатор файла для изменения.
b - Байт для записи.
Пример кода
SimplifyPath
Описание
Удаляет любые вхождения ../ or ..\ и соответствующим образом сокращает путь, удаляя папки. Также заменяет все задние косые черты на передние косые черты, так как передние косые черты будут работать на любой платформе. Это работает как с относительными, так и с абсолютными путями, если путь абсолютен, то все вхождения ../ будут удалены, даже если их слишком много. Если путь относителен, то любые вхождения../, которые запускают путь, не будут удалены. Например, относительный путь ../../MyFile.txt не может быть упрощено далее, в то время как C:/../../MyFile.txt будет преобразован в C:/MyFile.txt. Путь может начинаться с префикса raw: или нет, принимаются оба варианта. Если вы используете эту функцию в Tier 2, то вы должны удалить возвращаемую строку с помощью agk::DeleteString (), когда закончите с ней.
Определение
char* agk::SimplifyPath( const char *szPath )
Параметры
szPath - Путь к упрощению
Пример кода
SetRawWritePath
Описание
Задает папку, в которой будут храниться файлы, созданные AGK. Это никак не влияет на iOS, так как она не может писать вне своей папки приложения. Вы можете установить его на любой абсолютный путь на устройстве, однако некоторые места, такие как папка Program Files в Windows, потребуют прав администратора для записи в них. Некоторые места будут защищены операционной системой, SetRawWritePath позволит вам установить путь к этим местам, но любая попытка записи в них потерпит неудачу. Вы можете использовать GetDocumentsPath, чтобы получить системную папку документов для текущего пользователя или папку sdcard на Android, которая гарантированно разрешит доступ на запись. Эта команда теперь устарела. Предпочтительным способом доступа к файлам за пределами обычной папки записи является использование команд OpenRawFolder и путей к файлам raw:.
Определение
void agk::SetRawWritePath( const char* str )
Параметры
str - Путь для использования в качестве папки записи
Пример кода
SetFolder
Описание
При обычном использовании вашему приложению AGK доступны только две папки: папка чтения и папка записи. Папка чтения - это расположение исполняемого файла, включающее папку мультимедиа. Папка записи (которая также имеет разрешение на чтение) находится в безопасном месте платформы и отличается в зависимости от устройства. Например, в Windows по умолчанию используется следующее место записи: C:\Users\username\AppData\AGKApps\appName (По умолчанию это скрытая папка в Windows, и вам, возможно, придется показать скрытые файлы, чтобы увидеть ее). Это ваши корневые папки. Любые файлы, созданные/записанные с помощью OpenToWrite, будут сохранены в папке записи. Для простоты AGK объединяет эти две папки чтения и записи в один набор команд. Это означает, что при попытке открыть или загрузить файл AGK сначала будет искать в папке записи, а затем в папке чтения. При использовании SetFolder его поведение соответствует тому, что вы ожидаете от команды CD в консоли Windows или Linux; Он работает из текущего каталога. Например, если текущая папка чтения C:\games\myApp\ затем SetFolder(images) поместит вас в C:\games\myApp\images. Вызов команды во второй раз с помощью SetFolder(backgrounds) приведет вас в C:\games\myApp\images\backgrounds. Есть два способа вернуться на базовый путь. Первый-вызвать SetFolder (), используя пустую строку. Другой способ-предварить свой путь прямой косой чертой, SetFolder(/stuff). Это также относится и к загрузке ваших файлов с помощью других команд. Предположим, что вы все еще находитесь в папках images\backgrounds и хотите загрузить файл bk.png, расположенный в основании папки read. Вы можете просто сказать LoadImage(/bk.png), который будет загружаться C:\games\myApp\bk.png. Установка пути к несуществующей папке и использование OpenToWrite создаст эту папку в пути записи. SetFolder не проверяет, существует ли папка, он просто устанавливает внутренний путь, который будет использоваться в следующей команде file. По умолчанию AGK первым делом вызывает SetFolder(media). Эта команда возвращает 1 при успешном выполнении или 0, если вы используете недопустимый путь, такой как SetFolder(C:). Примечание: При настройке путей важно помнить, что всегда следует использовать косую черту вперед, а не обратную. AGK преобразует их в соответствующий файловый разделитель для данной платформы. Если вы хотите получить доступ к файлам вне папок чтения и записи, вы можете использовать обычные файловые команды, такие как OpenToRead с путем к файлу raw:, см. Эту команду для получения более подробной информации. Для доступа к папкам вне папок чтения и записи можно использовать команды OpenRawFolder.
Определение
int agk::SetFolder( const char* str )
Параметры
str - Путь к папке для установки
Пример кода
SetFilePos
Описание
Задает текущую позицию чтения в файле
Определение
void agk::SetFilePos( UINT iFileID, int pos )
Параметры
iFileID - Идентификатор файла для проверки.
pos - Новая позиция для продолжения чтения
Пример кода
SetCurrentDir
Описание
Эта команда устарела и была заменена на SetFolder.
Определение
int agk::SetCurrentDir( const char* szPath )
Параметры
szPath - Каталог, который будет использоваться в качестве нового текущего каталога.
Пример кода
ReadString2
Описание
Считывает строку из данного файла, который должен быть открыт для чтения. Обратите внимание, что это может читать только строки в двоичной форме, такие как те, которые написаны с помощью WriteString2, если вы пытаетесь прочитать строки, разделенные новыми строками, то вместо этого используйте ReadLine. Если вы используете эту команду на уровне 2, вы должны удалить возвращенную строку с помощью agk::DeleteString, когда закончите с ней. Это использует другой метод от ReadString, который немного быстрее, но эта команда может читать только строки, написанные с помощью WriteString2
Определение
char* agk::ReadString2( UINT iFileID )
Параметры
iFileID - Идентификатор файла для чтения.
Пример кода
ReadString
Описание
Считывает строку с нулевым завершением из данного файла, который должен быть открыт для чтения. Обратите внимание, что это может читать только строки в двоичной форме, такие как те, которые написаны с помощью WriteString, если вы пытаетесь прочитать строки, разделенные новыми строками, то вместо этого используйте ReadLine. Если вы используете эту команду на уровне 2, вы должны удалить возвращенную строку с помощью agk::DeleteString, когда закончите с ней.
Определение
char* agk::ReadString( UINT iFileID )
Параметры
iFileID - Идентификатор файла для чтения.
Пример кода
ReadLine
Описание
Считывает новую строку, завершенную строкой из данного файла, который должен быть открыт для чтения. Если вы используете эту команду на уровне 2, вы должны удалить возвращенную строку с помощью agk::DeleteString, когда закончите с ней.
Определение
char* agk::ReadLine( UINT iFileID )
Параметры
iFileID - Идентификатор файла для чтения.
Пример кода
ReadInteger
Описание
Считывает 4-байтовое целое число из данного файла, который должен быть открыт для чтения.
Определение
int agk::ReadInteger( UINT iFileID )
Параметры
iFileID - Идентификатор файла для чтения.
Пример кода
ReadByte
Описание
Считывает 1-байтовое целое число без знака (0-255) из данного файла, который должен быть открыт для чтения.
Определение
int agk::ReadByte( UINT iFileID )
Параметры
iFileID - Идентификатор файла для чтения.
Пример кода
ReadFloat
Описание
Считывает 4-байтовый float из данного файла, который должен быть открыт для чтения.
Определение
float agk::ReadFloat( UINT iFileID )
Параметры
iFileID - Идентификатор файла для чтения.
Пример кода
OpenToWrite
Описание
Открывает файл, хранящийся в локальной файловой системе, для записи в указанный идентификатор. Все платформы ограничены одной папкой для записи, поэтому пути к файлам должны быть относительными, а не абсолютными. Эта папка записи не является той же папкой, что и само приложение, поэтому изображения, звуки и само приложение не могут быть перезаписаны. Файлы, записанные в эту папку, можно читать с помощью OpenToRead. Если файл не существует, он будет создан, если файл существует, он будет перезаписан, если append равен 0. или добавлен, если append равен 1. Если каталог указан в имени файла и не существует, он будет создан. Чтобы записать файл вне обычной папки записи, вы можете использовать raw:, за которым следует абсолютный путь для текущей платформы, например raw:C:\MyFolder\MyFile.txt на окнах или raw:/sdcard/Documents/MyFile.txt-на Андроиде. Если какие-либо папки в выбранном вами пути не существуют, они будут созданы. На Raspberry Pi вы можете использовать эту команду, чтобы открыть pin-код GPIO для записи, используя имя файла gpio:, за которым следует номер pin-кода GPIO, например OpenToWrite(1, gpio:4), это чувствительно к регистру. Затем вы можете использовать writeByte для записи 0 или 1 в pin-код и CloseFile для закрытия pin-кода.
Определение
void agk::OpenToWrite( UINT ID, const char *szFile )
UINT agk::OpenToWrite( const char *szFile, int append )
UINT agk::OpenToWrite( const char *szFile )
void agk::OpenToWrite( UINT ID, const char *szFile, int append )
Параметры
ID - Идентификатор, который будет использоваться для ссылки на этот файл позже.
szFile - Имя файла, которое нужно открыть для записи.
append - Установите значение 1 для добавления в файл, 0 для перезаписи всех данных (необязательно, по умолчанию 0).
Пример кода
OpenToRead
Описание
Открывает файл, хранящийся в локальной файловой системе, для чтения в указанный идентификатор. Все платформы ограничены одной папкой для чтения и записи, поэтому пути к файлам должны быть относительными, а не абсолютными. Эта команда сначала проверит специальную папку записи, а если она не сможет найти файл, то проверит папку мультимедиа, так что вы можете загрузить изображения, звуки и другие связанные медиафайлы с помощью этой команды. Чтобы прочитать файл вне обычных папок чтения или записи, вы можете использовать raw:, за которым следует абсолютный путь для текущей платформы, например raw:C:\MyFolder\MyFile.txt на окнах или raw:/sdcard/Documents/MyFile.txt-на Андроиде. На Raspberry Pi вы можете использовать эту команду, чтобы открыть pin-код GPIO для чтения, используя имя файла gpio:, за которым следует номер pin-кода GPIO, например OpenToRead(1, gpio:4), это чувствительно к регистру. Затем вы можете использовать ReadByte для чтения из pin-кода и CloseFile для закрытия pin-кода.
Определение
void agk::OpenToRead( UINT ID, const char *szFile )
UINT agk::OpenToRead( const char *szFile )
Параметры
ID - Идентификатор, который будет использоваться для ссылки на этот файл позже.
szFile - Имя файла, которое нужно открыть для чтения.
Пример кода
OpenRawFolder
Описание
Открывает папку в любом месте файловой системы и считывает список содержащихся в ней файлов и папок. Это делается немедленно, поэтому любые изменения, которые происходят в папке после этой команды, не будут замечены, вам нужно будет вызвать эту команду снова, чтобы получить обновленное содержимое. Путь к файлу должен быть абсолютным для текущего устройства, то есть он должен начинаться с буквы диска и двоеточия в Windows и прямой косой черты на всех других платформах. Путь должен существовать и быть доступен для текущего приложения, иначе эта команда выдаст ошибку. Путь может начинаться с текста raw: или нет, принимаются обе формы. Эта команда вернет идентификатор, который вы можете использовать для доступа к найденному списку файлов, он будет оставаться доступным до тех пор, пока вы не закроете его с помощью CloseRawFolder. Несколько папок могут быть открыты одновременно, каждому из них будет присвоен свой идентификатор.
Определение
UINT agk::OpenRawFolder( const char *szPath )
Параметры
szPath - Путь к папке, которую нужно открыть
Пример кода
MakeFolder
Описание
Создает папку по текущему пути. По умолчанию это определяется командой SetFolder. Вы также можете использовать имя файла, начинающееся с raw:, чтобы создать папку в любом месте файловой системы, например MakeFolder(raw:C:\Temp\MyFolder)
Определение
int agk::MakeFolder( const char* szName )
Параметры
szName - Имя папки create.
Пример кода
JoinPaths
Описание
Соединяет два пути вместе и упрощает их, например, соединение пути с ../ удалит последнюю папку из пути. При необходимости между ними будет добавлена прямая косая черта, если первый путь заканчивается прямой косой чертой, а второй путь начинается с прямой косой черты, то один из них будет удален, чтобы сделать правильный путь. Любые обратные косые черты будут преобразованы в прямые косые черты. Первый путь может быть относительным или абсолютным, второй путь должен быть относительным. Это не будет проверено.
Определение
char* agk::JoinPaths( const char *szPath, const char *szPath2 )
Параметры
szPath - Первая часть пути
szPath2 - Вторая часть пути
Пример кода
IsAbsolutePath
Описание
Возвращает 1, если данный путь является абсолютным, 0, если он относителен. Это зависит от платформы, поэтому путь, начинающийся с C:/, считается абсолютным в Windows, но не в Linux, в то время как путь, начинающийся с прямой косой черты, считается абсолютным в Linux, но не в Windows. Путь может начинаться с префикса raw: или нет, принимаются оба варианта.
Определение
int agk::IsAbsolutePath( const char *szPath )
Параметры
szPath - Путь для проверки
Пример кода
GetZipExtractProgress
Описание
Возвращает значение от 0 до 100 для представления хода извлечения zip-файла, запущенного с помощью ExtractZipASync.
Определение
float agk::GetZipExtractProgress()
Параметры
Пример кода
GetZipExtractComplete
Описание
Возвращает 0, если выполняется извлечение zip-файла, начатое с помощью ExtractZipASync, или 1, если оно завершено. Он не дает указания на то, была ли добыча успешной, только на то, что она закончилась.
Определение
int agk::GetZipExtractComplete()
Параметры
Пример кода
GetWritePath
Описание
Возвращает каталог, в который будут записаны новые файлы на текущей платформе, на которой работает приложение.
Определение
char* agk::GetWritePath()
Параметры
Пример кода
GetWindowsDrive
Описание
Возвращает букву диска указанного диска, от 0 до CountWindowsDrives минус один. Значения вне этого диапазона будут возвращать пустую строку. Возвращаемая строка будет включать букву диска и двоеточие, больше ничего. Это относится только к Windows, другие платформы вернут пустую строку. Если вы вызываете эту команду из уровня 2, то вы должны удалить возвращенную строку с помощью agk::DeleteString (), когда закончите с ней.
Определение
char* agk::GetWindowsDrive( int index )
Параметры
index - Индекс диска для возврата
Пример кода
GetReadPath
Описание
Возвращает каталог, содержащий исполняемый файл приложения на текущей платформе, на которой оно запущено. Обратите внимание, что на Android этот путь недоступен при обычном использовании и вернет пустую строку.
Определение
char* agk::GetReadPath()
Параметры
Пример кода
GetRawFolderNumFiles
Описание
Возвращает количество файлов, найденных при вызове OpenRawFolder.
Определение
int agk::GetRawFolderNumFiles( UINT ID )
Параметры
ID - Идентификатор папки для проверки
Пример кода
GetRawFolderNumFolders
Описание
Возвращает количество папок, найденных при вызове OpenRawFolder.
Определение
int agk::GetRawFolderNumFolders( UINT ID )
Параметры
ID - Идентификатор папки для проверки
Пример кода
GetRawFolderFolderName
Описание
Возвращая конкретное имя папки из списка файлов, индекс должен быть в диапазоне от 0 до GetRawFolderNumFolders минус один.
Определение
char* agk::GetRawFolderFolderName( UINT ID, int index )
Параметры
ID - Идентификатор папки для проверки
index - Индекс возвращаемой папки, индексы начинаются с 0
Пример кода
GetRawFolderFileName
Описание
Возвращая конкретное имя файла из списка файлов, индекс должен быть в диапазоне от 0 до GetRawFolderNumFiles минус один.
Определение
char* agk::GetRawFolderFileName( UINT ID, int index )
Параметры
ID - Идентификатор папки для проверки
index - Индекс возвращаемого файла, индексы начинаются с 0
Пример кода
GetNextFolder
Описание
Возвращает имя следующей папки, найденной в текущей папке, которая задается с помощью SetFolder. GetFirstFolder должен быть вызван первым, чтобы это сработало, любой вызов SetFolder или OpenToWrite потребует повторного запуска с GetFirstFolder. Возвращает пустую строку, если в текущей папке больше нет папок. Не включает в себя . или ..
Определение
char* agk::GetNextFolder()
Параметры
Пример кода
GetNextFile
Описание
Возвращает имя следующего файла, найденного в текущей папке, который задается с помощью SetFolder. GetFirstFile должен быть вызван первым, чтобы это сработало, любой вызов SetFolder или OpenToWrite потребует повторного запуска с GetFirstFile. Возвращает пустую строку, если в текущей папке больше нет файлов.
Определение
char* agk::GetNextFile()
Параметры
Пример кода
GetFolderCount
Описание
Возвращает количество папок в текущей папке. Не включает в себя . или ..
Определение
int agk::GetFolderCount( int mode )
int agk::GetFolderCount()
Параметры
mode - 0 для подсчета только папок в папке чтения, 1 для подсчета только папки записи, 2 для подсчета обоих
Пример кода
GetFolder
Описание
Возвращает текущую папку, ранее заданную с помощью SetFolder. Возвращаемый путь всегда будет иметь косую черту в качестве конечного символа, за исключением случаев, когда в корневой папке будет возвращена пустая строка.
Определение
char* agk::GetFolder()
Параметры
Пример кода
GetFirstFolder
Описание
Возвращает имя первой папки, найденной в текущей папке, которая задается с помощью SetFolder. Вы можете вызвать GetNextFolder, чтобы продолжить вниз по списку папок в текущей папке. Возвращает пустую строку, если в текущей папке нет папок. Не включает в себя . или .. Обратите внимание, что на Android существует известное ограничение, что любые папки в папке активы не могут быть найдены с помощью этой команды. Вы можете обойти эту проблему, используя MakeFolder для создания той же структуры папок в папке write, которую AGK затем может использовать для поиска файлов в папке assets с помощью GetFirstFile. По умолчанию эта команда объединит списки папок из папок чтения и записи в один список (mode=2), который можно изменить на только возвращаемые папки в папке чтения (mode=0) или только возвращаемые папки из папки записи (mode=1)
Определение
char* agk::GetFirstFolder()
char* agk::GetFirstFolder( int mode )
Параметры
mode - 0 для возврата только папок из папки чтения, 1 для возврата только папок из папки записи, 2 для обоих (по умолчанию)
Пример кода
GetFirstFile
Описание
Возвращает имя первого файла, найденного в текущей папке, который задается с помощью SetFolder. Вы можете вызвать GetNextFile, чтобы продолжить вниз по списку файлов в текущей папке. Возвращает пустую строку, если в текущей папке нет файлов. По умолчанию эта команда объединит списки файлов из папок чтения и записи в один список (mode=2) это может быть изменено на возврат только файлов из папки чтения (mode=0) или только файлов из папки записи (mode=1) Обратите внимание, что папка чтения не существует при использовании широковещательной передачи или отладки для запуска приложения, так как файлы копируются в папку записи проигрывателя AGK для этих режимов запуска. С другой стороны, папка записи начинается как пустая при запуске приложения непосредственно из IDE или при запуске конечного исполняемого файла приложения в папке проекта.
Определение
char* agk::GetFirstFile( int mode )
char* agk::GetFirstFile()
Параметры
mode - 0 для возврата только файлов из папки чтения, 1 для возврата только файлов из папки записи, 2 для обоих (по умолчанию)
Пример кода
GetFilePos
Описание
Возвращает текущую позицию чтения в файле
Определение
int agk::GetFilePos( UINT iFileID )
Параметры
iFileID - Идентификатор файла для проверки.
Пример кода
GetFileSize
Описание
Возвращает размер открытого файла в байтах.
Определение
int agk::GetFileSize( UINT iFileID )
Параметры
iFileID - Идентификатор файла для проверки.
Пример кода
GetFileExists
Описание
Возвращает 1, если данный файл находится либо в каталоге ресурсов, либо в каталоге записи, назначенном приложению.
Определение
int agk::GetFileExists( const char *szFile )
Параметры
szFile - Имя файла для проверки.
Пример кода
GetFileCount
Описание
Возвращает количество файлов в текущей папке.
Определение
int agk::GetFileCount( int mode )
int agk::GetFileCount()
Параметры
mode - 0 для подсчета только файлов в папке чтения, 1 для подсчета только папки записи, 2 для подсчета обоих
Пример кода
GetDocumentsPath
Описание
Возвращает каталог, содержащий документы текущих пользователей. На Windows это будет что-то вроде C:\Users\Me\My Документы, на iOS это будет просто каталог записи приложения. По умолчанию все приложения записываются в указанную системой папку настроек приложения, например C:\Users\Me\AppData в Windows, /home/user/.config в Linux и защищенная папка данных приложения на Android. Там, где это возможно, содержимое пути к документам видно пользователю, например, на Android 10, а ниже будет папка sdcard. iOS и Android 11 и выше не могут предоставить общедоступное место для записи, поэтому вместо этого будет возвращен каталог записи приложения, который не виден пользователю.
Определение
char* agk::GetDocumentsPath()
Параметры
Пример кода
GetCurrentDir
Описание
Эта команда устарела и была заменена GetFolder.
Определение
char* agk::GetCurrentDir()
Параметры
Пример кода
FileIsOpen
Описание
Возвращает 1, если данный файл был успешно открыт, и 0, если нет. Вы можете использовать GetErrorOccurred, чтобы проверить, было ли это результатом ошибки, и GetLastError, чтобы получить указанную ошибку.
Определение
int agk::FileIsOpen( UINT iFileID )
Параметры
iFileID - Идентификатор файла для проверки.
Пример кода
FileEOF
Описание
Возвращает 1, если данный файл достиг конца своего потока данных, и 0 в противном случае. Используется только при чтении.
Определение
int agk::FileEOF( UINT iFileID )
Параметры
iFileID - Идентификатор файла для проверки.
Пример кода
ExtractZipASync
Описание
Эта команда делает то же самое, что и ExtractZip, за исключением того, что она возвращается немедленно, а извлечение zip выполняется в потоке в фоновом режиме. Вы можете использовать GetZipExtractProgress и GetZipExtractComplete, чтобы проверить его прогресс. Если вы вызовете эту команду во время извлечения zip-файла, то ничего не произойдет. Если указанный почтовый индекс не имеет пароля, то используйте пустую строку.
Определение
void agk::ExtractZipASync(const char* zipfilename, const char* path, const char* password)
Параметры
zipfilename - Путь к zip-файлу для извлечения.
path - Путь для размещения вновь извлеченных zip-файлов.
password - Пароль, который был использован для создания zip-файла.
Пример кода
ExtractZip
Описание
Извлекает zip-файл в указанный каталог. Все папки, созданные внутри zip-файла, будут созданы в процессе извлечения. Если zip - файл защищен паролем, укажите пароль для его извлечения. Если вы укажете неправильный пароль, извлеченные файлы из zip-архива будут пусты. Локальный путь к файлу находится относительно текущего каталога, установленного с помощью SetFolder, если только вы не начинаете путь с прямой косой черты, и в этом случае путь будет относительно корня каталога записи на текущей платформе.
Определение
void agk::ExtractZip(const char* zipfilename, const char* path, const char* password)
void agk::ExtractZip( const char* zipfilename, const char* path )
Параметры
zipfilename - Путь к zip-файлу для извлечения.
path - Путь для размещения вновь извлеченных zip-файлов.
password - Пароль, который был использован для создания zip-файла.
Пример кода
DeleteFolder
Описание
Удаляет папку по текущему пути. По умолчанию это определяется командой SetFolder. Вы также можете использовать имя файла, начинающееся с raw:, чтобы удалить папку в любом месте файловой системы, например DeleteFolder(raw:C:\Temp\MyFolder). Для успешного выполнения этой команды папка должна быть пустой.
Определение
void agk::DeleteFolder( const char* szName )
Параметры
szName - Имя папки create.
Пример кода
DeleteFile
Описание
Удаляет данный файл из папки записи. Пути к файлам должны быть относительными, а не абсолютными, вы не можете удалять файлы из папки приложения или из другого места на диске.
Определение
void agk::DeleteFile( const char *szFile )
Параметры
szFile - Имя файла для удаления.
Пример кода
CreateZip
Описание
Создает zip-файл в указанном месте и открывает его готовым для добавления файлов. Файлы не могут быть прочитаны или извлечены из zip-файла с помощью этой команды. Используйте ExtractZip для извлечения файлов из него. Путь к файлу относится к текущему каталогу, установленному с помощью SetFolder, если только вы не начинаете путь с прямой косой черты, и в этом случае путь будет относительно корня каталога записи на текущей платформе.
Определение
UINT agk::CreateZip( const char* filename )
void agk::CreateZip( UINT zipID, const char* filename )
Параметры
zipID - Идентификатор, используемый для ссылки на этот zip-файл.
filename - Имя файла и путь к этому новому zip-файлу.
Пример кода
CountWindowsDrives
Описание
Возвращает количество дисков, доступных в данный момент на этих устройствах, применяется только к Windows. Другие платформы вернут 0.
Определение
int agk::CountWindowsDrives()
Параметры
Пример кода
CloseZip
Описание
Закрывает zip-файл, открытый с помощью CreateZip. Это завершает работу zip-файла и позволяет открыть его для извлечения.
Определение
void agk::CloseZip( UINT zipID )
Параметры
zipID - Идентификатор zip-файла, который нужно закрыть.
Пример кода
CloseRawFolder
Описание
Закрывает ранее открытую папку и освобождает список файлов, который был сгенерирован для нее. Фактические изменения файловой системы не производятся, то есть папка не удерживается открытой в файловой системе. Папка читается полностью во время OpenRawFolder, поэтому она не должна существовать в файловой системе после вызова этой команды.
Определение
void agk::CloseRawFolder( UINT ID )
Параметры
ID - Идентификатор папки для закрытия
Пример кода
CloseFile
Описание
Закрывает файл и очищает идентификатор, используемый для его создания, никакие другие команды файла не могут быть вызваны с этим идентификатором.
Определение
void agk::CloseFile( UINT iFileID )
Параметры
iFileID - Идентификатор файла для закрытия
Пример кода
ChooseRawFile
Описание
Предоставляет пользователю возможность выбрать файл, хранящийся на его текущей платформе (только для Windows/Mac), например фото или звуковой файл. Если пользователь отменит операцию, будет возвращена пустая строка, в противном случае файл будет скопирован в текущий каталог приложений и возвращено имя файла, чтобы его можно было использовать в вашем приложении. Вы можете указать дополнительный фильтр расширений, чтобы ограничить типы файлов, которые пользователь будет видеть при просмотре. Например, использование фильтра расширения .wav ограничит пользователя выбором файлов .wav. Для нескольких расширений разделите их точкой с запятой, например *.wav;.mp3;*.png. Если эта команда используется в tier 2, возвращаемая строка должна быть удалена, когда вы закончите с ней, даже если это пустая строка. Нулевая строка не будет возвращена. Если вы установите returnFullPath равным 1, то файл не будет скопирован в папку записи, вместо этого вам будет возвращен полный путь, и вы можете загрузить его с помощью префикса raw: с обычными файловыми командами.
Определение
char* agk::ChooseRawFile( const char* ext )
char* agk::ChooseRawFile( const char* ext, int returnFullPath )
Параметры
ext - Расширения, позволяющие
returnFullPath - 1, чтобы вернуть полный путь, 0, чтобы скопировать его в папку записи и вернуть путь к папке записи
Пример кода
CancelZipExtract
Описание
Останавливает любое асинхронное извлечение zip-файла, которое выполняется в данный момент, это может занять некоторое время, чтобы закончить текущий файл, а затем он остановится. Как только он завершится, GetZipExtractComplete вернет 1, а GetZipExtractProgress останется на том же значении, на котором он был в данный момент.
Определение
void agk::CancelZipExtract()
Параметры
Пример кода
AddZipEntry
Описание
Добавляет локальный файл в zip-файл. Переменная path-это путь к локальному файлу, переменная ZipPath-это путь, который будет использоваться внутри zip-файла, это единственный способ добавить папки в zip-файл (добавив файл с ZipPath, например folder1/myfile.txt). Локальный путь к файлу находится относительно текущего каталога, установленного с помощью SetFolder, если только вы не начинаете путь с прямой косой черты, и в этом случае путь будет относительно корня каталога записи на текущей платформе.
Определение
void agk::AddZipEntry( UINT zipID, const char* path, const char* zipPath )
Параметры
zipID - Идентификатор zip-файла для добавления.
path - Путь к добавляемому файлу.
zipPath - Путь к файлу внутри zip-файла.