PPJ Desktop API
HomeCurrent IssuesDownloads
  • Welcome
  • Concepts
  • PPJ.Runtime.49
    • General
      • Sal
      • Sys
      • SalApplication
      • SalNamedProperties
      • SalWindow
      • WindowActionsEventArgs
      • SalXML
    • COM
      • SalCoClass
      • SalObject
      • SalOleErrorInfo
      • SalSafeArray
      • SalVariant
    • Controls
      • SalActiveX
      • SalBackgroundText
      • SalCheckBox
      • SalComboBox
      • SalContext
      • SalCustomControl
      • SalDataField
        • DataType
      • SalFrame
        • BorderStyle
      • SalGeneralWindow
      • SalGroupBox
      • SalGroupSeparator
      • SalHorizontalScrollBar
      • SalLine
        • LineStyle
        • LineType
      • SalListBox
      • SalMultilineField
      • SalNavigationBar
      • SalOptionButton
        • OptionButtonStyle
      • SalPicture
        • ImageStorage
      • SalPushbutton
      • SalRadioButton
      • SalTableWindow
        • CellType
        • FocusRowStyle
        • RowsSizingStyle
        • SalTableColumn
        • SalTableColumnCollection
        • SalTableRow
        • SalTableRowCollection
        • SalTableWindowBase
      • SalTreeControl
        • SalTreeItem
      • SalUserControl
      • SalVerticalScrollBar
    • Forms
      • AccessoryType
      • SalDialogBox
      • SalForm
      • SalFormClientArea
      • SalFormStatusBar
      • SalFormTableWindow
      • SalFormToolBar
      • SalFormWindow
      • SalMDIWindow
      • SalRibbonBarBase
      • SalRibbonBarForm
      • SalRibbonBarMDI
      • SalRibbonStatusBar
    • Interfaces
      • ISalControl
      • ISalEditControl
      • ISalListControl
      • ISalPictureControl
      • ISalRadioButton
      • ISalReport
      • ISalType
      • ISalAccessory
      • ISalMenu
      • ISalWindow
    • Internet
      • FtpEventArgs
      • FtpEventHandler
      • HttpEventArgs
      • HttpEventHandler
      • SalFtpClient
      • SalHttpClient
      • SalQuickFTP
      • SalQuickHTTP
    • Menus
      • SalContextMenu
      • SalFormMainMenu
      • SalMenuColumn
      • SalMenuItem
      • SalMenuRow
      • SalMenuSeparator
      • SalPopupMenu
      • SalWindowsMenu
    • QO
      • QO
      • SalQuickHTML
      • SalQuickTabs
      • SalQuickTabsDialog
      • SalQuickTabsForm
      • SalQuickTabsParent
      • SalQuickTabsParentDialog
      • SalQuickTabsParentForm
      • SalQuickToolTipCheckBox
      • SalQuickToolTipChildTable
      • SalQuickToolTipComboBox
      • SalQuickToolTipDataField
      • SalQuickToolTipHScrollBar
      • SalQuickToolTipListBox
      • SalQuickToolTipMultilineField
      • SalQuickToolTipOptionButton
      • SalQuickToolTipPicture
      • SalQuickToolTipPushButton
      • SalQuickToolTipRadioButton
      • SalQuickToolTipTableWindow
      • SalQuickToolTipVScrollBar
      • SalToolTipManager
    • Sql
      • SalSqlBindVariables
      • SalSqlError
      • SalSqlHandle
      • SalSqlSessionHandle
      • Sql
      • SqlContext
      • SqlOra
      • WhenSqlError
    • Types
      • SalArray
      • SalArray<T>
      • SalBinary
      • SalBoolean
      • SalDateTime
      • SalFileHandle
      • SalFunctionalClass
      • SalNumber
      • SalResource
      • SalString
      • SalStringContext
      • SalWindowHandle
  • PPJ.Runtime.DDE.49
    • General
      • SalDDE
  • PPJ.Runtime.Vis.49
    • General
      • Vis
      • VisTblEx
    • Controls
      • VisCalendar
      • VisCalendarDropDown
      • VisColorComboBox
      • VisColorListBox
      • VisColorPalette
      • VisColorPaletteBase
      • VisColorPaletteDropDown
      • VisComboBoxBase
      • VisDesktopListBox
      • VisDirListBox
      • VisDirTreeListBox
      • VisDriveListBox
      • VisDropDownBase
      • VisFileListBox
      • VisFontComboBox
      • VisFontListBox
      • VisFontNameComboBox
      • VisFontNameListBox
      • VisListBoxBase
      • VisListBoxExtension
      • VisListView
      • VisListViewDropDown
      • VisMeter
      • VisOutlineComboBox
      • VisOutlineListBox
      • VisPictureComboBox
      • VisPictureListBox
      • VisPoint
      • VisRadioListBox
      • VisRect
      • VisRichEdit
      • VisSize
      • VisSpinField
      • VisSplitter
      • VisSplitterWindow
        • Orientation
  • PPJ.Runtime.XSal.49
    • General
      • XSal
      • XSalScript
    • Controls
      • XSalFlatButton
      • XSalHSplitter
      • XSalSeparator
      • XSalSeparatorDoubleRaised
      • XSalSeparatorEtched
      • XSalSeparatorInvisible
      • XSalSeparatorSingleRaised
      • XSalSplitter
      • XSalToolbar
      • XSalToolbox
      • XSalVSplitter
Powered by GitBook
On this page
  • Properties
  • FileStream
  • Handle
  • IsBinary
  • IsNull
  • LastError
  • Methods
  • Close()
  • Copy(sSourcePath, sDestPath, bOverWrite)
  • CreateDirectory(sDir)
  • FromHandle(handle)
  • GetChar()
  • GetChar(nChar)
  • GetCurrentDirectory(sPath)
  • GetDateTime(sFilename, dtDateTime)
  • GetDrive()
  • GetObjectData(info, context)
  • GetString(maxLength)
  • GetString(line, maxLength)
  • Open(fileName, flags)
  • Open(fileName, flags, encoding)
  • PutChar(c)
  • PutString(text)
  • Read(maxLength)
  • Read(buffer, maxLength)
  • Read(buffer, maxLength)
  • RemoveDirectory(sDir)
  • Seek(bytes, position)
  • SetCurrentDirectory(sPath)
  • SetDateTime(sFilename, dtDateTime)
  • SetDrive(sDriveLetter)
  • Tell()
  • Write(str, length)
  • Write(binary, length)
  • Used By
  1. PPJ.Runtime.49
  2. Types

SalFileHandle

PPJ.Runtime.SalFileHandle

PreviousSalDateTimeNextSalFunctionalClass

Last updated 2 years ago

Namespace: PPJ.Runtime

Assembly: PPJ.Runtime.49 (4.9.0.0)

public struct SalFileHandle : ValueType, ISerializable, IXmlSerializable
Public Structure SalFileHandle
    Implements ValueType, ISerializable, IXmlSerializable

Properties

FileStream

: Returns the wrapped FileStream object.

Handle

: Returns the handle for this SalFileHandle object

IsBinary

: Returns true if the file was opened in binary mode.

IsNull

: Checks if this SalFileHandle object contains a null value.

LastError

Methods

Closes a file.

Copies the contents of one file (source) to another file (destination).

Parameter
Type
Description

sSourcePath

The full path name of the source file.

sDestPath

The full path name of the destination file.

bOverWrite

Specifies whether (TRUE) or not (FALSE) to overwrite the destination file. If the destination file already exists and bOverWrite is FALSE, then SalFileCopy fails, and returns FILE_CopyExist. If the destination file already exists and bOverWrite is TRUE, then SalFileCopy succeeds and the destination file is overwritten.

Creates a directory.

Parameter
Type
Description

sDir

The full path name of the new directory.

Returns the SalFileHandle object from the handle

Parameter
Type
Description

handle

Returns the next character in an open file.

Parameter
Type
Description

nChar

Parameter
Type
Description

sPath

Parameter
Type
Description

sFilename

dtDateTime

Gets the letter of the default (current) disk drive.

Parameter
Type
Description

info

context

Returns the next line from an open file. Lines are terminated by \r\n or \r or

Parameter
Type
Description

maxLength

Parameter
Type
Description

line

maxLength

Opens, re-opens, creates, or deletes a file.

Parameter
Type
Description

fileName

The name of the file to open, create, delete, or test.

flags

A constant that specifies the style in which to open the file. nStyle can be one or more styles combined using the bitwise OR (|) operator.

Opens, re-opens, creates, or deletes a file.

Parameter
Type
Description

fileName

The name of the file to open, create, delete, or test.

flags

A constant that specifies the style in which to open the file. nStyle can be one or more styles combined using the bitwise OR (|) operator.

encoding

Encoder used to read/write characters.

Writes a character to an open file.

Parameter
Type
Description

c

The ANSI numeric value of the character to write to hFile.

Writes a string to an open file.

Parameter
Type
Description

text

The string to write.

Reads a buffer of characters from an open file to a string .

Parameter
Type
Description

maxLength

Parameter
Type
Description

buffer

maxLength

Parameter
Type
Description

buffer

maxLength

Deletes a directory.

Parameter
Type
Description

sDir

The full path name of the directory to delete.

Positions the file pointer in an open file. The next file operation (such as a read or write) takes place at this new location.

Parameter
Type
Description

bytes

The specific position of the file pointer; the number of bytes from nPosition where the next file operation will take place.

position

The general position of the file pointer; one of the following values: FILE_SeekBegin FILE_SeekCurrent FILE_SeekEnd

Changes the current working directory. If the specified path does not contain a drive letter, the default drive's current directory is changed. Otherwise, the specified drive's current directory is changed and the specified drive is made the current drive.

Parameter
Type
Description

sPath

The path name of the new current working directory.

Sets the modification date and time of the specified file.

Parameter
Type
Description

sFilename

The name of the file whose modification date you want to set.

dtDateTime

The modification date and time.

Sets the current disk drive to the specified drive letter.

Parameter
Type
Description

sDriveLetter

The new disk drive letter. The length of this parameter's value is one character.

Returns the current position in an open file.

Writes a string to an open file.

Parameter
Type
Description

str

The string to write to hFile.

length

The number of bytes to write.

Writes a binary buffer to an open file.

Parameter
Type
Description

binary

The string to write to hFile.

length

The number of bytes to write.

Used By

Name
Description

Writes a character to an open file.

Writes a string to an open file and appends a carriage return/line feed character to the string.

Positions the file pointer in an open file. The next file operation (such as a read or write) takes place at this new location.

Returns the current position in an open file.

Writes a string to an open file.

Returns the SalFileHandle object from the handle

: Returns the last error code.

Close()

Returns: . bOk

Copy(sSourcePath, sDestPath, bOverWrite)

Returns: . nStatus

CreateDirectory(sDir)

Returns: . bOk

FromHandle(handle)

Returns: .

GetChar()

Returns: . nChar

GetChar(nChar)

Returns: .

GetCurrentDirectory(sPath)

Returns: .

GetDateTime(sFilename, dtDateTime)

Returns: .

GetDrive()

Returns: . sDriveLetter

GetObjectData(info, context)

GetString(maxLength)

Returns: .

GetString(line, maxLength)

Returns: .

Open(fileName, flags)

Returns: . bOk

Open(fileName, flags, encoding)

Returns: . bOk

PutChar(c)

Returns: . bOk

PutString(text)

Returns: . bOk

Read(maxLength)

Returns: .

Read(buffer, maxLength)

Returns: .

Read(buffer, maxLength)

Returns: .

RemoveDirectory(sDir)

Returns: . bOk

Seek(bytes, position)

Returns: . bOk

SetCurrentDirectory(sPath)

Returns: . bOk

SetDateTime(sFilename, dtDateTime)

Returns: . bOk

SetDrive(sDriveLetter)

Returns: . bOk

Tell()

Returns: . nPos

Write(str, length)

Returns: .

Write(binary, length)

Returns: .

Converts a to a number.

Int32
Boolean
SalNumber
SalBoolean
SalFileHandle
SalNumber
Boolean
SalBoolean
SalBoolean
SalString
SalString
Boolean
Boolean
Boolean
Boolean
Boolean
SalString
SalNumber
SalNumber
SalBoolean
Boolean
SalBoolean
SalBoolean
SalBoolean
SalNumber
SalNumber
SalNumber
SalString
SalString
SalBoolean
SalString
IntPtr
SalNumber&
SalString&
SalString
SalDateTime&
SerializationInfo
StreamingContext
Int32
SalString&
Int32
String
Int32
String
Int32
Encoding
Int32
String
Int32
SalString&
Int32
SalBinary&
Int32
SalString
Int32
Int32
SalString
SalString
SalDateTime
SalString
SalString
Int32
SalBinary
Int32
Sal.WindowHandleToNumber
SalFileHandle
Sal.FilePutChar
Sal.FilePutStr
Sal.FileRead
Sal.FileSeek
Sal.FileTell
Sal.FileWrite
Sal.FileGetChar
Sal.FileGetStr
SalFileHandle.FromHandle
Vis.FileClose
Vis.FileRead
Vis.FileReadString
Vis.FileReadBinary
Vis.FileSeek
Vis.FileTell
Vis.FileWrite
Vis.FileWriteString
Vis.FileWriteBinary
XSal.GZipPutChar
FileStream
IntPtr
Boolean
Boolean