Sign in Join
FPDoc Onlineexperiment

TCustomIniFile.ReadBinaryStream function

Member of TCustomIniFilepublicIn unit IniFiles

Read binary data.

Declaration

pascal
function ReadBinaryStream(const Section: string; const Name: string; 
 Value: TStream): Integer; virtual

Arguments

Section

Section to read Name from.

Name

Name of key to retrieve value from.

Value

Stream to write data to.

Function result

Number of bytes written to Value.

Description

ReadBinaryStream reads the key Name in section Section, and returns the value in the stream Value. If the specified key or section do not exist, then the contents of Value are left untouched. The stream is not cleared prior to adding data to it.

The data is interpreted as a series of 2-byte hexadecimal values, each representing a byte in the data stream, i.e, it should always be an even number of hexadecimal characters.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.