<FileIO> Data Interface

Provides script language access to C++ objects of this type.

Class HierarchyType » TypeIO » FileIO

Function Members

Function members are as follows:

Return Type Function Name Documentation
int32CloseCloses access to the file.
int32FlushFlushes the file buffers.
int32GetCreationInfoPopulates a <Uint16Array> with information about when the file was created. The indices in the array refer to the Win32FileInfo enumeration. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information.
int64GetFileHandleReturns the value of the file handle.
int32GetFileSizeReturns the file size in bytes.
int32GetFileSizeAscReturns the size of an ASCII file in bytes.
int32GetFileSizeBinReturns the size of a binary file in bytes.
int32GetLastAccessedInfoPopulates a <Uint16Array> with information about when the file was last accessed. The indices in the array refer to the Win32FileInfo enumeration. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information.
int32GetLastModifiedInfoPopulates a <Uint16Array> with information about when the file was last modified. The indices in the array refer to the Win32FileInfo enumeration. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information.
uint64GetSizeInBytesReturns the size in bytes of the file on disk.
int32IsLockedReturns true if the file is currently locked.
int32IsOpenReturns true if the file is currently open.
int32ReadFloat16ArrayReads an array of <float16> values (stored on disk as word/uint16) from disk.
doubleReadFloat32Reads a single <float32> from disk, but must return a <float64> value since Scenome Scripting Language does not support the <float32> data type.
int32ReadFloat32ArrayReads an array of <float32> values from disk.
doubleReadFloat64Reads a <float64> from disk.
int32ReadFloat64ArrayReads an array of <float64> values from disk.
int32ReadInt16Reads a single <int16> from disk, but must return an <int32> value since Scenome Scripting Language does not support the <int16> data type.
int32ReadInt16ArrayReads an array of <int16> values from disk.
int32ReadInt32Reads a single <int32> from disk.
int32ReadInt32ArrayReads an array of <int32> values from disk.
int64ReadInt64Reads a single <int64> from disk and returns the value.
int32ReadInt64ArrayReads an array of <int64> values from disk.
int32ReadInt8Reads a single <int8> from disk.
int32ReadInt8ArrayReads an array of chars from disk.
uint32ReadUint16Reads a single <uint16> from disk, but must return an <int32> value since Scenome Scripting Language does not support the <uint16> data type.
int32ReadUint16ArrayReads an array of <uint16> values from disk.
uint32ReadUint32Reads a single <uint32> from disk.
int32ReadUint32ArrayReads an array of <uint32> values from disk.
uint64ReadUint64Reads a single <uint64> from disk and returns the value.
int32ReadUint64ArrayReads an array of <uint64> values from disk.
uint32ReadUint8Reads a single <uint8> from disk.
int32ReadUint8ArrayReads an array of bytes from disk.
stringTimestampReturns the timestamp.
int32WriteFloat16ArrayWrites an array of values to disk.
int32WriteFloat32Writes a single <float32> to disk, but the value must be submitted as a <float64> because Scenome Scripting Language does not support the <float32> data type. The <float64> value submitted to this function is converted to a <float32> via the C++ static_cast operator, and is written to disk as a <float32>.
int32WriteFloat32ArrayWrites an array of values to disk.
int32WriteFloat64Writes a <float64> to disk.
int32WriteFloat64ArrayWrites an array of values to disk.
int32WriteInt16Writes a single <int16> to disk, but the value must be submitted as an <int32> because Scenome Scripting Language does not support the <int16> data type. The <int32> value submitted to this function is converted to an <int16> via the C++ static_cast operator, and is written to disk as an int16.
int32WriteInt16ArrayWrites an array of values to disk.
int32WriteInt32Writes an <int32> to disk.
int32WriteInt32ArrayWrites an array of values to disk.
int32WriteInt64Writes an <int64> to disk.
int32WriteInt64ArrayWrites an array of values to disk.
int32WriteInt8Writes a single <int8> to disk, but the value must be submitted as an <int32> because Scenome Scripting Language does not support the <int8> data type. The <int32> value submitted to this function is converted to an <int8> via the C++ static_cast operator, and is written to disk as an <int8>.
int32WriteInt8ArrayWrites an array of values to disk.
int32WriteUint16Writes a <uint16> to disk, but the value must be submitted as an <int32> because Scenome Scripting Language does not support the <uint16> data type. The <int32> value submitted to this function is converted to a <uint16> via the C++ static_cast operator, and is written to disk as a uint16.
int32WriteUint16ArrayWrites an array of values to disk.
int32WriteUint32Writes a <uint32> to disk.
int32WriteUint32ArrayWrites an array of values to disk.
int32WriteUint64Writes an <int64> to the disk.
int32WriteUint64ArrayWrites an array of values to disk.
int32WriteUint8Writes a single <uint8> to disk, but the value must be submitted as an <int32> because Scenome Scripting Language does not support the <uint8> data type. The <int32> value submitted to this function is converted to a <uint8> via the C++ static_cast operator, and is written to disk as a uint8.
int32WriteUint8ArrayWrites an array of values to disk.

Object Members

Object members are as follows:

Type Name Accessor Name Documentation
int32PositionGets or sets the file pointer position.