Provides script language access to C++ objects of this type.
Function members are as follows:
Return Type | Function Name | Documentation |
---|---|---|
int32 | Close | Closes access to the file. |
int32 | Flush | Flushes the file buffers. |
int32 | GetCreationInfo | Populates 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. |
int64 | GetFileHandle | Returns the value of the file handle. |
int32 | GetFileSize | Returns the file size in bytes. |
int32 | GetFileSizeAsc | Returns the size of an ASCII file in bytes. |
int32 | GetFileSizeBin | Returns the size of a binary file in bytes. |
int32 | GetLastAccessedInfo | Populates 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. |
int32 | GetLastModifiedInfo | Populates 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. |
uint64 | GetSizeInBytes | Returns the size in bytes of the file on disk. |
int32 | IsLocked | Returns true if the file is currently locked. |
int32 | IsOpen | Returns true if the file is currently open. |
int32 | ReadFloat16Array | Reads an array of <float16> values (stored on disk as word/uint16) from disk. |
double | ReadFloat32 | Reads a single <float32> from disk, but must return a <float64> value since Scenome Scripting Language does not support the <float32> data type. |
int32 | ReadFloat32Array | Reads an array of <float32> values from disk. |
double | ReadFloat64 | Reads a <float64> from disk. |
int32 | ReadFloat64Array | Reads an array of <float64> values from disk. |
int32 | ReadInt16 | Reads a single <int16> from disk, but must return an <int32> value since Scenome Scripting Language does not support the <int16> data type. |
int32 | ReadInt16Array | Reads an array of <int16> values from disk. |
int32 | ReadInt32 | Reads a single <int32> from disk. |
int32 | ReadInt32Array | Reads an array of <int32> values from disk. |
int64 | ReadInt64 | Reads a single <int64> from disk and returns the value. |
int32 | ReadInt64Array | Reads an array of <int64> values from disk. |
int32 | ReadInt8 | Reads a single <int8> from disk. |
int32 | ReadInt8Array | Reads an array of chars from disk. |
uint32 | ReadUint16 | Reads a single <uint16> from disk, but must return an <int32> value since Scenome Scripting Language does not support the <uint16> data type. |
int32 | ReadUint16Array | Reads an array of <uint16> values from disk. |
uint32 | ReadUint32 | Reads a single <uint32> from disk. |
int32 | ReadUint32Array | Reads an array of <uint32> values from disk. |
uint64 | ReadUint64 | Reads a single <uint64> from disk and returns the value. |
int32 | ReadUint64Array | Reads an array of <uint64> values from disk. |
uint32 | ReadUint8 | Reads a single <uint8> from disk. |
int32 | ReadUint8Array | Reads an array of bytes from disk. |
string | Timestamp | Returns the timestamp. |
int32 | WriteFloat16Array | Writes an array of values to disk. |
int32 | WriteFloat32 | Writes 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>. |
int32 | WriteFloat32Array | Writes an array of values to disk. |
int32 | WriteFloat64 | Writes a <float64> to disk. |
int32 | WriteFloat64Array | Writes an array of values to disk. |
int32 | WriteInt16 | Writes 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. |
int32 | WriteInt16Array | Writes an array of values to disk. |
int32 | WriteInt32 | Writes an <int32> to disk. |
int32 | WriteInt32Array | Writes an array of values to disk. |
int32 | WriteInt64 | Writes an <int64> to disk. |
int32 | WriteInt64Array | Writes an array of values to disk. |
int32 | WriteInt8 | Writes 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>. |
int32 | WriteInt8Array | Writes an array of values to disk. |
int32 | WriteUint16 | Writes 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. |
int32 | WriteUint16Array | Writes an array of values to disk. |
int32 | WriteUint32 | Writes a <uint32> to disk. |
int32 | WriteUint32Array | Writes an array of values to disk. |
int32 | WriteUint64 | Writes an <int64> to the disk. |
int32 | WriteUint64Array | Writes an array of values to disk. |
int32 | WriteUint8 | Writes 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. |
int32 | WriteUint8Array | Writes an array of values to disk. |
Object members are as follows:
Type Name | Accessor Name | Documentation |
---|---|---|
int32 | Position | Gets or sets the file pointer position. |