[ Top ] [ Modules ]
DESCRIPTION
Rexx/CSV is an external function package that ...
USAGE
To make the external functions available add the following lines before: the first call to one of the functions in the package:
Call RxFuncAdd 'CSVLoadFuncs', 'rexxcsv', 'CSVLoadFuncs' Call CSVLoadFuncs
DERIVED FROM
TODO
BUGS
PORTABILITY
SEE ALSO
Rexx/CSV lives at http://rexxcsv.sf.net
COPYRIGHT
Rexx/CSV is Copyright(C) 2009-2009 Mark Hessling <mark@rexx.org>
[ Top ] [ Modules ]
DESCRIPTION
The following "constants" are defined when Rexx/CSV starts. By default, all constants are stored in an array with the stem preset to !REXXCSV.! This can be changed by using the 'CONSTANTPREFIX' value of CSVvariable(). If you use "Procedure" on your labels, you MUST "EXPOSE !REXXCSV." or the stem you set with CSVvariable() will not be visible. To reference the constants defined below, you must prefix them. So the "constant" HAVE_REXXCALLBACK would be, by default, referenced in your code as !REXXCSV.!HAVE_REXXCALLBACK.
SEE ALSO
CSVvariable
[ Top ] [ Constants ] [ Definitions ]
NAME
MiscellaneousFlags
DESCRIPTION
The following is a list of miscellaneous flags.
ATTRIBUTES
[ Top ] [ Modules ]
DESCRIPTION
These following functions implement the package functionality.
[ Top ] [ Functions ] [ Functions ]
NAME
CSVfini
SYNOPSIS
rcode = CSVfini( p[, cb1[, cb2, data] )
FUNCTION
??
ARGUMENTS
RESULT
??
SEE ALSO
??
NOTES
SOURCE
... rcode = CSVfini( p[, cb1[, cb2, data] )
[ Top ] [ Functions ] [ Functions ]
NAME
CSVfree
SYNOPSIS
Call CSVfree p
FUNCTION
??
ARGUMENTS
RESULT
??
SEE ALSO
??
NOTES
SOURCE
... Call CSVfree p
[ Top ] [ Functions ] [ Functions ]
NAME
CSVget_delim
SYNOPSIS
rcode = CSVget_delim( p )
FUNCTION
??
ARGUMENTS
RESULT
??
SEE ALSO
??
NOTES
SOURCE
... rcode = CSVget_delim( p )
[ Top ] [ Functions ] [ Functions ]
NAME
CSVget_opts
SYNOPSIS
rcode = CSVget_opts( p )
FUNCTION
??
ARGUMENTS
RESULT
??
SEE ALSO
??
NOTES
SOURCE
... rcode = CSVget_opts( p )
[ Top ] [ Functions ] [ Functions ]
NAME
CSVget_quote
SYNOPSIS
rcode = CSVget_quote( p )
FUNCTION
??
ARGUMENTS
RESULT
??
SEE ALSO
??
NOTES
SOURCE
... rcode = CSVget_quote( p )
[ Top ] [ Functions ] [ Functions ]
NAME
CSVinit
SYNOPSIS
handle = CSVinit( [options] )
FUNCTION
Initialises the CSV function package
ARGUMENTS
RESULT
The CSV handle used in all other Rexx/CSV functions.
SEE ALSO
SOURCE
... handle = CSVinit( options )
[ Top ] [ Functions ] [ Functions ]
NAME
CSVparse
SYNOPSIS
rcode = CSVparse( handle, str, callback, stem[, userdata] )
FUNCTION
This function parses the contents of <str> and for each complete field, sets the array variable specified by <stem>. At the end of a complete record, the Rexx procedure specified by <callback> is called at which time the 0th entry for the <stem> is set.
ARGUMENTS
RESULT
non-zero - error (see !REXXCSV.!CSVCODE and !REXXCSV.!CSVERRM) zero - success
SOURCE
... handle = CSVInit() ... rcode = CSVparse( handle, chunk, 'ProcessRecord', 'record.', mydata ) ... ProcessRecord: Expose !REXXCSV. record. Parse Arg eor, stem, mydata Say 'CSV record terminated by ASCII character:' eor Say 'CSV record contained in stem:' stem Say 'My userdata:' mydata Do i = 1 To record.0 Say 'Field:' i 'contains' record.i End Return
[ Top ] [ Functions ] [ Functions ]
NAME
CSVset_delim
SYNOPSIS
Call CSVset_delim p, c
FUNCTION
??
ARGUMENTS
RESULT
??
SEE ALSO
??
NOTES
SOURCE
... Call CSVset_delim p, c
[ Top ] [ Functions ] [ Functions ]
NAME
CSVset_opts
SYNOPSIS
rcode = CSVset_opts( p, options )
FUNCTION
??
ARGUMENTS
RESULT
??
SEE ALSO
??
NOTES
SOURCE
... rcode = CSVset_opts( p, options )
[ Top ] [ Functions ] [ Functions ]
NAME
CSVset_quote
SYNOPSIS
Call CSVset_quote p, c
FUNCTION
??
ARGUMENTS
RESULT
??
SEE ALSO
??
NOTES
SOURCE
... Call CSVset_quote p, c
[ Top ] [ Functions ] [ Functions ]
NAME
CSVwrite
SYNOPSIS
str = CSVwrite( src[, quote] )
FUNCTION
This function accepts a field value and optional quote character and returns the field value modified with appropriate quotes suitable for writing out to a CSV file.
ARGUMENTS
RESULT
The suitably quoted field data.
SEE ALSO
SOURCE
... fn = 'my.csv' field.1 = "3" field.2 = "It's a field!" field.0 = 2 Do i = 1 To field.0 Call Charout fn, CSVwrite( field.i, "'" ) If i \= field.0 Then Call Charout fn, ',' End Say
[ Top ] [ Modules ]
DESCRIPTION
These functions are common to most Rexx external function packages. They descibe how the behaviour of the package can be changed.
[ Top ] [ PackageManagement ] [ Functions ]
NAME
CSVLoadFuncs
SYNOPSIS
rcode = CSVLoadFuncs()
FUNCTION
Loads all other RexxCSV external functions
ARGUMENTS
None
RESULT
0 in all cases
SEE ALSO
NOTES
[ Top ] [ PackageManagement ] [ Functions ]
NAME
CSVDropFuncs
SYNOPSIS
rcode = CSVDropFuncs(["UNLOAD"])
FUNCTION
Cleans up RexxCSV environment and optionally will drop the external functions.
ARGUMENTS
RESULT
0 in all cases
SEE ALSO
NOTES
[ Top ] [ PackageManagement ] [ Functions ]
NAME
CSVVariable
SYNOPSIS
rcode = CSVVariable(Variable [,NewValue])
FUNCTION
Get or set an internal RexxCSV variable.
ARGUMENTS
RESULT
When setting a variable, then 0 if success, any other value is an error When getting a variable, then the value of the variable is returned.
NOTES
The "Variable" argument can be one of:
DEBUG (settable)
0 - no debugging
1 - all Rexx variables set by RexxCSV are displayed as they are set
2 - all RexxCSV functions are traced on entry with argument values and
on exit with the return value
4 - all internal RexxCSV functions are traced with their arguments
(really only useful for developers)
The values can be added together for a combination of the above details.
DEBUGFILE (settable)
Where any debugging output is written. By default this goes to
the system's error stream; usually 'stderr'.
CONSTANTPREFIX (settable)
The variable name prefix for all RexxCSV constants. By default this is
'!REXXCSV.!'. If you change this, it is useful to make the prefix result
in stemmed variables; this makes it far easier to EXPOSE these constants.
VERSION (readonly)
The full version details of RexxCSV in the format:
package version version_date
Where:
package - the string 'rexxcsv'
version - package version in n.n format; eg 1.0
version_date - date package was released in DATE('N') format
SOURCE
... Say 'We are running at debug level:' CSVVariable( 'DEBUG' )
[ Top ] [ PackageManagement ] [ Functions ]
NAME
CSVQueryFunction
SYNOPSIS
rcode = CSVQueryFunction(FunctionName|ResultArray[, Option])
FUNCTION
Populates an array of all functions supplied by this package depending on Option
ARGUMENTS
RESULT
0 if successful or 1 if the FunctionName is not found
NOTES
To determine if a FunctionName can be executed in your code, pass the function name as the first argument, and 'R' as the second. If the function can be called the function returns 0, otherwise it returns 1