flash.filesystem.FileStream (ActionScript 3.0)

	Свойство	Определено
		bytesAvailable : uint [только для чтения] Возвращает число байт данных, доступных для чтения во входном буфере.	FileStream
		constructor : Object Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.	Object
		endian : String Порядок байт данных, константа bigEndian или littleEndian класса Endian.	FileStream
		objectEncoding : uint Указывает, какой формат, AMF3 или AMF0, используется для записи или чтения бинарных данных методом readObject() или writeObject().	FileStream
		position : Number Текущее положение в файле.	FileStream
		prototype : Object [статические] Ссылка на модель объекта класса или функции.	Object
		readAhead : Number При асинхронном чтении данных из файлов: требуемый объем данных.	FileStream

	Метод	Определено
		FileStream() Создает объект FileStream.	FileStream
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Регистрирует объект прослушивателя события в объекте EventDispatcher, в результате чего прослушиватель будет получать уведомления о событиях.	EventDispatcher
		close():void Закрывает объект FileStream.	FileStream
		dispatchEvent(event:Event):Boolean Передает событие в поток событий.	EventDispatcher
		hasEventListener(type:String):Boolean Проверяет наличие у объекта EventDispatcher прослушивателей событий, которые зарегистрированы для получения уведомлений о событиях определенного типа.	EventDispatcher
		hasOwnProperty(name:String):Boolean Показывает, определено ли заданное свойство для объекта.	Object
		isPrototypeOf(theClass:Object):Boolean Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра.	Object
		open(file:File, fileMode:String):void Открывает объект FileStream в синхронном режиме, указывая на файл, заданный параметром файла.	FileStream
		openAsync(file:File, fileMode:String):void Открывает объект FileStream в асинхронном режиме, указывая на файл, заданный параметром файла.	FileStream
		propertyIsEnumerable(name:String):Boolean Показывает наличие заданного свойства и его перечисляемость.	Object
		readBoolean():Boolean Считывает логическое значение из потока байт или массива байт.	FileStream
		readByte():int Считывает байт со знаком из потока байт или массива байт.	FileStream
		readBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void Считывает число байт данных, заданное параметром length, из потока байт или массива байт.	FileStream
		readDouble():Number Считывает из потока байт или массива байт число IEEE 754 с двойной точностью и плавающей запятой.	FileStream
		readFloat():Number Считывает из потока байт или массива байт число IEEE 754 с одинарной точностью и плавающей запятой.	FileStream
		readInt():int Считывает из потока байт или массива байт 32-разрядное целое число со знаком.	FileStream
		readMultiByte(length:uint, charSet:String):String Считывает из потока байт многобайтовую строку заданной длины с использованием заданного набора знаков.	FileStream
		readObject():* Считывает объект из потока байт или массива байт, зашифрованного в сериализованный формат AMF.	FileStream
		readShort():int Считывает из потока байт или массива байт 16-разрядное целое число со знаком.	FileStream
		readUnsignedByte():uint Считывает байт без знака из потока байт или массива байт.	FileStream
		readUnsignedInt():uint Считывает из потока байт или массива байт 32-разрядное целое число без знака.	FileStream
		readUnsignedShort():uint Считывает из потока байт или массива байт 16-разрядное целое число без знака.	FileStream
		readUTF():String Считывает из потока байт или массива байт строку UTF-8.	FileStream
		readUTFBytes(length:uint):String Считывает из потока байт или массива байт последовательность байт UTF-8 и возвращает строку.	FileStream
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Удаляет прослушиватель из объекта EventDispatcher.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Задает доступность динамического свойства для операций цикла.	Object
		toString():String Возвращает строковое представление заданного объекта.	Object
		truncate():void Сокращает файл до положения, заданного свойством position объекта FileStream.	FileStream
		valueOf():Object Возвращает элементарное значение заданного объекта.	Object
		willTrigger(type:String):Boolean Проверяет, зарегистрирован ли прослушиватель событий в объекте EventDispatcher или в любом из его предков для получения уведомлений о событиях определенного типа.	EventDispatcher
		writeBoolean(value:Boolean):void Записывает логическое значение.	FileStream
		writeByte(value:int):void Записывает байт.	FileStream
		writeBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void Записывает в поток байт последовательность байт из заданного массива байт, начиная с начальных байт (индекс, отсчитываемый от нуля).	FileStream
		writeDouble(value:Number):void Записывает число IEEE 754 с двойной точностью (64-разрядное) и плавающей запятой.	FileStream
		writeFloat(value:Number):void Записывает число IEEE 754 с одинарной точностью (32-разрядное) и плавающей запятой.	FileStream
		writeInt(value:int):void Записывает 32-разрядное целое число со знаком.	FileStream
		writeMultiByte(value:String, charSet:String):void Записывает многобайтовую строку в поток байт с использованием заданного набора знаков.	FileStream
		writeObject(object:*):void Записывает объект в поток байт или массив байт в сериализованном формате AMF.	FileStream
		writeShort(value:int):void Записывает 16-разрядное целое число.	FileStream
		writeUnsignedInt(value:uint):void Записывает 32-разрядное целое число без знака.	FileStream
		writeUTF(value:String):void Записывает строку UTF-8 в поток байт.	FileStream
		writeUTFBytes(value:String):void Записывает строку UTF-8.	FileStream

Сводка	Определено
activate	[многоадресное событие] Отправляется, когда проигрыватель Flash Player перемещается в фокус операционной системы и становится активным.	EventDispatcher
close	Указывает, что поток был закрыт формальным вызовом метода close().	FileStream
complete	Сообщает о достижении конца потока.	FileStream
deactivate	[многоадресное событие] Отправляется, когда проигрыватель Flash Player покидает фокус операционной системы и становится неактивным.	EventDispatcher
ioError	Указывает, что во время выполнения асинхронной операции ввода-вывода произошла ошибка.	FileStream
outputProgress	Сообщает, что запись данных из буфера в файл завершена.	FileStream
progress	Сообщает, что в потоке появились новые доступные данные.	FileStream

bytesAvailable:uint [только для чтения]

Версии среды выполнения:

AIR 1.0

Возвращает число байт данных, доступных для чтения во входном буфере. В коде должен быть вызов свойства bytesAvailable, проверяющий доступность необходимого объема данных до того, как будет выполнена попытка их считывания с помощью одного из методов "read".

Реализация
public function get bytesAvailable():uint

endian:String [чтение и запись]

Версии среды выполнения:

AIR 1.0

Порядок байт данных, константа bigEndian или littleEndian класса Endian.

Реализация
public function get endian():String
public function set endian(value:String):void

objectEncoding:uint [чтение и запись]

Версии среды выполнения:

AIR 1.0

Указывает, какой формат, AMF3 или AMF0, используется для записи или чтения бинарных данных методом readObject() или writeObject().

Значение представлено константой из класса ObjectEncoding. По умолчанию используется формат AMF3.

Реализация
public function get objectEncoding():uint
public function set objectEncoding(value:uint):void

См. также

ObjectEncoding
readObject()
writeObject()

position:Number [чтение и запись]

Версии среды выполнения:

AIR 1.0

Текущее положение в файле.

Данное значение изменяется при следующих условиях:

Если явно задано свойство.
Если производится считывание из объекта FileStream (с использованием одного из методов чтения).
Если производится запись в объект FileStream.

Положение определяется как Number (а не uint) для поддержки файлов длиной более 2³² байтов. Значение данного свойства всегда представлено целым числом до 2⁵³. Если задать это значение дробным числом, то оно будет округлено до целого в меньшую сторону.

Если при асинхронном чтении файла задать свойство position, приложение начнет заполнять буфер чтения данными, начиная с указанного положения, а свойство bytesAvailable может принять значение 0. Дождитесь события complete, прежде чем использовать метод read для чтения данных или дождитесь события progress и проверьте свойство bytesAvailable, прежде чем использовать метод read.

Реализация
public function get position():Number
public function set position(value:Number):void

readAhead:Number [чтение и запись]

Версии среды выполнения:

AIR 1.0

При асинхронном чтении данных из файлов: требуемый объем данных.

Это свойство указывает, сколько данных пытается считать асинхронный поток за точкой текущего положения. Значение этого свойства по умолчанию — бесконечность: по умолчанию из файла, открытого для асинхронного чтения, данные считываются, пока не будет достигнут конец файла.

Считывание данных из буфера чтения не влияет на значение свойства readAhead. При считывании данных из буфера новые данные считываются в буфер для его пополнения.

Свойство readAhead не влияет на файл, открытый в синхронном режиме.

При считывании данных в асинхронном режиме объект FileStream вызывает события . В методе обработчика событий для события progress проверьте доступность необходимого количества байт (это можно проверить с помощью свойства bytesAvailable), а затем считайте данные из буфера чтения с помощью метода read.

Реализация
public function get readAhead():Number
public function set readAhead(value:Number):void

Пример
Как пользоваться примерами

public function FileStream()

Версии среды выполнения:

AIR 1.0

Создает объект FileStream. Для открытия файла используйте методы open() или openAsync().

См. также

open()
openAsync()

public function close():void

Версии среды выполнения:

AIR 1.0

Закрывает объект FileStream.

После вызова метода close() данные нельзя считывать или записывать. Если файл был открыт в асинхронном режиме (объект FileStream использует для открытия файла метод openAsync()), вызов метода close() заставляет объект вызвать событие close.

Автоматическое закрытие приложения закрывает все файлы, связанные с объектами FileStream в приложении. Тем не менее, рекомендуется ставить все асинхронно открытые объекты FileStream, у которых есть данные, ожидающие записи, в очередь на событие closed, прежде чем закрывать приложение (чтобы данные точно были записаны).

Можно повторно использовать объект FileStream, вызвав метод open() или openAsync(). Все файлы, связанные с объектом FileStream, при этом закрываются, но объект не вызывает событие close.

Что касается объекта FileStream, открытого в асинхронном режиме (с использованием метода openAsync()), то даже если вызвать событие close() для этого объекта и удалить свойства и переменные, ссылающиеся на него, объект FileStream не будет удален из памяти до тех пор, пока в остаются невыполненные операции и обработчики событий, ждущие их выполнения. В частности, объект FileStream, на который нет других ссылок, будет существовать, пока выполняется хотя бы одно из следующих условий:

При выполнении считывания из файла не был достигнут конец файла (и не было вызвано событие complete).
Выходные данные будут по-прежнему доступны для записи, а у связанных с ними событий (таких как outputProgress или ioError) будут приемники событий.

События

close:Event — Открытый в асинхронном режиме файл будет закрыт.

См. также

open()
Событие close

public function open(file:File, fileMode:String):void

Версии среды выполнения:

AIR 1.0

Открывает объект FileStream в синхронном режиме, указывая на файл, заданный параметром file.

Если объект FileStream уже открыт, вызов метода закрывает файл перед открытием, и последующие события (включая close) не передаются ранее открытому файлу.

В системах, поддерживающих блокирование файлов, файлы, открытые только для записи или только для обновления (FileMode.WRITE или FileMode.UPDATE), недоступны для чтения, пока они не будут закрыты.

Параметры

	`file:File` — Объект File, указывающий на файл, который необходимо открыть.

	`fileMode:String` — Строка класса FileMode, определяющая доступные действия объекта FileStream, например чтение или запись в файл.

Выдает

Error — Файла не существует; у вас нет прав для открытия файла; вы открываете файл для чтения, но у вас нет прав на чтение; вы открываете файл для записи, но у вас нет прав для записи.

См. также

close()
Файл
FileMode

public function openAsync(file:File, fileMode:String):void

Версии среды выполнения:

AIR 1.0

Открывает объект FileStream в асинхронном режиме, указывая на файл, заданный параметром file.

Если объект FileStream уже открыт, вызов метода закрывает файл перед открытием, и последующие события (включая close) не передаются ранее открытому файлу.

Если параметру fileMode присвоена константа FileMode.READ или FileMode.UPDATE, Apollo считывает данные во входной буфер при открытии файла, а события progress и open вызываются по мере считывания данных во входной буфер.

В системах, поддерживающих блокирование файлов, файлы, открытые только для записи или только для обновления (FileMode.WRITE или FileMode.UPDATE), недоступны для чтения, пока они не будут закрыты.

Параметры

	`file:File` — Объект File, указывающий на файл, который необходимо открыть.

	`fileMode:String` — Строка класса FileMode, определяющая доступные действия объекта FileStream, например чтение или запись в файл.

События

	`ioError:IOErrorEvent` — Файла не существует; у вас нет прав для открытия файла; вы открываете файл для чтения, но у вас нет прав на чтение; вы открываете файл для записи, но у вас нет прав для записи.

	`progress:ProgressEvent` — Вызывается при считывании данных во входной буфер. (При открытии файла параметру `fileMode` должна быть присвоена константа `FileMode.READ` или `FileMode.UPDATE`).

	`complete:Event` — Данные файла считаны во входной буфер. (При открытии файла параметру `fileMode` должна быть присвоена константа `FileMode.READ` или `FileMode.UPDATE`).

См. также

close()
Событие complete
Событие ioError
Событие progress
FileMode

public function readBoolean():Boolean

Версии среды выполнения:

AIR 1.0

Считывает логическое значение из потока байт или массива байт. Считывается один байт. Если этот байт ненулевой, то возвращается значение true. В противном случае возвращается значение false.

Возвращает

Boolean — Логическое значение будет true, если количество байтов не равно нулю, в остальных случаях оно будет false.

События

ioError:IOErrorEvent — Чтение файла невозможно или файл не открыт. Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

public function readByte():int

Версии среды выполнения:

AIR 1.0

Считывает байт со знаком из потока байт или массива байт.

Возвращает

int — Возвращенное значение находится в диапазоне от -128 до 127.

События

ioError:IOErrorEvent — Чтение файла невозможно или файл не открыт. Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

public function readBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void

Версии среды выполнения:

AIR 1.0

Считывает из потока байт или массива байт число байт данных, заданное параметром length. Байты считываются в объект ByteArray, определяемый параметром bytes, при этом начальная позиция определяется параметром offset.

Параметры

	`bytes:ByteArray` — Объект `ByteArray`, в который считываются данные.

	`offset:uint` (default = `0`) — Смещение в параметре `bytes`, с которого должно начинаться считывание данных.

	`length:uint` (default = `0`) — Число байт для считывания. Если значение по умолчанию равно 0, считываются все доступные данные.

События

ioError:IOErrorEvent — Чтение файла невозможно или файл не открыт. Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

public function readDouble():Number

Версии среды выполнения:

AIR 1.0

Считывает из потока байт или массива байт число IEEE 754 с двойной точностью и плавающей запятой.

Возвращает

Number — Число IEEE 754 с двойной точностью и плавающей запятой.

События

ioError:IOErrorEvent — Чтение файла невозможно или файл не открыт. Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

public function readFloat():Number

Версии среды выполнения:

AIR 1.0

Считывает из потока байт или массива байт число IEEE 754 с одинарной точностью и плавающей запятой.

Возвращает

Number — Число IEEE 754 с одинарной точностью и плавающей запятой.

События

ioError:IOErrorEvent — Чтение файла невозможно или файл не открыт. Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

public function readInt():int

Версии среды выполнения:

AIR 1.0

Считывает из потока байт или массива байт 32-разрядное целое число со знаком.

Возвращает

int — Возвращенное значение находится в диапазоне от -2147483648 до 2147483647.

События

ioError:IOErrorEvent — Чтение файла невозможно или файл не открыт. Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

public function readMultiByte(length:uint, charSet:String):String

Версии среды выполнения:

AIR 1.0

Считывает из потока байт многобайтовую строку заданной длины с использованием заданного набора знаков.

Параметры

	`length:uint` — Число считываемых из потока байтов.

	`charSet:String` — Строка, обозначающая набор символов, которые используются для интерпретации байтов. Возможные строки наборов символов: `"shift_jis"`, `"cn-gb"`, `"iso-8859-1"` и другие. Полный список см. в разделе Поддерживаемые наборы символов. Примечание. Если текущая система не распознает значение параметра `charSet`, то в качестве набора символов проигрыватель Flash Player будет использовать кодовую страницу по умолчанию. Например, значение параметра `charSet`, например в `myTest.readMultiByte(22, "iso-8859-01")`, которое использует `01`вместо `1` может работать на вашем компьютере, но привести к сбою на другой рабочей станции. На другом компьютере проигрыватель Flash Player будет использовать кодовую страницу, заданную по умолчанию в системе.

Возвращает

String — Строка в кодировке UTF-8.

События

ioError:IOErrorEvent — Чтение файла невозможно или файл не открыт. Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

См. также

File.systemCharset

public function readObject():*

Версии среды выполнения:

AIR 1.0

Считывает объект из потока байт или массива байт, зашифрованного в сериализованный формат AMF.

Возвращает

* — Десериализованный объект

События

ioError:IOErrorEvent — Чтение файла невозможно или файл не открыт. Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

public function readShort():int

Версии среды выполнения:

AIR 1.0

Считывает из потока байт или массива байт 16-разрядное целое число со знаком.

Возвращает

int — Возвращенное значение находится в диапазоне от -32768 до 32767.

События

ioError:IOErrorEvent — Чтение файла невозможно или файл не открыт. Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

public function readUnsignedByte():uint

Версии среды выполнения:

AIR 1.0

Считывает байт без знака из потока байт или массива байт.

Возвращает

uint — Возвращенное значение находится в диапазоне от 0 до 255.

События

ioError:IOErrorEvent — Чтение файла невозможно или файл не открыт. Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

public function readUnsignedInt():uint

Версии среды выполнения:

AIR 1.0

Считывает из потока байт или массива байт 32-разрядное целое число без знака.

Возвращает

uint — Возвращенное значение находится в диапазоне от 0 до 4294967295.

События

ioError:IOErrorEvent — Чтение файла невозможно или файл не открыт. Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

public function readUnsignedShort():uint

Версии среды выполнения:

AIR 1.0

Считывает из потока байт или массива байт 16-разрядное целое число без знака.

Возвращает

uint — Возвращенное значение находится в диапазоне от 0 до 65535.

События

ioError:IOErrorEvent — Чтение файла невозможно или файл не открыт. Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

public function readUTF():String

Версии среды выполнения:

AIR 1.0

Считывает из потока байт или массива байт строку UTF-8. Предполагается, что в строку вставляется префикс с неподписанным значением, указывающим длину в байтах.

Этот метод похож на метод readUTF() интерфейса IDataInput языка Java.

Возвращает

String — Строка в кодировке UTF-8, являющаяся байтовым представлением символов.

События

ioError:IOErrorEvent — Чтение файла невозможно или файл не открыт. Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

public function readUTFBytes(length:uint):String

Версии среды выполнения:

AIR 1.0

Считывает из потока байт или массива байт последовательность байт UTF-8 длиной length и возвращает строку.

Параметры

length:uint — Число байт для считывания.

Возвращает

String — Строка в кодировке UTF-8, являющаяся байтовым представлением символов указанной длины.

События

ioError:IOErrorEvent — Чтение файла невозможно или файл не открыт. Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

	`IOError` — Файл не был открыт; файл был открыт, но без прав на чтение; либо, если файл был открыт для синхронных операций (с помощью метода `open()`), файл не может быть считан (например, из-за отсутствия файла).

	`EOFError` — Положение, определенное для считывания данных, превышает количество доступных байтов (задается свойством `bytesAvailable`).

public function truncate():void

Версии среды выполнения:

AIR 1.0

Сокращает файл до положения, заданного свойством position объекта FileStream.

Все байты от положения, заданного свойством position, до конца файла, удаляются. Файл должен быть открыт для записи.

Выдает

Error — Файл не открыт для записи.

См. также

position

public function writeBoolean(value:Boolean):void

Версии среды выполнения:

AIR 1.0

Записывает логическое значение. Записывается один байт, соответствующий параметру value. 1 в случае значения true, и 0 в случае значения false.

Параметры

value:Boolean — Логическое значение, показывающее, какой байт записывается. Если параметр принимает значение true, Flash Player записывает 1, если же значение false, Flash Player записывает 0.

События

ioError:IOErrorEvent — Вы не можете произвести запись в файл (например, потому что файл отсутствует). Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

IOError — Файл не был открыт; файл был открыт, но без прав на запись; либо, если файл был открыт для синхронных операций (с помощью метода open()), в файл не может быть произведена запись (например, из-за отсутствия файла).

public function writeByte(value:int):void

Версии среды выполнения:

AIR 1.0

Записывает байт. Используется 8 младших битов параметра. 24 старших бита игнорируются.

Параметры

value:int — Значение байта в виде целого числа.

События

ioError:IOErrorEvent — Вы не можете произвести запись в файл (например, потому что файл отсутствует). Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

IOError — Файл не был открыт; файл был открыт, но без прав на запись; либо, если файл был открыт для синхронных операций (с помощью метода open()), в файл не может быть произведена запись (например, из-за отсутствия файла).

public function writeBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void

Версии среды выполнения:

AIR 1.0

Записывает в поток байт последовательность байт длиной length из заданного массива байт (bytes), начиная со смещения offset (индекс отсчитывается от нуля).

Если параметр length опущен, применение длины по умолчанию, равной 0, приведет к тому, что проигрыватель Flash Player будет записывать весь буфер, начиная со смещения offset. Если также опустить параметр offset, будет записываться весь буфер.

Если параметры offset или length находятся за пределами диапазона, то они корректируются так, чтобы совпасть с началом и концом массива bytes.

Параметры

	`bytes:ByteArray` — Массив байт для записи.

	`offset:uint` (default = `0`) — Отсчитываемое от нуля значение индекса, определяющее положение начала записи в массив.

	`length:uint` (default = `0`) — Целое число без знака, определяющее глубину буфера для записи.

События

ioError:IOErrorEvent — Вы не можете произвести запись в файл (например, потому что файл отсутствует). Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

IOError — Файл не был открыт; файл был открыт, но без прав на запись; либо, если файл был открыт для синхронных операций (с помощью метода open()), в файл не может быть произведена запись (например, из-за отсутствия файла).

public function writeDouble(value:Number):void

Версии среды выполнения:

AIR 1.0

Записывает число IEEE 754 с двойной точностью (64-разрядное) и плавающей запятой.

Параметры

value:Number — Число с двойной точностью (64-разрядное) и плавающей запятой.

События

ioError:IOErrorEvent — Вы не можете произвести запись в файл (например, потому что файл отсутствует). Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

IOError — Файл не был открыт; файл был открыт, но без прав на запись; либо, если файл был открыт для синхронных операций (с помощью метода open()), в файл не может быть произведена запись (например, из-за отсутствия файла).

public function writeFloat(value:Number):void

Версии среды выполнения:

AIR 1.0

Записывает число IEEE 754 с одинарной точностью (32-разрядное) и плавающей запятой.

Параметры

value:Number — Число с одинарной точностью (32-разрядное) и плавающей запятой.

События

ioError:IOErrorEvent — Вы не можете произвести запись в файл (например, потому что файл отсутствует). Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

IOError — Файл не был открыт; файл был открыт, но без прав на запись; либо, если файл был открыт для синхронных операций (с помощью метода open()), в файл не может быть произведена запись (например, из-за отсутствия файла).

public function writeInt(value:int):void

Версии среды выполнения:

AIR 1.0

Записывает 32-разрядное целое число со знаком.

Параметры

value:int — Значение байта в виде целого числа со знаком.

События

ioError:IOErrorEvent — Вы не можете произвести запись в файл (например, потому что файл отсутствует). Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

IOError — Файл не был открыт; файл был открыт, но без прав на запись; либо, если файл был открыт для синхронных операций (с помощью метода open()), в файл не может быть произведена запись (например, из-за отсутствия файла).

public function writeMultiByte(value:String, charSet:String):void

Версии среды выполнения:

AIR 1.0

Записывает многобайтовую строку в поток байт с использованием заданного набора знаков.

Параметры

	`value:String` — Записываемое значение строки.

	`charSet:String` — Строка, обозначающая используемый набор символов. Возможные строки наборов символов: `"shift_jis"`, `"cn-gb"`, `"iso-8859-1"` и другие. Полный список см. в разделе Поддерживаемые наборы символов.

События

ioError:IOErrorEvent — Вы не можете произвести запись в файл (например, потому что файл отсутствует). Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

IOError — Файл не был открыт; файл был открыт, но без прав на запись; либо, если файл был открыт для синхронных операций (с помощью метода open()), в файл не может быть произведена запись (например, из-за отсутствия файла).

См. также

File.systemCharset

public function writeObject(object:*):void

Версии среды выполнения:

AIR 1.0

Записывает объект в поток байт или массив байт в сериализованном формате AMF.

Параметры

object:* — объект для сериализации

События

ioError:IOErrorEvent — Вы не можете произвести запись в файл (например, потому что файл отсутствует). Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

IOError — Файл не был открыт; файл был открыт, но без прав на запись; либо, если файл был открыт для синхронных операций (с помощью метода open()), в файл не может быть произведена запись (например, из-за отсутствия файла).

public function writeShort(value:int):void

Версии среды выполнения:

AIR 1.0

Записывает 16-разрядное целое число. Используется 16 младших битов параметра. 16 старших битов игнорируются.

Параметры

value:int — Значение байта в виде целого числа.

События

ioError:IOErrorEvent — Вы не можете произвести запись в файл (например, потому что файл отсутствует). Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

IOError — Файл не был открыт; файл был открыт, но без прав на запись; либо, если файл был открыт для синхронных операций (с помощью метода open()), в файл не может быть произведена запись (например, из-за отсутствия файла).

public function writeUnsignedInt(value:uint):void

Версии среды выполнения:

AIR 1.0

Записывает 32-разрядное целое число без знака.

Параметры

value:uint — Значение байта в виде целого числа без знака.

События

ioError:IOErrorEvent — Вы не можете произвести запись в файл (например, потому что файл отсутствует). Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

IOError — Файл не был открыт; файл был открыт, но без прав на запись; либо, если файл был открыт для синхронных операций (с помощью метода open()), в файл не может быть произведена запись (например, из-за отсутствия файла).

public function writeUTF(value:String):void

Версии среды выполнения:

AIR 1.0

Записывает строку UTF-8 в поток байт. Сначала записывается длина строки UTF-8 в байтах (в виде 16-разрядного целого числа), за которой следуют байты символов строки.

Параметры

value:String — Записываемое значение строки.

События

ioError:IOErrorEvent — Вы не можете произвести запись в файл (например, потому что файл отсутствует). Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

IOError — Файл не был открыт; файл был открыт, но без прав на запись; либо, если файл был открыт для синхронных операций (с помощью метода open()), в файл не может быть произведена запись (например, из-за отсутствия файла).

public function writeUTFBytes(value:String):void

Версии среды выполнения:

AIR 1.0

Записывает строку UTF-8. Аналогично writeUTF(), но строке не предшествует 16-разрядное слово, указывающее длину.

Параметры

value:String — Записываемое значение строки.

События

ioError:IOErrorEvent — Вы не можете произвести запись в файл (например, потому что файл отсутствует). Данное событие вызывается только для файлов, открытых для асинхронных операций (с помощью метода openAsync()).

Выдает

IOError — Файл не был открыт; файл был открыт, но без прав на запись; либо, если файл был открыт для синхронных операций (с помощью метода open()), в файл не может быть произведена запись (например, из-за отсутствия файла).

Тип объекта события: flash.events.Event
свойство Event.type = flash.events.Event.CLOSE

Версии среды выполнения:

AIR 1.0

Указывает, что поток был закрыт формальным вызовом метода close().

Константа Event.CLOSE определяет значение свойства type объекта события close.

Данное событие имеет следующие свойства.

Свойство	Значение
`bubbles`	`false`
`cancelable`	`false`; нет поведения по умолчанию для отмены.
`currentTarget`	Объект, активно обрабатывающий объект Event с помощью прослушивателя событий.
`target`	Объект, для которого разорвано подключение.

См. также

close()

Тип объекта события: flash.events.Event
свойство Event.type = flash.events.Event.COMPLETE

Версии среды выполнения:

AIR 1.0

Сообщает о достижении конца потока.

Константа Event.COMPLETE определяет значение свойства type объекта complete.

Данное событие имеет следующие свойства.

Свойство	Значение
`bubbles`	`false`
`cancelable`	`false`; нет поведения по умолчанию для отмены.
`currentTarget`	Объект, активно обрабатывающий объект Event с помощью прослушивателя событий.
`target`	Сетевой объект, который завершил загрузку.

См. также

position

Тип объекта события: flash.events.IOErrorEvent
свойство IOErrorEvent.type = flash.events.IOErrorEvent.IO_ERROR

Версии среды выполнения:

AIR 1.0

Указывает, что во время выполнения асинхронной операции ввода-вывода произошла ошибка.

Задает значение свойства type для объекта события ioError.

Данное событие имеет следующие свойства.

Свойство	Значение
`bubbles`	`false`
`cancelable`	`false`; нет поведения по умолчанию для отмены.
`currentTarget`	Объект, активно обрабатывающий объект Event с помощью прослушивателя событий.
`target`	Сетевой объект, с которым произошла ошибка ввода/вывода.
`text`	Текст, отображаемый в качестве сообщения об ошибке.

Тип объекта события: flash.events.OutputProgressEvent
свойство OutputProgressEvent.type = flash.events.OutputProgressEvent.OUTPUT_PROGRESS

Версии среды выполнения:

AIR 1.0

Сообщает, что запись данных из буфера в файл завершена.

Задает значение свойства type для объекта события outputProgress.

Данное событие имеет следующие свойства.

Свойство	Значение
`bubbles`	`false`
`bytesPending`	Число байт, которые остается записать на момент обработки события прослушивателем.
`bytesTotal`	Общее число элементов или байт, которые в итоге будут записаны в случае успешного завершения записи.
`cancelable`	`false`; нет поведения по умолчанию для отмены.
`currentTarget`	Объект, активно обрабатывающий объект Event с помощью прослушивателя событий.
`target`	Объект FileStream, сообщающий сведения о прогрессе.

Тип объекта события: flash.events.ProgressEvent
свойство ProgressEvent.type = flash.events.ProgressEvent.PROGRESS

Версии среды выполнения:

AIR 1.0

Сообщает, что в потоке появились новые доступные данные.

Задает значение свойства type для объекта события progress.

Данное событие имеет следующие свойства.

Свойство	Значение
`bubbles`	`false`
`bytesLoaded`	Число элементов или байт, загруженных на момент обработки события прослушивателем.
`bytesTotal`	Общее число элементов или байт, которые в итоге будут получены в случае успешного завершения загрузки.
`cancelable`	`false`; нет поведения по умолчанию для отмены.
`currentTarget`	Объект, активно обрабатывающий объект Event с помощью прослушивателя событий.
`target`	Сетевой объект, сообщающий сведения о прогрессе.

Справочник по языку ActionScript 3.0 и компонентам		Home \| Все пакеты \| Все классы \| Элементы языка \| Указатель \| Приложения \| Сокращения \| Кадры Нет кадров
FileStream	Свойства \| Методы \| События \| Стили \| Эффекты \| Константы \| Примеры

Пакет	flash.filesystem
Класс	public class FileStream
Наследование	FileStream EventDispatcher Object
Реализует	IDataInput, IDataOutput