# All Functions and Procedures

Name | Unit | Description
--- | --- | ---
AnsiCDateTime | synautil | Returns date and time in format defined in ANSI C compilers in format "ddd mmm d hh:nn:ss yyyy"
ASNDecLen | asn1util | Decodes length of next element in "Buffer" from the "Start" position.
ASNDecOIDItem | asn1util | Decodes an OID item of the next element in the "Buffer" from the "Start" position.
ASNdump | asn1util | Convert ASN.1 BER encoded buffer to human readable form for debugging.
ASNEncInt | asn1util | Encodes a signed integer to ASN.1 binary
ASNEncLen | asn1util | Encodes the length of ASN.1 element to binary.
ASNEncOIDItem | asn1util | Encodes OID item to binary form.
ASNEncUInt | asn1util | Encodes unsigned integer into ASN.1 binary
ASNItem | asn1util | Beginning with the "Start" position, decode the ASN.1 item of the next element in "Buffer". Type of item is stored in "ValueType."
ASNObject | asn1util | Encodes ASN.1 object to binary form.
BinToInt | synautil | Returns an integer equivalent of the binary string in "Value". (i.e. ('10001010') returns 138)
CDateTime | synautil | Returns date and time in format defined in C compilers in format "mmm dd hh:nn:ss"
CharsetConversion | synachar | Convert Value from one charset to another. See: CharsetConversionEx
CharsetConversionEx | synachar | Convert Value from one charset to another with additional character conversion. see: Replace_None and Replace_Czech
CharsetConversionTrans | synachar | Convert Value from one charset to another with additional character conversion. This funtion is similar to CharsetConversionEx, but you can disable transliteration of unconvertible characters.
CodeInt | synautil | Return two characters, which ordinal values represents the value in byte format. (High-endian)
CodeLongInt | synautil | Return four characters, which ordinal values represents the value in byte format. (High-endian)
CountOfChar | synautil | Return count of Chr in Value string.
Crc16 | synacode | return CRC16 from a value string.
Crc32 | synacode | return CRC32 from a value string.
Decode4to3 | synacode | Decode 4to3 encoding with given table. If some element is not found in table, first item from table is used. This is good for buggy coded items by Microsoft Outlook. This software sometimes using wrong table for UUcode, where is used ' ' instead '`'.
Decode4to3Ex | synacode | Decode 4to3 encoding with given REVERSE table. Using this function with reverse table is much faster then Decode4to3. This function is used internally for Base64, UU or XX decoding.
DecodeBase64 | synacode | Decode string from base64 format.
DecodeBase64mod | synacode | Decode string from modified base64 format. (used in IMAP, for example.)
DecodeInt | synautil | Decodes two characters located at "Index" offset position of the "Value" string to Word values.
DecodeLongInt | synautil | Decodes four characters located at "Index" offset position of the "Value" string to LongInt values.
DecodeQuotedPrintable | synacode | Decodes a string from quoted printable form. (also decodes triplet sequences like '=7F')
DecodeRfcDateTime | synautil | Decode various string representations of date and time to Tdatetime type. This function do all timezone corrections too! This function can decode lot of formats like:
     ddd, d mmm yyyy hh:mm:ss
     ddd, d mmm yy hh:mm:ss
     ddd, mmm d yyyy hh:mm:ss
     ddd mmm dd hh:mm:ss yyyy
and more with lot of modifications, include:
    Sun, 06 Nov 1994 08:49:37 GMT    ; RFC 822, updated by RFC 1123
    Sunday, 06-Nov-94 08:49:37 GMT   ; RFC 850, obsoleted by RFC 1036
    Sun Nov  6 08:49:37 1994         ; ANSI C
Timezone corrections known lot of symbolic timezone names (like CEST, EDT, etc.) or numeric representation (like +0200). By convention defined in RFC timezone +0000 is GMT and -0000 is current your system timezone.
DecodeTriplet | synacode | Decodes triplet encoding with a given character delimiter. It is used for decoding quoted-printable or URL encoding.
DecodeURL | synacode | Decodes a string of URL encoding. (also decodes triplet sequences like '%7F')
DecodeUU | synacode | Decodes a string from UUcode format.
DecodeXX | synacode | Decodes a string from XXcode format.
DecodeYEnc | synacode | decode line with Yenc code. This code is sometimes used in newsgroups.
Dump | synautil | Dump binary buffer stored in a string to a file with DumpFile filename.
DumpEx | synautil | Dump binary buffer stored in a string to a file with DumpFile filename. All bytes with code of character is written as character, not as hexadecimal value.
DumpExStr | synautil | Dump binary buffer stored in a string to a result string. All bytes with code of character is written as character, not as hexadecimal value.
DumpStr | synautil | Dump binary buffer stored in a string to a result string.
Encode3to4 | synacode | Encode by system 3to4 (used by Base64, UU coding, etc) by given table.
EncodeBase64 | synacode | Encodes a string to base64 format.
EncodeBase64mod | synacode | Encodes a string to modified base64 format. (used in IMAP, for example.)
EncodeQuotedPrintable | synacode | Encodes a string to triplet quoted printable form. All NonAsciiChar are encoded.
EncodeSafeQuotedPrintable | synacode | Encodes a string to triplet quoted printable form. All NonAsciiChar and SpecialChar are encoded.
EncodeTriplet | synacode | Performs triplet encoding with a given character delimiter. Used for encoding quoted-printable or URL encoding.
EncodeURL | synacode | Encodes a string to URL format. Used to encode critical characters in all URLs.
EncodeURLElement | synacode | Encodes a string to URL format. Used for encoding data from a form field in HTTP, etc. (Encodes all critical characters including characters used as URL delimiters ('/',':', etc.)
EncodeUU | synacode | encode UUcode. it encode only datas, you must also add header and footer for proper encode.
Fetch | synautil | Fetch string from left of Value string.
FetchBin | synautil | Like Fetch, but working with binary strings, not with text.
FetchEx | synautil | Fetch string from left of Value string. This function ignore delimitesr inside quotations.
FtpGetFile | ftpsend | A very useful function, and example of use can be found in the TFtpSend object. Dowload specified file from FTP server to LocalFile.
FtpInterServerTransfer | ftpsend | A very useful function, and example of use can be found in the TFtpSend object. Initiate transfer of file between two FTP servers.
FtpPutFile | ftpsend | A very useful function, and example of use can be found in the TFtpSend object. Upload specified LocalFile to FTP server.
GenerateBoundary | mimepart | Generates a unique boundary string.
GetBetween | synautil | Get string between PairBegin and PairEnd. This function respect nesting. For example:
     Value is: 'Hi! (hello(yes!))'
     pairbegin is: '('
     pairend is: ')'
     In this case result is: 'hello(yes!)'
GetBOM | synachar | Return BOM (Byte Order Mark) for given unicode charset.
GetCPFromID | synachar | Converting string with charset name to TMimeChar.
GetCurCP | synachar | Returns charset used by operating system.
GetCurOEMCP | synachar | Returns charset used by operating system as OEM charset. (in Windows DOS box, for example)
GetDateMDYFromStr | synautil | Decode string in format "m-d-y" to TDateTime type.
GetDNS | synamisc | Autodetect current DNS servers used by system. If is defined more then one DNS server, then result is comma-delimited.
GetEmailAddr | synautil | Returns only the e-mail portion of an address from the full address format. i.e. returns 'nobody@somewhere.com' from '"someone" <nobody@somewhere.com>'
GetEmailDesc | synautil | Returns only the description part from a full address format. i.e. returns 'someone' from '"someone" <nobody@somewhere.com>'
GetIDFromCP | synachar | Converting TMimeChar to string with name of charset.
GetIEProxy | synamisc | Autodetect InternetExplorer proxy setting for given protocol. This function working only on windows!
GetMailServers | dnssend | A very useful function, and example of it's use is found in the TDNSSend object. This function is used to get mail servers for a domain and sort them by preference numbers. "Servers" contains only the domain names of the mail servers in the right order (without preference number!). The first domain name will always be the highest preferenced mail server. Returns boolean `True` if all went well.
GetMonthNumber | synautil | Decode three-letter string with name of month to their month number. If string not match any month name, then is returned 0. For parsing are used predefined names for English, French and German and names from system locale too.
GetParameter | synautil | Returns parameter value from string in format: parameter1="value1"; parameter2=value2
GetSerialPortNames | synaser | Returns list of existing computer serial ports. Working properly only in Windows!
GetTick | synautil | Return current value of system timer with precizion 1 millisecond. Good for measure time difference.
GetTimeFromStr | synautil | Return decoded time from given string. Time must be witch separator ':'. You can use "hh:mm" or "hh:mm:ss".
GetUTTime | synautil | Return current system date and time in UTC timezone.
HeadersToList | synautil | Convert lines in stringlist from 'name: value' form to 'name=value' form.
HMAC_MD5 | synacode | Returns a binary string with HMAC-MD5 hash.
HMAC_SHA1 | synacode | Returns a binary string with HMAC-SHA1 hash.
HttpGetBinary | httpsend | A very usefull function, and example of use can be found in the THTTPSend object. It implements the GET method of the HTTP protocol. This function sends the GET method for URL document to an HTTP server. Returned document is in the "Response" stream. Returns boolean TRUE if all went well.
HttpGetText | httpsend | A very usefull function, and example of use can be found in the THTTPSend object. It implements the GET method of the HTTP protocol. This function sends the GET method for URL document to an HTTP server. Returned document is in the "Response" stringlist (without any headers). Returns boolean TRUE if all went well.
HttpPostBinary | httpsend | A very useful function, and example of use can be found in the THTTPSend object. It implements the POST method of the HTTP protocol. This function sends the SEND method for a URL document to an HTTP server. The document to be sent is located in "Data" stream. The returned document is in the "Data" stream. Returns boolean TRUE if all went well.
HttpPostFile | httpsend | A very useful function, and example of use can be found in the THTTPSend object. It implements the POST method of the HTTP protocol. This function sends the POST method for a URL document to an HTTP server. This function simulate posting of file by HTML form used method 'multipart/form-data'. Posting file is in DATA stream. Its name is Filename string. Fieldname is for name of formular field with file. (simulate HTML INPUT FILE) The returned document is in the ResultData Stringlist. Returns boolean TRUE if all went well.
HttpPostURL | httpsend | A very useful function, and example of use can be found in the THTTPSend object. It implements the POST method of the HTTP protocol. This function is good for POSTing form data. It sends the POST method for a URL document to an HTTP server. You must prepare the form data in the same manner as you would the URL data, and pass this prepared data to "URLdata". The following is a sample of how the data would appear: 'name=Lukas&field1=some%20data'. The information in the field must be encoded by EncodeURLElement function. The returned document is in the "Data" stream. Returns boolean TRUE if all went well.
IdealCharsetCoding | synachar | Finding best target charset from set of TMimeChars with minimal count of unconvertible characters.
IdToMib | asn1util | Decodes MIB OID from binary form to string form.
IncPoint | synautil | Increase pointer by value.
IndexByBegin | synautil | Index of string in stringlist with same beginning as Value is returned.
InlineCode | mimeinln | Inline MIME encoding similar to InlineEncode, but the source charset is automatically set to the system default charset, and the target charset is automatically assigned from set of allowed encoding for MIME.
InlineCodeEx | mimeinln | Inline mime encoding similar to InlineEncode, but you can specify source charset, and the target characterset is automatically assigned.
InlineDecode | mimeinln | Decodes mime inline encoding (i.e. in headers) uses target characterset "CP".
InlineEmail | mimeinln | Converts e-mail address to canonical mime form. Source charser it system default charset.
InlineEmailEx | mimeinln | Converts e-mail address to canonical mime form. You can specify source charset.
InlineEncode | mimeinln | Encodes string to MIME inline encoding. The source characterset is "CP", and the target charset is "MimeP".
IntMibToStr | asn1util | Encodes an one number from MIB OID to binary form. (used internally from MibToId)
IntToBin | synautil | Returns a string of binary "Digits" representing "Value".
IPToID | synautil | Returns a string with the "Host" ip address converted to binary form.
IsBinaryString | synautil | If string is binary string (contains non-printable characters), then is returned true.
IsIP | synautil | Returns `True`, if "Value" is a valid IPv4 address. Cannot be a symbolic Name!
IsIP6 | synautil | Returns `True`, if "Value" is a valid IPv6 address. Cannot be a symbolic Name!
LDAPResultDump | ldapsend | Dump result of LDAP SEARCH into human readable form. Good for debugging.
ListToHeaders | synautil | Convert lines in stringlist from 'name=value' form to 'name: value' form.
MD5 | synacode | Returns a binary string with a RSA-MD5 hashing of "Value" string.
MD5LongHash | synacode | Returns a binary string with a RSA-MD5 hashing of string what is constructed by repeating "value" until length is "Len".
MibToId | asn1util | Encodes an MIB OID string to binary form.
NeedCharsetConversion | synachar | return `True` when value need to be converted. (It is not 7-bit ASCII)
NeedInline | mimeinln | Returns `True`, if "Value" contains characters needed for inline coding.
NormalizeHeader | mimepart | Read header from "Value" stringlist beginning at "Index" position. If header is Splitted into multiple lines, then this procedure de-split it into one line.
ParseParameters | synautil | parse value string with elements differed by ';' into stringlist.
ParseParametersEx | synautil | parse value string with elements differed by Delimiter into stringlist.
ParseURL | synautil | Parses a URL to its various components.
PingHost | pingsend | A very useful function and example of its use would be found in the TPINGSend object. Use it to ping to any host. If successful, returns the ping time in milliseconds. Returns -1 if an error occurred.
PosCRLF | synautil | return position of string terminator in string. If terminator found, then is returned in terminator parameter. Possible line terminators are: CRLF, LFCR, CR, LF
PosFrom | synautil | Like Pos function, buf from given string possition.
ReadStrFromStream | synautil | read string with requested length form stream.
RecvTrap | snmpsend | A very useful function and example of its use would be found in the TSNMPSend object. It receives a TRAPv1 and returns all the data that comes with it.
ReplaceString | synautil | Replaces all "Search" string values found within "Value" string, with the "Replace" string value.
Rfc822DateTime | synautil | Returns current time in format defined in RFC-822. Useful for SMTP messages, but other protocols use this time format as well. Results contains the timezone specification. Four digit year is used to break any Y2K concerns. (Example 'Fri, 15 Oct 1999 21:14:56 +0200')
RPos | synautil | It is like POS function, but from right side of Value string.
RPosEx | synautil | It is like RPos, but search is from specified possition.
SendTo | smtpsend | A very useful function and example of its use would be found in the TSMTPsend object. Send "Maildata" (text of e-mail without any SMTP headers!) from "MailFrom" e-mail address to "MailTo" e-mail address with "Subject". (If you need more then one receiver, then separate their addresses by comma). This function constructs all needed SMTP headers (with DATE header) and sends the e-mail to the SMTP server defined in the "SMTPhost" parameter. If the e-mail message is successfully sent, the result will be `True`. If you need use different port number then standard, then add this port number to SMTPhost after colon. (i.e. '127.0.0.1:1025')
SendToEx | smtpsend | A very useful function and example of its use would be found in the TSMTPsend object. Sends "MailData" (text of e-mail without any SMTP headers!) from "MailFrom" e-mail address to "MailTo" e-mail address (If you need more then one receiver, then separate their addresses by comma). This function sends the e-mail to the SMTP server defined in the "SMTPhost" parameter. Username and password are used for authorization to the "SMTPhost". If you dont want authorization, set "Username" and "Password" to empty Strings. If the e-mail message is successfully sent, the result will be `True`. If you need use different port number then standard, then add this port number to SMTPhost after colon. (i.e. '127.0.0.1:1025')
SendToRaw | smtpsend | A very useful function and example of its use would be found in the TSMTPsend object. Send maildata (text of e-mail with all SMTP headers! For example when text of message is created by TMimeMess object) from "MailFrom" e-mail address to "MailTo" e-mail address (If you need more then one receiver, then separate their addresses by comma). Function sends e-mail to a SMTP server defined in "SMTPhost" parameter. Username and password are used for authorization to the "SMTPhost". If you don't want authorization, set "Username" and "Password" to empty strings. If e-mail message is successfully sent, the result returns `True`. If you need use different port number then standard, then add this port number to SMTPhost after colon. (i.e. '127.0.0.1:1025')
SendTrap | snmpsend | A very useful function and example of its use would be found in the TSNMPSend object. It implements a TRAPv1 to send with all data in the parameters.
SeparateLeft | synautil | Returns a portion of the "Value" string located to the left of the "Delimiter" string. If a delimiter is not found, results is original string.
SeparateRight | synautil | Returns the portion of the "Value" string located to the right of the "Delimiter" string. If a delimiter is not found, results is original string.
SetUTTime | synautil | Set Newdt as current system date and time in UTC timezone. This function work only if you have administrator rights!
SHA1 | synacode | Returns a binary string with a SHA-1 hashing of "Value" string.
SHA1LongHash | synacode | Returns a binary string with a SHA-1 hashing of string what is constructed by repeating "value" until length is "Len".
SimpleDateTime | synautil | Returns date and time in format defined in format 'yymmdd hhnnss'
SNMPGet | snmpsend | A very useful function and example of its use would be found in the TSNMPSend object. It implements basic GET method of the SNMP protocol. The MIB value is located in the "OID" variable, and is sent to the requested "SNMPHost" with the proper "Community" access identifier. Upon a successful retrieval, "Value" will contain the information requested. If the SNMP operation is successful, the result returns `True`.
SNMPGetNext | snmpsend | A very useful function and example of its use would be found in the TSNMPSend object. It implements basic GETNEXT method of the SNMP protocol. The MIB value is located in the "OID" variable, and is sent to the requested "SNMPHost" with the proper "Community" access identifier. Upon a successful retrieval, "Value" will contain the information requested. If the SNMP operation is successful, the result returns `True`.
SNMPGetTable | snmpsend | A very useful function and example of its use would be found in the TSNMPSend object. It implements basic read of SNMP MIB tables. As BaseOID you must specify basic MIB OID of requested table (base IOD is OID without row and column specificator!) Table is readed into stringlist, where each string is comma delimited string. Warning: this function is not have best performance. For better performance you must write your own function. best performace you can get by knowledge of structuture of table and by more then one MIB on one query.
SNMPGetTableElement | snmpsend | A very useful function and example of its use would be found in the TSNMPSend object. It implements basic read of SNMP MIB table element. As BaseOID you must specify basic MIB OID of requested table (base IOD is OID without row and column specificator!) As next you must specify identificator of row and column for specify of needed field of table.
SNMPSet | snmpsend | This is useful function and example of use TSNMPSend object. It implements the basic SET method of the SNMP protocol. If the SNMP operation is successful, the result is `True`. "Value" is value of MIB Oid for "SNMPHost" with "Community" access identifier. You must specify "ValueType" too.
StringsTrim | synautil | Delete empty strings from end of stringlist.
StringToWide | synachar | Convert binary string with unicode content to WideString.
StrToHex | synautil | Returns a string with hexadecimal digits representing the corresponding values of the bytes found in "Value" string.
SwapBytes | synautil | swap bytes in integer.
TickDelta | synautil | Return difference between two timestamps. It working fine only for differences smaller then maxint. (difference must be smaller then 24 days.)
TimeZone | synautil | Return your timezone bias from UTC time in string representation like "+0200".
TimeZoneBias | synautil | Return your timezone bias from UTC time in minutes.
ToSysLog | slogsend | Simply send packet to specified Syslog server.
TraceRouteHost | pingsend | A very useful function and example of its use would be found in the TPINGSend object. Use it to TraceRoute to any host.
TrimSP | synautil | Like Trim, but remove only spaces, not control characters!
TrimSPLeft | synautil | Like TrimLeft, but remove only spaces, not control characters!
TrimSPRight | synautil | Like TrimRight, but remove only spaces, not control characters!
UnquoteStr | synautil | Remove quotation from Value string. If Value is not quoted, then return same string without any modification.
UpdateCrc16 | synacode | Returns a new CRC16 value after adding a new byte of data.
UpdateCrc32 | synacode | Returns a new CRC32 value after adding a new byte of data.
WakeOnLan | synamisc | By this function you can turn-on computer on network, if this computer supporting Wake-on-lan feature. You need MAC number (network card indentifier) of computer for turn-on. You can also assign target IP addres. If you not specify it, then is used broadcast for delivery magic wake-on packet. However broadcasts workinh only on your local network. When you need to wake-up computer on another network, you must specify any existing IP addres on same network segment as targeting computer.
WideToString | synachar | Convert WideString to binary string with unicode content.
WriteStrToStream | synautil | write string to stream.

Generated by PasDoc 0.8.8.2 on 2005-01-19 20:01:20