Advantage Database RDD

ADSBlob2File()	Write a Binary (memo) field's contents to a file
ADSClearAOF()	Clears an Advantage Optimized Filter in the current workarea.
ADSCustomizeAOF()	Add or remove records from an existing AOF
ADSEvalAOF()	Evaluate a filter expression to determine its optimization level
ADSFile2Blob()	Save a Binary file to a field
ADSGetAOF()	Retrieve the filter expression used in the call to AdsSetAOF
ADSGetAOFnoOpt()	Return the non-optimized portion of the current filter expression
ADSGetAOFoptLevel()	Returns optimization level of the current AOF filter
ADSGetRelKeyPos()	Estimated key position of current record within the specified index
ADSIsRecordInAOF()	Determine if a record is in the current AOF
ADSKeyCount()	Retrieve the number of keys in a specified index
ADSKeyNo()	Get the logical key number of the current record in the given index
ADSLocking()	Turns on/off the Advantage proprietary locking mode
ADSRefreshAOF()	Update the filter snapshot
ADSRightsCheck()	Sets the "rights checking" setting for opening files
ADSSetAOF()	Create an Advantage Optimized Filter

Array

AADD()	Dynamically add an element to an array
ACHOICE()	Allows selection of an element from an array
ACLONE()	Duplicate a multidimensional array
ACOPY()	Copy elements from one array to another
ADEL()	Delete an element form an array.
ADIR()	Fill pre-defined arrays with file/directory information
AEVAL()	Evaluated the subscript element of an array
AFILL()	Fill an array with a specified value
AINS()	Insert a NIL value at an array subscript position.
ARRAY()	Create an uninitialized array of specified length
ASCAN()	Scan array elements for a specified condition
ASIZE()	Adjust the size of an array
ASORT()	Sort an array
ATAIL()	Returns the rightmost element of an array

Binary conversion

BIN2I()	Convert signed short encoded bytes into Harbour numeric
BIN2L()	Convert signed long encoded bytes into Harbour numeric
BIN2U()	Convert unsigned long encoded bytes into Harbour numeric
BIN2W()	Convert unsigned short encoded bytes into Harbour numeric
I2BIN()	Convert Harbour numeric into signed short encoded bytes
L2BIN()	Convert Harbour numeric into signed long encoded bytes
U2BIN()	Convert Harbour numeric into unsigned long encoded bytes
W2BIN()	Convert Harbour numeric into unsigned short encoded bytes

Classes

TClass()

TClass() is used in the creation of all classes

Code Block

EVAL()	Evaluate a code block
FIELDBLOCK()	Return a code block that sets/gets a value for a given field
FIELDWBLOCK()	Return a sets/gets code block for field in a given work area

Console input

HB_KEYPUT()	Put an inkey code to the keyboard buffer.
INKEY()	Extracts the next key code from the Harbour keyboard buffer.
LASTKEY()	Get the last key extracted from the keyboard buffer.
MCOL()	Returns the mouse cursor column position.
MROW()	Returns the mouse cursor row position.
NEXTKEY()	Get the next key code in the buffer without extracting it.
__KEYBOARD()	DO NOT CALL THIS FUNCTION DIRECTLY!

Conversion

DESCEND()	Inverts an expression of string, logical, date or numeric type.
EMPTY()	Checks if the passed argument is empty.
WORD()	Converts double to integer values.

Conversion Tools

BINTODEC()	Converts a Binary Value to Decimal
DECTOBIN()	Converts a Decimal Value to Binary
DECTOHEXA()	Converts a Decimal Value to Hexa
DECTOOCTAL()	Converts a Decimal Value to Octal
HEXATODEC()	Converts a Hexa Value to Decimal
ISBIN()	Check if the value is a Binary Number
ISDEC()	Check if the value is a Decimal Number
ISHEXA()	Check if the value is a Hexal Number
ISOCTAL()	Check if the value is a Octal Number
OCTALTODEC()	Converts a Octal Value to Decimal

DOS

OS()	Return the current operating system.
__RUN()	Run an external program.

Data input and output

ALERT()	Display a dialog box with a message
BROWSE()	Browse a database file
DBEDIT()*	Browse records in a table
OUTERR()	Write a list of values to the standard error device
OUTSTD()	Write a list of values to the standard output device
READKEY()*	Find out which key terminated a READ.
READVAR()	Return variable name of current GET or MENU
__AtPrompt()	Display a menu item on screen and define a message
__INPUT()	Stops application
__MenuTo()	Invoked a menu defined by set of @...PROMPT
__NONOALERT()	Override //NOALERT command line switch
__TYPEFILE()	Show the content of a file on the console and/or printer
__XRestScreen()	Restore screen image and coordinate from an internal buffer
__XSaveScreen()	Save whole screen image and coordinate to an internal buffer

Database

AFIELDS()	Fills referenced arrays with database field information
ALIAS()	Returns the alias name of a work area
BOF()	Test for the beggining-of-file condition
DBAPPEND()	Appends a new record to a database file.
DBCLEARFILTER()	Clears the current filter condiction in a work area
DBCLOSEALL()	Close all open files in all work areas.
DBCLOSEAREA()	Close a database file in a work area.
DBCOMMIT()	Updates all index and database buffers for a given workarea
DBCOMMITALL()	Flushes the memory buffer and performs a hard-disk write
DBCREATE()	Creates an empty database from a array.
DBDELETE()	Marks records for deletion in a database.
DBEVAL()	Performs a code block operation on the current Database
DBF()	Alias name of a work area
DBFILTER()	Return the filter expression in a work area
DBGOBOTTOM()	Moves the record pointer to the bottom of the database.
DBGOTO()	Position the record pointer to a specific location.
DBGOTOP()	Moves the record pointer to the bottom of the database.
DBRECALL()	Recalls a record previousy marked for deletion.
DBRLOCK()	This function locks the record basedon identify
DBRLOCKLIST()	This function return a list of records in the database work area
DBRUNLOCK()	Unlocks a record base on its indentifier
DBSEEK()	Searches for a value based on an active index.
DBSELECTAREA()	Change to another work area
DBSETDRIVER()	Establishes the name of replaceable daabas driver for a selected work area
DBSETFILTER()	Establishes a filter condition for a work area.
DBSKIP()	Moves the record pointer in the selected work area.
DBSTRUCT()	Creates a multidimensional array of a database structure.
DBUNLOCK()	Unlock a record or release a file lock
DBUNLOCKALL()	Unlocks all records and releases all file locks in all work areas.
DBUSEAREA()	Opens a work area and uses a database file.
DELETED()	Tests the record's deletion flag.
EOF()	Test for end-of-file condition.
FCOUNT()	Counts the number of fields in an active database.
FIELDGET()	Obtains the value of a specified field
FIELDNAME()	Return the name of a field at a numeric field location.
FIELDPOS()	Return the ordinal position of a field.
FIELDPUT()	Set the value of a field variable
FLOCK()	Locks a file
FOUND()	Determine the success of a previous search operation.
HEADER()	Return the length of a database file header
INDEXEXT()	Returns the file extension of the index module used in an application
INDEXKEY()	Yields the key expression of a specified index file.
INDEXORD()	Returns the numeric position of the controlling index.
LASTREC()	Returns the number of records in an active work area or database.
LUPDATE()	Yields the date the database was last updated.
NETERR()	Tests the success of a network function
ORDBAGEXT()	Returns the Order Bag extension
ORDBAGNAME()	Returns the Order Bag Name.
ORDCONDSET()	Set the Condition and scope for an order
ORDCREATE()	Create an Order in an Order Bag
ORDDESTROY()	Remove an Order from an Order Bag
ORDFOR()	Return the FOR expression of an Order
ORDKEY()	Return the key expression of an Order
ORDLISTADD()	Add Orders to the Order List
ORDLISTCLEAR()	Clear the current Order List
ORDLISTREBUILD()	Rebuild all Orders in the Order List of the current work area
ORDNAME()	Return the name of an Order in the Order List
ORDNUMBER()	Return the position of an Order in the current Order List
ORDSETFOCUS()	Set focus to an Order in an Order List
RDDLIST()	Return an array of the available Replaceable Database Drivers
RDDNAME()	Return the name of the currently active RDD
RDDSETDEFAULT()	Set or return the default RDD for the application
RECCOUNT()	Counts the number of records in a database.
RECNO()	Returns the current record number or identity.
RECSIZE()	Returns the size of a single record in an active database.
RLOCK()	Lock a record in a work area
SELECT()	Returns the work area number for a specified alias.
USED()	Checks whether a database is in use in a work area
__DBCONTINUE()	Resume a pending LOCATE
__DBZAP()	Remove all records from the current database file
__FLEDIT()*	Filter a database structure array
__RDDSETDEFAULT()	Set or return the default RDD for the application
__dbCopyStruct()	Create a new database based on current database structure
__dbCopyXStruct()	Copy current database structure into a definition file
__dbCreate()	Create structure extended file or use one to create new file
__dbStructFilter()	Filter a database structure array
dbSkipper()	Helper function to skip a database

Database tools

FIELDDECI()	Determines the number of decimal places of a given numeric field.
FIELDSIZE()	Determines the size of a given field.

Date

ADAYS()	Returns an array with the days names.
AMONTHS()	Returns an array with the months names.
BOM()	Gets the first day in a month.
BOY()	Gets the first date of the year.
CDOW()	Converts a date to the day of week
CMONTH()	Return the name of the month.
CTOD()	Converts a character string to a date expression
DATE()	Return the Current OS Date
DAY()	Return the numeric day of the month.
DAYS()	Convert elapsed seconds into days
DAYSINMONTH()	Gets the days in a month.
DOW()	Value for the day of week.
DOY()	Gets the day number of the year.
DTOC()	Date to character conversion
DTOS()	Date to string conversion
EOM()	Gets the last day in a month.
EOY()	Gets the last date of the year.
ISLEAPYEAR()	Checks if the given date is a leap year.
MONTH()	Converts a date expression to a month value
WOY()	Gets the week number of the year.
YEAR()	Converts the year portion of a date into a numeric value

Dos Tools

CD()	Change the Current Directory
MD()	Creates a Directory
RD()	Remove a Directory

Environment

GETENV()	Obtains system environmental settings.
SET()	Changes or evaluated enviromental settings
SETMODE()	Change the video mode to a specified number of rows and columns
SETTYPEAHEAD()	Sets the typeahead buffer to given size.
VERSION()	Returns the HARBOUR Version or the Harbour/Compiler Version.
__SETCENTURY()	Set the Current Century
__SetFunction()	Assign a character string to a function key

Error recovery

BREAK()	Exits from a BEGIN SEQUENCE block
ERRORSYS()	Install default error handler

Events

HB_SETKEYSAVE()	Returns a copy of internal set-key list, optionally overwriting
HB_SetKeyCheck()	Impliments common hot-key activation code
HB_SetKeyGet()	Determine a set-key code block & condition-block
SETKEY()	Assign an action block to a key
__QUIT()	Terminates an application.
__WAIT()	Stops the application until a key is pressed.

File management

FILE()	Tests for the existence of file(s)
FRENAME()	Renames a file
__Dir()*	Display listings of files

GT

COL()	Returns the current screen column position
MAXCOL()	Returns the maximun number of columns in the current video mode
MAXROW()	Returns the current screen row position
ROW()	Returns the current screen row position
hb_ColorIndex()	Extract one color from a full Clipper colorspec string.

Harbour Tools

TFileRead()	Read a file one line at a time
THtml()	Html Class
TNortonGuide()	Norton Guide Class
TOs2()	OS/2 Documentation Class
TRtf()	Rtf Class
TTroff()	Troff Class

Internal

CLIPINIT()	Initialize various Harbour sub-systems
__SetHelpK()	Set F1 as the default help key
__TextRestore()	Restore console output settings as saved by __TextSave()
__TextSave()	Redirect console output to printer or file and save old settings
__XHELP()	Looks if a Help() user defined function exist.

Low Level

CURDIR()	Returns the current OS directory name.
DIRCHANGE()	Changes the directory
DIRREMOVE()	Attempt to remove an directory
DISKSPACE()	Get the amount of space available on a disk
FCLOSE()	Closes an open file
FCREATE()	Creates a file.
FERASE()	Erase a file from disk
FERROR()	Reports the error status of low-level file functions
FOPEN()	Open a file.
FREAD()	Reads a specified number of bytes from a file.
FREADSTR()	Reads a string from a file.
FSEEK()	Positions the file pointer in a file.
FWRITE()	Writes characters to a file.
HB_DISKSPACE()	Get the amount of space available on a disk
HB_FEOF()	Check for end-of-file.
ISDISK()	Verify if a drive is ready
MAKEDIR()	Create a new directory

Math

ABS()	Return the absolute value of a number.
EXP()	Calculates the value of e raised to the passed power.
INT()	Return the integer port of a numeric value.
LOG()	Returns the natural logarithm of a number.
MAX()	Returns the maximum of two numbers or dates.
MIN()	Determines the minumum of two numbers or dates.
MOD()	Return the modulus of two numbers.
ROUND()	Rounds off a numeric expression.
SQRT()	Calculates the square root of a number.

Misc

PROCFILE()	This function allways returns an empty string.
PROCLINE()	Gets the line number of the current function on the stack.
PROCNAME()	Gets the name of the current function on the stack
TYPE()	Retrieves the type of an expression
VALTYPE()	Retrieves the data type of an expression

Miscellaneous

TONE()

Sound a tone with a specified frequency and duration.

Nation

HB_LANGNAME()	Return the Name of the Current Language module in USE
HB_LANGSELECT()	Select a specific nation message module
ISAFFIRM()	Checks if passed char is an affirmation char
ISNEGATIVE()	Checks if passed char is a negation char.
NATIONMSG()	Returns international strings messages.

Object manipulation

__ObjSetValueList()	Set object with an array of DATA names and values
__objAddData()	Add a DATA to an already existing class
__objAddInline()	Add an INLINE to an already existing class
__objAddMethod()	Add a METHOD to an already existing class
__objDelData()	Delete a DATA (instance variable) from class
__objDelInline()	Delete a METHOD INLINE from class
__objDelMethod()	Delete a METHOD from class
__objDerivedFrom()	Determine whether a class is derived from another class
__objGetMethodList()	Return names of all METHOD for a given object
__objGetMsgList()	Return names of all DATA or METHOD for a given object
__objGetValueList()	Return an array of DATA names and values for a given object
__objHasData()	Determine whether a symbol exist in object as DATA
__objHasMethod()	Determine whether a symbol exist in object as METHOD
__objModInline()	Modify (replace) an INLINE method in an already existing class
__objModMethod()	Modify (replace) a METHOD in an already existing class

Operating System Specific

HB_OSNEWLINE()

Returns the newline character(s) to use with the current OS

Parameter Checks

HB_PVALUE()	Retrieves the value of an argument.
PCOUNT()	Retrieves the number of arguments passed to a function.

String Tools

GT_ASCIISUM()	Sum the ascii values in a string.
GT_ASCPOS()	Return the ascii value of a specified character in a string
GT_ATDIFF()	Return the position where two strings begin to differ
GT_CHAREVEN()	Return a string of all the characters in even positions
GT_CHARMIX()	Amalgamate two strings to form the return value
GT_CHARODD()	Return a string of all the characters in odd positions
GT_CHRCOUNT()	Count the number of times a character appears in a string
GT_CHRFIRST()	Find which character occurs first in a string
GT_CHRTOTAL()	Find number of times a set of characters appears in a string
GT_STRCOUNT()	Count the number of times a substring appears in a string
GT_STRCSPN()	Return length of prefix in string of chars NOT in set.
GT_STRDIFF()	Return a string where it begins to differ from another
GT_STREXPAND()	Insert fillers between characters in a passed string
GT_STRLEFT()	Find length of prefix of a string
GT_STRPBRK()	Return string after 1st char from a set
GT_STRRIGHT()	Find length of a suffix of a string
StrFormat()	Format a string

Strings

ALLTRIM()	Removes leading and trailing blank spaces from a string
ASC()	Returns the ASCII value of a character
AT()	Locates the position of a substring in a main string.
CHR()	Converts an ASCII value to it character value
HARDCR()	Replace all soft carriage returns with hard carriages returns.
HB_ANSITOOEM()	Convert a windows Character to a Dos based character
HB_OEMTOANSI()	Convert a DOS(OEM) Character to a WINDOWS (ANSI) based character
HB_VALTOSTR()	Converts any scalar type to a string.
ISALPHA()	Checks if leftmost character in a string is an alphabetic character
ISDIGIT()	Checks if leftmost character is a digit character
ISLOWER()	Checks if leftmost character is an lowercased letter.
ISUPPER()	Checks if leftmost character is an uppercased letter.
LEFT()	Extract the leftmost substring of a character expression
LEN()	Returns size of a string or size of an array.
LOWER()	Universally lowercases a character string expression.
LTRIM()	Removes leading spaces from a string
MEMOTRAN()	Converts hard and soft carriage returns within strings.
PADC()	Centers an expression for a given width
PADL()	Left-justifies an expression for a given width
PADR()	Right-justifies an expression for a given width
RAT()	Searches for a substring from the right side of a string.
REPLICATE()	Repeats a single character expression
RIGHT()	Extract the rightmost substring of a character expression
RTRIM()	Remove trailing spaces from a string.
SPACE()	Returns a string of blank spaces
STR()	Convert a numeric expression to a character string.
STRTRAN()	Translate substring valuw with a main string
STRZERO()	Convert a numeric expression to a character string, zero padded.
SUBSTR()	Returns a substring from a main string
TRANSFORM()	Formats a value based on a specific picture template.
TRIM()	Remove trailing spaces from a string.
UPPER()	Converts a character expression to uppercase format
VAL()	Convert a number from a character type to numeric

TBrowse Method

AddColumn	Add an New Column to an TBrowse Object
Applykey	Evaluates an code block associated with an specific key
SetKey	Get an optionaly Set an new Code block associated to a inkey value

TBrowse class

TBROWSENew()	Create a Browse Object
TBrowseDB()	Create a new TBrowse object to be used with database file

Terminal

DEVOUTPICT()

Displays a value to a device using a picture template

Time

ELAPTIME()	Calculates elapted time.
SECONDS()	Returns the number of elapsed seconds past midnight.
SECS()	Return the number of seconds from the system date.
TIME()	Returns the system time as a string

Utility

DO()	Calls a procedure or a function

Variable Management

MEMVARBLOCK()	Returns a codeblock that sets/gets a value of memvar variable
__MVCLEAR()	This function releases all PRIVATE and PUBLIC variables
__MVDBGINFO()	This function returns the information about the variables for debugger
__MVGET()	This function returns value of memory variable
__MVPRIVATE()	This function creates a PRIVATE variable
__MVPUBLIC()	This function creates a PUBLIC variable
__MVPUT()	This function set the value of memory variable
__MVRELEASE()	This function releases PRIVATE variables
__MVSCOPE()	If variable exists then returns its scope.
__MVXRELEASE()	This function releases value stored in PRIVATE or PUBLIC variable
__VMVARLGET()	Retrive a local variable from a procedure level