IdGlobal.pas

Common routines and classes used in the Indy component suite.

IdGlobal.pas contains Classes, Types, Procedures, and Functions needed to define and implement common routines and classes used in the Indy component suite.

IdGlobal.pas includes a IFDEF compiler directives to ensure that the Indy library is built correctly for the underlying Operating System or platform. This includes compatibility routines that mask the differences between .NET- and VCL-compatible platform implementations of the Indy library.

See Also

IndySupport

Classes

Class	Description
EIdCorruptServicesFile	Exception raised when a service file entry is corrupted.
EIdEndOfStream	Exception raised when an unexpected end of stream is encountered.
EIdInvalidIPv6Address	Exception raised when creating an IPv6 address from its' representation as a string.
TAppendFileStream	Implements a file stream used to append content to a file in the local file system.
TCriticalSection	Implements the ancestor for critical section classes in Indy.
TEvent	Ancestor class for thread-based event notifications.
TFileCreateStream	Implements a file stream which recreates the file used for storing stream content.
TIdBaseStream	Ancestor for classes requiring a platform-specific stream implementation.
TIdCriticalSection	Represent critical sections used in the Indy library.
TIdExtList	Represents an array of pointers for VCL versions prior to VCL6.
TIdLocalEvent	Event type signalled for thread-based notification messages.
TReadFileExclusiveStream	Implements a file stream using a non-shared write access file sharing mode.
TReadFileNonExclusiveStream	Implements a file stream using shared access for read operations.

Constants

Constant	Description
BACKSPACE	Represents the Backspace characterin the US-ASCII character set.
CHAR0	Represents the Null character.
CHAR32	Represents the Space character.
CR	Represents the Carriage Return character.
EOL	Represents the End-of-Line character sequence.
GOSType	Indicates the Operating System hosting the Indy application.
GPathDelim	Identifies the platform- or operating system-specific path delimiter character.
HEXPREFIX	Identifies the prefix used for hexadecimal characters in a string.
HoursPerDay	Number of hours in a day.
ID_DEFAULT_IP_VERSION	Default value for the IP version number supported in protocol stack methods.
IdFetchCaseSensitiveDefault	Default value for case-sensitive comparisons in Fetch.
IdFetchDeleteDefault	Default value for the delete delimiter argument in Fetch and FetchCaseSensitive.
IdFetchDelimDefault	Default delimiter(s) for Fetch and FetchCaseSenstive.
IdHexDigits	Identifies characters used in the hexadecimal representation of a numeric value.
IdOctalDigits	Identifies characters used in the octal representation of a numeric value.
IdTimeoutDefault	Indicates that the default timeout value should be used.
IdTimeoutInfinite	Indicates that an infinite timeout value should be used.
Infinite	Defines the platform-specific value used for infinite timeouts.
INFINITE	This is constant INFINITE.
LF	Represents the Line Feed character.
MinsPerDay	Number of minutes in a day.
MinsPerHour	Number of minutes in an hour.
MSecsPerDay	Number of milliseconds in a day.
MSecsPerSec	Number of milliseconds in a second.
POWER_1	Bit mask value for processing IP addresses.
POWER_2	Bit mask value for processing IP addresses.
POWER_3	Bit mask value for processing IP addresses.
POWER_4	Bit mask value for processing IP addresses.
SecsPerDay	Number of seconds in a day.
SecsPerMin	Number of seconds in a minute.
sLineBreak	Indicates the default line end character sequence.
TAB	Represents the Tab character.
tpHigher
tpHighest
tpIdle
tpLower
tpLowest
tpNormal
tpTimeCritical
WhiteSpace	Specifies whitespace characters.

Enumerations

Enumeration	Description
TIdEncoding	Character set encodings used in ToBytes.
TIdIPVersion	Represents IP version numbers used in protocol-related classes.
TIdMaxLineAction	Action to take when the line length exceeds the maximum length in an Indy IOHandler.
TIdOSType	Represents valid values for the Operating System or Platform hosting the Indy application.
TIdReuseSocket	Indicates how IP addresses and port numbers are reused for listener threads in TCP servers.
TWaitResult

Functions

Function	Description
AppendByte	Appends a byte value to the specified destination.
AppendBytes	AppendBytes is a utility procedure used with TIdBytes values.
AppendString	Adds a string value to existing data in a TIdBytes storage variable.
BytesToCardinal	Converts a TIdByte value to the ordinal datatype.
BytesToChar	Converts a byte value to a character data type.
BytesToInt64	Converts byte values to a 64-bit integer data type.
BytesToInteger	Converts a TIdByte value to the ordinal datatype.
BytesToIPv6	Converts byte values to an IP version 6 network address.
BytesToRaw	Copies binary values from an array of bytes into an untyped buffer location.
BytesToShort	Ordinal value of the TIdByte argument. Converts a TIdByte value to the ordinal datatype.
BytesToString	Converts a TIdBytes value to a String datatype.
BytesToWord	Converts an array of byte values to its representation as a Word data type.
ByteToHex	Converts a byte value to its hexadecimal representation.
ByteToOctal	Converts a byte value to its octal representation.
CharIsInEOF	Checks for end-of-line characters at a position in a string.
CharIsInSet	Checks a character in a string for membership in a set of characters.
CopyTIdByteArray	Copies byte values between Array of Byte variables.
CopyTIdBytes	Copies bytes values between TIdBytes instances.
CopyTIdCardinal	Stores the ordinal data type in an array of bytes.
CopyTIdInt64	Copies bytes from an Int64 data type into an array of bytes.
CopyTIdIPV6Address	Copies word values from a structured IP into an array of bytes.
CopyTIdLongWord	Copies bytes values from the ordinal data type into the specified array of bytes.
CopyTIdString	Copy all or part of a string data type into the specified array bytes.
CopyTIdWord	Copies bytes values from the ordinal data type into the specified array of bytes.
CurrentProcessId	Retrieves the process identifier for the active process.
CurrentThreadId	Determines the process identifier for the current thread of execution in the application.
DebugOutput	Writes output used during debugging.
Fetch	Parses a token from the delimited input string.
FetchCaseInsensitive	Parses a token from the delimited input string without case-sensitivity.
FillBytes	Initializes a specified number of bytes in an array of bytes to a specific value.
GetThreadHandle	Retrieves the handle or identifier for the specified thread.
GetTickDiff	Calculates the elapsed tick count from two tick count values.
IdDelete	Deletes a number of characters from a String beginning at a given position.
IdInsert	Inserts a string value into an existing string at the indicated position.
IdPorts	List of defined ports in the services file for the local host.
iif	Derives a return value based on a conditional expression.
iif	Derives a return value based on a conditional expression.
iif	Derives a return value based on a conditional expression.
IndyCompareStr	Compares two strings case sensitively.
IndyLowerCase	Converts a string to it's lowercase representation.
IndyUpperCase	Converts a string to it's uppercase representation.
InMainThread	Determine if the current thread is the main thread for the application.
IPv4ToDWord	Converts an IP version 4 IP address to its representation as an unsigned 32-bit numeric value.
IPv4ToDWord	Converts an IP version 4 IP address to its representation as an unsigned 32-bit numeric value.
IPv4ToHex	Converts an IP version 4 address to its hexadecimal representation.
IPv4ToOctal	Converts an IP version 4 address to its octal representation.
IPv6AddressToStr	Converts an IPV6 address to a colon-delimited hexidecimal string.
IPv6ToIdIPv6Address	Converts a string to an IPv6 network address.
IsASCII	Determines if the byte value can be represented using characters from the US-ASCII character set.
IsASCII	Determines if byte values can be represented in the US-ASCII character set.
IsASCIILDH	Determines if a byte value is a Letter, Digit, or Hyphen in the US-ASCII character set.
IsASCIILDH	Determines if a byte values contain only Letters, Digits, or Hyphens in the US-ASCII character set.
IsCurrentThread	Determines if the specified thread is the current thread of execution.
IsHexidecimal	Determines if the character is a valid hexadecimal digit.
IsHexidecimal	Determines if the characters are valid hexadecimal digit.
IsNumeric	Determines if the character is a valid numeric digit.
IsNumeric	Determines if the characters are valid numeric digits.
IsOctal	Determines if the character is a valid octal digit.
IsOctal	Determines if the characters are valid octal digits.
MakeCanonicalIPv4Address	Converts and IP version 4 address to its simplest and most significant form.
MakeCanonicalIPv6Address	Converts and IP version 6 address to its simplest and most significant form.
MakeDWordIntoIPv4Address	Converts a numeric internet address to its canonical representation in dotted decimal form.
Max	Determines the larger of two 64-bit Integer values.
MemoryPos	Locates a string occurring in the specified memory buffer.
Min	Determines the smaller of two 64-bit integer values.
PosIdx	Locates the position of a string within another string.
PosInSmallIntArray	Determines the position of the specified SmallInt value in an array of SmallInt values.
PosInStrArray	Searches an array of strings for an occurrence of the search string.
RawToBytes	Converts values to their representation as a TIdBytes data type.
RawToBytesF	Copies untyped values into a fixed-size array of Bytes.
ReadCharFromStream	Reads a character value from a stream implementation.
ReadLnFromStream	Reads a line of text from a stream.
ReadStringFromStream	Reads a string value from a stream implementation.
ReadTIdBytesFromStream
ServicesFilePath	Determines the location of the services file for the local file system.
SetThreadName	Sets the name for the current thread of execution.
SetThreadPriority	Adjusts the priority of a thread relative to other processes.
Sleep	Suspends the current thread for the specified number of milliseconds.
SplitColumns	Separates values specified in AData into columns.
SplitColumnsNoTrim	Separates values specified in AData into columns.
StartsWithACE
TextIsSame	Compares strings based on the current locale without case sensitivity.
TextStartsWith	Checks for the specified substring at the beginning of the specified text.
Ticks	Retrieves the number of milliseconds since the computer was started.
ToBytes	Converts the data type to a TIdBytes value.
ToBytes	Converts the data type to a TIdBytes value.
ToBytes	Converts the data type to a TIdBytes value.
ToBytes	Converts the data type to a TIdBytes value.
ToBytes	Converts the data type to a TIdBytes value.
ToBytes	Converts the data type to a TIdBytes value.
ToBytes	Converts the data type to a TIdBytes value.
ToBytes	Converts the data type to a TIdBytes value.
ToBytes	Converts the data type to a TIdBytes value.
ToBytesF
ToBytesF
ToBytesF
ToBytesF
ToBytesF
ToBytesF
ToBytesF
ToBytesF
ToDo
ToHex	Converts values to their hexadecimal representation.
ToHex	Converts values to their hexadecimal representation.
TwoByteToWord	Converts two byte values to their Word representation.
WriteMemoryStreamToStream	Writes the contents of a memory stream to a TStream descendant.
WriteStringToStream	Writes a string data type to a stream.
WriteTIdBytesToStream	Write TIdBytes values to a TStream.

Types

Type	Description
PCardinal	This is type PCardinal.
Short	Native storage format for 16-bit Integer values on the .Net platform.
TBytes	Array of byte data type for Windows and Linix.
THandle	Represents file, socket, or thread handles used in the Indy library.
TIdBytes	Represents a platform-agnostic string representation.
TIdIPv6Address	Represents the native storage for an IPv6 address.
TIdPID	Represents an Indy process identifier.
TIdPort	Represents port numbers used for connections in the Indy library.
TIdThreadPriority	Indicates the scheduling priority for a thread.
TPosProc

Variables

Variable	Description
IndyPos	Specifies the Pos function handler for single- or multi-byte character sets.

Post feedback to the Indy Docs Newsgroup.