The Stream File Object - HTML2EXE Programming Interface

Document Path: Home Page / Programming / HTML2EXE / Interfaces / Stream File Object  
Properties Position Property Size
Methods Close Create Crop Open Read ReadDirect ReadTextLine SaveAs SeekToEnd Shift Write WriteDirect WriteText
Properties

Position

Value ULONG
Access Get, Put
Notes Current read/write position

Property

Value VARIANT
Arguments:
  • BSTR name
Access Get, Put
Notes for storing run-time variables

Size

Value ULONG
Access Get
Notes Size of the file
Methods

Close

Return Value
Notes

Create

Return Value VARIANT_BOOL
Arguments:
  • BSTR path (Optional, default(""))
Notes

Crop

Return Value
Arguments:
  • ULONG pos
  • ULONG lengthInbytes
Notes

Open

Return Value
Arguments:
  • BSTR path
  • VARIANT_BOOL readOnly (Optional, default(0))
Notes

Read

Return Value Object
Arguments:
  • ULONG nBytesToRead
Notes

ReadDirect

Return Value ULONG
Arguments:
  • VARIANT voidPointer
  • ULONG nBytes
Notes

ReadTextLine

Return Value BSTR
Arguments:
  • BOOL sourceFileIsANSI (Optional, default(1))
Notes

SaveAs

Return Value VARIANT_BOOL
Arguments:
  • BSTR localFilePath
Notes

SeekToEnd

Return Value
Notes

Shift

Return Value
Arguments:
  • long offset
Notes Move the content of the file forward or backward.

Write

Return Value ULONG
Arguments:
  • VARIANT dat
Notes

WriteDirect

Return Value ULONG
Arguments:
  • VARIANT voidPointer
  • ULONG nBytes
Notes

WriteText

Return Value ULONG
Arguments:
  • BSTR text
  • BOOL convertToANSI
Notes