.NET Framework Functions

All XML streams are described in detail here.

Create connection strings

GetConnectionString Create a connection string

Description

LINK2i functions require an encrypted connection string containing the IP address of the targeted IBM i partition and IBM i session credentials (username/password). This connection string is generated using GetConnectionString. The IBM i access is limited to the security roles established in the IBM i for the specified account.

Parameters

IP string
IP address or network location of the targeted IBM i partition
userName string
User name of an IBM i account
password string
Password corresponding to the username

Returns

GetConnectionString() string
LINK2i connection string as string
Error message on failure as String

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string IP = "192.168.2.19";
string userName = "QSECOFR";
string password = "PW1234";

//Function call
result = db2.GetConnectionString(IP ,userName ,password);

//Returned results
result = "connection string to use in other functions";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim IP As String = "192.168.2.19"
Dim userName As String = "QSECOFR"
Dim password As String = "PW1234"

'Function call
result = db2.GetConnectionString(IP ,userName ,password)

'Returned results
result = "connection string to use in other functions"

Explore targeted IBM i partition

These functions allow you to explore the targeted IBM i partition to get a quick in-depth overview of what's inside your machine. They can also be used to interact with other LINK2i functions to specify libraries, files, create user-friendly query wizards...

GetSerialNumberIBMi Retreive targeted IBM i serial number and OS details

Description

Retreuves targeted IBM i serial number, OS and processoor group.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days

Returns

GetSerialNumberIBMi() string
IBM i information as string
Error message on failure as String
ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";

//Function call
result = db2.GetSerialNumberIBMi(connString ,sessionID ,licenseStatus);

//Returned results
result = "V7R4M0 ABC123 - connection OK";
licenseStatus = "125";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""

'Function call
result = db2.GetSerialNumberIBMi(connString ,sessionID ,licenseStatus)

'Returned results
result = "V7R4M0 ABC123 - connection OK"
licenseStatus = "125"

ListDatabases Databases/Libraries inventory

Description

ListDatabases extracts a list of all databases/libraries from the targeted IBM i partition as a DataTable object or XML string.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
resultList System.Data.DataTable
Returned by ref, list of database/library names as a DataTable

Returns

ListDatabases() string
List as XML string
Error message on failure as String
Optional - List as DataTable passed by ref
ref licenseStatus string
ref resultList System.Data.DataTable

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
System.Data.DataTable resultList = new System.Data.DataTable();

//Function call
result = db2.ListDatabases(connString ,sessionID ,licenseStatus ,resultList);

//Returned results
result = "?";
licenseStatus = "125";
resultList //Returned by ref, list of database/library names as a DataTable: Optional - System.Data.DataTable(Optional ByRef);


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim resultList As New System.Data.DataTable

'Function call
result = db2.ListDatabases(connString ,sessionID ,licenseStatus ,resultList)

'Returned results
result = "?"
licenseStatus = "125"
resultList 'Returned by ref, list of database/library names as a DataTable: Optional - System.Data.DataTable(Optional ByRef)

ListTables Tables/files inventory in a database/library

Description

ListTables extracts a list of all tables/files of the specified database/library from the targeted IBM i partition as a DataTable object or XML string.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
base string
Name of the database/library whose tables/files are to be listed
resultList System.Data.DataTable
Returned by ref, list of table/file names as a DataTable

Returns

ListTables() string
List as XML string
Error message on failure as String
Optional - List as DataTable passed by ref
ref licenseStatus string
ref resultList System.Data.DataTable

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string base = "LIBTEST";
System.Data.DataTable resultList = new System.Data.DataTable();

//Function call
result = db2.ListTables(connString ,sessionID ,licenseStatus ,base ,resultList);

//Returned results
result = "?";
licenseStatus = "125";
resultList //list of tables/files in LIBTEST;


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim base As String = "LIBTEST"
Dim resultList As New System.Data.DataTable

'Function call
result = db2.ListTables(connString ,sessionID ,licenseStatus ,base ,resultList)

'Returned results
result = "?"
licenseStatus = "125"
resultList 'list of tables/files in LIBTEST

ListFields Fields inventory in a table/file

Description

ListFields extracts a list of all fields of the specified table/file of the specified database/library from the targeted IBM i partition as a DataTable object or XML string.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
base string
Database/library containing the table/file whose fields are to be listed
table string
Table/file whose fields are to be listed
recCount string
Returned by ref, number of records in the table/file
resultList System.Data.DataTable
Returned by ref, list of field names as a DataTable

Returns

ListFields() string
List as XML string
Error message on failure as String
Optional - List as DataTable passed by ref
ref licenseStatus string
ref recCount string
ref resultList System.Data.DataTable

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string base = "LIBTEST";
string table = "TABLETEST";
string recCount = "";
System.Data.DataTable resultList = new System.Data.DataTable();

//Function call
result = db2.ListFields(connString ,sessionID ,licenseStatus ,base ,table ,recCount ,resultList);

//Returned results
result = "?";
licenseStatus = "125";
recCount = "25";
resultList //list of LIBTEST.TABLETEST fields;


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim base As String = "LIBTEST"
Dim table As String = "TABLETEST"
Dim recCount As String = ""
Dim resultList As New System.Data.DataTable

'Function call
result = db2.ListFields(connString ,sessionID ,licenseStatus ,base ,table ,recCount ,resultList)

'Returned results
result = "?"
licenseStatus = "125"
recCount = "25"
resultList 'list of LIBTEST.TABLETEST fields

ListPrograms Inventory of programs of a database

Description

ListPrograms extracts a list of all programs of the specified database/library from the targeted IBM i partition as a DataTable object or XML string.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
base string
Database/library whose programs are to be listed
resultList System.Data.DataTable
Returned by ref, list of program names as a DataTable

Returns

ListPrograms() string
List as XML string
Error message on failure as String
Optional - List as DataTable passed by ref
ref licenseStatus string
ref resultList System.Data.DataTable

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string base = "LIBTEST";
System.Data.DataTable resultList = new System.Data.DataTable();

//Function call
result = db2.ListPrograms(connString ,sessionID ,licenseStatus ,base ,resultList);

//Returned results
result = "";
licenseStatus = "125";
resultList //list of programs in LIBTEST;


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim base As String = "LIBTEST"
Dim resultList As New System.Data.DataTable

'Function call
result = db2.ListPrograms(connString ,sessionID ,licenseStatus ,base ,resultList)

'Returned results
result = ""
licenseStatus = "125"
resultList 'list of programs in LIBTEST

ListSources Inventory of source files of a database

Description

ListSources extracts a list of all source files of the specified database/library from the targeted IBM i partition as a DataTable object or XML string.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
base string
Database/library whose source files are to be listed
resultList System.Data.DataTable
Returned by ref, list of source file names as a DataTable

Returns

ListSources() string
List as XML string
Error message on failure as String
Optional - List as DataTable passed by ref
ref licenseStatus string
ref resultList System.Data.DataTable

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string base = "LIBTEST";
System.Data.DataTable resultList = new System.Data.DataTable();

//Function call
result = db2.ListSources(connString ,sessionID ,licenseStatus ,base ,resultList);

//Returned results
result = "";
licenseStatus = "125";
resultList //list of sources in LIBTEST;


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim base As String = "LIBTEST"
Dim resultList As New System.Data.DataTable

'Function call
result = db2.ListSources(connString ,sessionID ,licenseStatus ,base ,resultList)

'Returned results
result = ""
licenseStatus = "125"
resultList 'list of sources in LIBTEST

ListMembers Inventory of source members of a source file of a database

Description

ListMembers extracts a list of all members of the specified source file of the specified database/library from the targeted IBM i partition as a DataTable object or XML string.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
base string
Database/library whose members are to be listed
srcFile string
Source file whose members are to be listed
resultList System.Data.DataTable
Returned by ref, list of member names as a DataTable

Returns

ListMembers() string
List as XML string
Error message on failure as String
Optional - List as DataTable passed by ref
ref licenseStatus string
ref resultList System.Data.DataTable

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string base = "LIBTEST";
string srcFile = "SOURCETEST";
System.Data.DataTable resultList = new System.Data.DataTable();

//Function call
result = db2.ListMembers(connString ,sessionID ,licenseStatus ,base ,srcFile ,resultList);

//Returned results
result = "";
licenseStatus = "125";
resultList //list of LIBTEST.SOURCETEST members;


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim base As String = "LIBTEST"
Dim srcFile As String = "SOURCETEST"
Dim resultList As New System.Data.DataTable

'Function call
result = db2.ListMembers(connString ,sessionID ,licenseStatus ,base ,srcFile ,resultList)

'Returned results
result = ""
licenseStatus = "125"
resultList 'list of LIBTEST.SOURCETEST members

GetObjectDetails Details of an IBM i object

Description

GetObjectDetails retreives details of any IBM i object as an XML string. It can be used with gridView and formView objects to display object details in a 5250 like interface.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
base string
Database/library containing the IBM i object
ibmObject string
IBM i object Name
objType string
IBM i object type (*PGM, *FILE, *DEVD, etc...)
gridViewObject System.Web.UI.WebControls.GridView
Optional empty GridView used to display object details. Has to be declared in the code as a System.Web.UI.WebControls.GridView type object. Leave empty to use only XML data returned by the function.
formViewObject System.Web.UI.WebControls.FormView
Optional FormView in an ASP.NET Form used to display object details. Leave empty to use only XML data returned by the function.

Returns

GetObjectDetails() string
Data as XML String
Error message on failure as String
Optional - Populates a formView object passed by ref (also rerquires a gridView passed by ref)
ref licenseStatus string
ref gridViewObject System.Web.UI.WebControls.GridView
ref formViewObject System.Web.UI.WebControls.FormView

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string base = "LIBTEST";
string ibmObject = "OBJTEST";
string objType = "*PGM";
System.Web.UI.WebControls.GridView gridViewObject = new System.Web.UI.WebControls.GridView();
System.Web.UI.WebControls.FormView formViewObject = new System.Web.UI.WebControls.FormView();

//Function call
result = db2.GetObjectDetails(connString ,sessionID ,licenseStatus ,base ,ibmObject ,objType ,gridViewObject ,formViewObject);

//Returned results
result = "";
licenseStatus = "125";
gridViewObject //Gridview populated with object details rows;
formViewObject //Formview populated with object details rows;


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim base As String = "LIBTEST"
Dim ibmObject As String = "OBJTEST"
Dim objType As String = "*PGM"
Dim gridViewObject As New System.Web.UI.WebControls.GridView
Dim formViewObject As New System.Web.UI.WebControls.FormView

'Function call
result = db2.GetObjectDetails(connString ,sessionID ,licenseStatus ,base ,ibmObject ,objType ,gridViewObject ,formViewObject)

'Returned results
result = ""
licenseStatus = "125"
gridViewObject 'Gridview populated with object details rows
formViewObject 'Formview populated with object details rows

Database

Run SQL queries and retreive data in standard structures (XML, DataTable objects) to integrate DB2 for i databases in any environment. Extract and export data in CSV, TXT and XLSX files.

RunSql Execute an SQL Query

Description

Runs an SQL query on the targeted IBM i.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
sqlQuery string
SQL query to execute

Returns

RunSql() string
Error/success message as string
ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string sqlQuery = "update libtest.tabletest set name = 'foo' where name = 'bar'";

//Function call
result = db2.RunSql(connString ,sessionID ,licenseStatus ,sqlQuery);

//Returned results
result = "";
licenseStatus = "125";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim sqlQuery As String = "update libtest.tabletest set name = 'foo' where name = 'bar'"

'Function call
result = db2.RunSql(connString ,sessionID ,licenseStatus ,sqlQuery)

'Returned results
result = ""
licenseStatus = "125"

RunSqlByTen Execute multiple SQL queries

Description

Runs a sequence of up to 10 SQL queries in a row.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
sqlQuery string
SQL query to run
delimiter string
Delimiter used between queries in sqlQuery parameter

Returns

RunSqlByTen() string
Error/success message as string
ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string sqlQuery = "update libtest.tabletest set name = 'foo' where name = 'bar';update libtest.tabletest set product = 'link2i' where machine = 'ibm i'";
string delimiter = ";";

//Function call
result = db2.RunSqlByTen(connString ,sessionID ,licenseStatus ,sqlQuery ,delimiter);

//Returned results
result = "";
licenseStatus = "125";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim sqlQuery As String = "update libtest.tabletest set name = 'foo' where name = 'bar';update libtest.tabletest set product = 'link2i' where machine = 'ibm i'"
Dim delimiter As String = ";"

'Function call
result = db2.RunSqlByTen(connString ,sessionID ,licenseStatus ,sqlQuery ,delimiter)

'Returned results
result = ""
licenseStatus = "125"

RunSqlScript Execute an SQL Query script

Description

Runs an SQL script. The script can either be composed of SQL queries and CL commands. CL coommands must be prefixed by 'CX:' or 'CL:'.
When using CX prefix, the script doesn't stop and resumes on error.
When using CL prefix, the script is interrupted on error.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
sqlScript string
SQL script to execute
delimiter string
Delimiter used between instructions in sqlScript parameter

Returns

RunSqlScript() string
Messages returned at each step of the script as String
Error message on failure as String
ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string sqlScript = "CL:CPYF(?);insert into ?. ;CX:DLTF(?)";
string delimiter = ";";

//Function call
result = db2.RunSqlScript(connString ,sessionID ,licenseStatus ,sqlScript ,delimiter);

//Returned results
result = "";
licenseStatus = "125";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim sqlScript As String = "CL:CPYF(?);insert into ?. ;CX:DLTF(?)"
Dim delimiter As String = ";"

'Function call
result = db2.RunSqlScript(connString ,sessionID ,licenseStatus ,sqlScript ,delimiter)

'Returned results
result = ""
licenseStatus = "125"

CopyToCSV Export in CSV format

Description

Exports the result of an SQL SELECT query (simple/join) in a CSV file.
The maximum size of a file is 1 million records. Multiple files are created when exporting more than 1 million records.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
sqlQuery string
SQL SELECT query to execute
dirPath string
Path of the directory to export files into, uses '\' directories delimiter and ens by '\'
outputFileName string
Name of the resulting csv file

Returns

CopyToCSV() string
Error/success message as string
ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string sqlQuery = "select * from libtest.tabletest";
string dirPath = "c:\csv\";
string outputFileName = "csvfile.csv";

//Function call
result = db2.CopyToCSV(connString ,sessionID ,licenseStatus ,sqlQuery ,dirPath ,outputFileName);

//Returned results
result = "";
licenseStatus = "125";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim sqlQuery As String = "select * from libtest.tabletest"
Dim dirPath As String = "c:\csv\"
Dim outputFileName As String = "csvfile.csv"

'Function call
result = db2.CopyToCSV(connString ,sessionID ,licenseStatus ,sqlQuery ,dirPath ,outputFileName)

'Returned results
result = ""
licenseStatus = "125"

CopyToTXT Export in text files

Description

Exports the result of an SQL SELECT query (simple/join) in a TXT file, keeps IBM i original tabulations for a clear & quick overview of data.
The maximum size of a file is 1 million records. Multiple files are created when exporting more than 1 million records.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
sqlQuery string
SQL SELECT query to execute
dirPath string
Path of the directory to export files into, uses '\' directories delimiter and ens by '\'
outputFileName string
Name of the resulting txt file

Returns

CopyToTXT() string
Error/success message as string
ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string sqlQuery = "select * from libtest.tabletest";
string dirPath = "c:\txt\";
string outputFileName = "txtfile.txt";

//Function call
result = db2.CopyToTXT(connString ,sessionID ,licenseStatus ,sqlQuery ,dirPath ,outputFileName);

//Returned results
result = "";
licenseStatus = "125";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim sqlQuery As String = "select * from libtest.tabletest"
Dim dirPath As String = "c:\txt\"
Dim outputFileName As String = "txtfile.txt"

'Function call
result = db2.CopyToTXT(connString ,sessionID ,licenseStatus ,sqlQuery ,dirPath ,outputFileName)

'Returned results
result = ""
licenseStatus = "125"

CopyToXLSX Export in Excel format (XLSX)

Description

Exports the result of an SQL SELECT query (simple/join) in an Excel file (XLSX), recommended for up to a few thousands of records.
The maximum size of a file is 1 million records. Multiple files are created when exporting more than 1 million records.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
sqlQuery string
SQL SELECT query to execute
dirPath string
Path of the directory to export files into, uses '\' directories delimiter and ens by '\'
outputFileName string
Name of the resulting xlsx file

Returns

CopyToXLSX() string
Error/success message as string
ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string sqlQuery = "select * from libtest.tabletest";
string dirPath = "c:\xlsx\";
string outputFileName = "xlsxsheet.xslx";

//Function call
result = db2.CopyToXLSX(connString ,sessionID ,licenseStatus ,sqlQuery ,dirPath ,outputFileName);

//Returned results
result = "";
licenseStatus = "125";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim sqlQuery As String = "select * from libtest.tabletest"
Dim dirPath As String = "c:\xlsx\"
Dim outputFileName As String = "xlsxsheet.xslx"

'Function call
result = db2.CopyToXLSX(connString ,sessionID ,licenseStatus ,sqlQuery ,dirPath ,outputFileName)

'Returned results
result = ""
licenseStatus = "125"

GetMassData Getting large volumes of data by an SQL SELECT query

Description

Performs mass data extraction to CSV file. GetMassData retreives detailed description of each fields in the header of the file.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
sqlQuery string
SQL SELECT query (simple/join)
delimiter string
CSV separator
nbrRec integer
Number of records to extract
resultFilePath string
Full path to the result file
chunk integer
Chunking parameter affecting the overall speed of the process. Find more details here

Returns

ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string sqlQuery = "select * from libtest.tabletest";
string delimiter = ";";
int nbrRec = 20000;
string resultFilePath = "c:\extractions\extract.csv";
int chunk = 500;

//Function call
result = db2.GetMassData(connString ,sessionID ,licenseStatus ,sqlQuery ,delimiter ,nbrRec ,resultFilePath ,chunk);

//Returned results

licenseStatus = "125";


'Parameters
Dim db2 As New Link2i
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim sqlQuery As String = "select * from libtest.tabletest"
Dim delimiter As String = ";"
Dim nbrRec As Integer = 20000
Dim resultFilePath As String = "c:\extractions\extract.csv"
Dim chunk As Integer = 500

'Function call
result = db2.GetMassData(connString ,sessionID ,licenseStatus ,sqlQuery ,delimiter ,nbrRec ,resultFilePath ,chunk)

'Returned results

licenseStatus = "125"

PutMassData Send large amounts of data to a single-field staging table for integration into DB2 for i using the CL CPYFRMIMPF command

Description

PutMassData uses a text file with a separator. The text file must have value in the same position and type as the fields in the destination DB2 for i table. The separator must be a non-significant character on the values of the text file. An intermediate table with only one field must first be created in DB2 for i to receive the transferred data

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
txtField string
Name of the single-field on the staging table/file
base string
Database/library containing the staging table/file
table string
Name of staging Table/file
docCsv string
Full path of Text File to send
delimiter string
Delimiter

Returns

ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string txtField = "Name of the single-field on the staging table/file: String (ByVal)";
string base = "Database/library containing the staging table/file: String (ByVal)";
string table = "Name of staging Table/file: String (ByVal)";
string docCsv = "Full path of Text File to send: String (ByVal)";
string delimiter = "Delimiter : String (ByVal)";

//Function call
result = db2.PutMassData(connString ,sessionID ,licenseStatus ,txtField ,base ,table ,docCsv ,delimiter);

//Returned results

licenseStatus = "125";


'Parameters
Dim db2 As New Link2i
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim txtField As String = "Name of the single-field on the staging table/file: String (ByVal)"
Dim base As String = "Database/library containing the staging table/file: String (ByVal)"
Dim table As String = "Name of staging Table/file: String (ByVal)"
Dim docCsv As String = "Full path of Text File to send: String (ByVal)"
Dim delimiter As String = "Delimiter : String (ByVal)"

'Function call
result = db2.PutMassData(connString ,sessionID ,licenseStatus ,txtField ,base ,table ,docCsv ,delimiter)

'Returned results

licenseStatus = "125"

GetFormattedData Retreive field values in TextBox controls

Description

Automatically populates System.Web.TextBox controls with the first record returned by an SQL SELECT query (simple/join). TextBox controls ID's must be identical to fields names.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
keyField string
key(s) field(s) of the file separated by a comma
sqlQuery string
SQL SELECT query (simple/join)
promptPanel System.Web.UI.WebControls.Panel
ASP Panel caontaining textboxes named after fields to retreive

Returns

GetFormattedData() string
Error/success message as string
ref licenseStatus string
ref promptPanel System.Web.UI.WebControls.Panel

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string keyField = "key(s) field(s) of the file separated by a comma : String (ByVal)";
string sqlQuery = "SQL SELECT query (simple/join) : String (ByVal)";
System.Web.UI.WebControls.Panel promptPanel = new System.Web.UI.WebControls.Panel();

//Function call
result = db2.GetFormattedData(connString ,sessionID ,licenseStatus ,keyField ,sqlQuery ,promptPanel);

//Returned results
result = "";
licenseStatus = "125";
promptPanel //ASP Panel caontaining textboxes named after fields to retreive: Optional - System.Web.UI.WebControls.Panel(Optional ByRef);


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim keyField As String = "key(s) field(s) of the file separated by a comma : String (ByVal)"
Dim sqlQuery As String = "SQL SELECT query (simple/join) : String (ByVal)"
Dim promptPanel As New System.Web.UI.WebControls.Panel

'Function call
result = db2.GetFormattedData(connString ,sessionID ,licenseStatus ,keyField ,sqlQuery ,promptPanel)

'Returned results
result = ""
licenseStatus = "125"
promptPanel 'ASP Panel caontaining textboxes named after fields to retreive: Optional - System.Web.UI.WebControls.Panel(Optional ByRef)

GetAllRecords Getting records of a table by an SQL SELECT query

Description

Retreives the result of an SQL SELECT query (simple/join) as a System.Data.DataTable object.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
sqlQuery string
SQL SELECT query (simple/join)
keyField string
Complement to SQL ORDER BY statement. Fields separated by commas, can be followed by ASC or DESC (ex:'Field1 DESC, Field2, Field3 DESC')
nbrRec integer
Number of records to extract
xmlStr string
Returned by ref, raw data formatted in XML
errMessage string
Returned by ref, error/success message

Returns

GetAllRecords() System.Data.DataTable
Records data as System.Data.Datatable object
ref licenseStatus string
ref xmlStr string
ref errMessage string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
System.Data.DataTable result = new System.Data.DataTable();
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string sqlQuery = "SQL SELECT query (simple/join) : String (ByVal)";
string keyField = ""Complement to SQL ORDER BY statement. Fields separated by commas, can be followed by ASC or DESC (ex: ""Field1 DESC, Field2, Field3 DESC"")": String (ByVal)";
int nbrRec = Number of records to extract: Integer(ByVal);
string xmlStr = "";
string errMessage = "";

//Function call
result = db2.GetAllRecords(connString ,sessionID ,licenseStatus ,sqlQuery ,keyField ,nbrRec ,xmlStr ,errMessage);

//Returned results
result; //
licenseStatus = "125";
xmlStr = "Returned by ref, raw data formatted in XML: String (ByRef)";
errMessage = "Returned by ref, error/success message: String (ByRef)";


'Parameters
Dim db2 As New Link2i
Dim result As New System.Data.DataTable
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim sqlQuery As String = "SQL SELECT query (simple/join) : String (ByVal)"
Dim keyField As String = ""Complement to SQL ORDER BY statement. Fields separated by commas, can be followed by ASC or DESC (ex: ""Field1 DESC, Field2, Field3 DESC"")": String (ByVal)"
Dim nbrRec As Integer = Number of records to extract: Integer(ByVal)
Dim xmlStr As String = ""
Dim errMessage As String = ""

'Function call
result = db2.GetAllRecords(connString ,sessionID ,licenseStatus ,sqlQuery ,keyField ,nbrRec ,xmlStr ,errMessage)

'Returned results
result '
licenseStatus = "125"
xmlStr = "Returned by ref, raw data formatted in XML: String (ByRef)"
errMessage = "Returned by ref, error/success message: String (ByRef)"

GetRecord Retreive all fields of a record

Description

Retreives all fields of the first record returned by an SQL SELECT query (simple/join), and the description of the fields (type and size).

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
keyField string
key(s) field(s) of the table separated by a comma
sqlQuery string
SQL SELECT query (simple/join)
data list of string
the « System.Collections.Generic.List (Of String) » type structure which retrieves the data

Returns

ref licenseStatus string
ref data list of string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string keyField = "key(s) field(s) of the table separated by a comma : String (ByVal)";
string sqlQuery = "SQL SELECT query (simple/join) : String (ByVal)";
List<string> data = new List<string>();

//Function call
result = db2.GetRecord(connString ,sessionID ,licenseStatus ,keyField ,sqlQuery ,data);

//Returned results

licenseStatus = "125";
data //the « System.Collections.Generic.List (Of String) » type structure which retrieves the data: List(Of String)(ByRef);


'Parameters
Dim db2 As New Link2i
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim keyField As String = "key(s) field(s) of the table separated by a comma : String (ByVal)"
Dim sqlQuery As String = "SQL SELECT query (simple/join) : String (ByVal)"
Dim data As New List(Of String)

'Function call
result = db2.GetRecord(connString ,sessionID ,licenseStatus ,keyField ,sqlQuery ,data)

'Returned results

licenseStatus = "125"
data 'the « System.Collections.Generic.List (Of String) » type structure which retrieves the data: List(Of String)(ByRef)

GetRecordFields Retreive specific fields of a record

Description

Retreives specified fields of the first record returned by an SQL SELECT query (simple/join).

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
keyField string
key(s) field(s) of the table separated by a comma
sqlQuery string
SQL SELECT query (simple/join)
fieldName string
this parameter contains the name of the field to retrieve
delimiter string
Fields separator
sqlRef string
SQL SELECT reference query if complex SQL SELECT query (sqlQuery parameter)

Returns

GetRecordFields() string
Fields values separated by semiculumns ( ; ) as String
Error message on failure as String
ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string keyField = "key(s) field(s) of the table separated by a comma : String (ByVal)";
string sqlQuery = "SQL SELECT query (simple/join) : String (ByVal)";
string fieldName = "this parameter contains the name of the field to retrieve : String (ByVal)";
string delimiter = "Fields separator";
string sqlRef = "SQL SELECT reference query if complex SQL SELECT query (sqlQuery parameter)";

//Function call
result = db2.GetRecordFields(connString ,sessionID ,licenseStatus ,keyField ,sqlQuery ,fieldName ,delimiter ,sqlRef);

//Returned results
result = "";
licenseStatus = "125";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim keyField As String = "key(s) field(s) of the table separated by a comma : String (ByVal)"
Dim sqlQuery As String = "SQL SELECT query (simple/join) : String (ByVal)"
Dim fieldName As String = "this parameter contains the name of the field to retrieve : String (ByVal)"
Dim delimiter As String = "Fields separator"
Dim sqlRef As String = "SQL SELECT reference query if complex SQL SELECT query (sqlQuery parameter)"

'Function call
result = db2.GetRecordFields(connString ,sessionID ,licenseStatus ,keyField ,sqlQuery ,fieldName ,delimiter ,sqlRef)

'Returned results
result = ""
licenseStatus = "125"

GetRecordCount Number of records obtained by an SQL SELECT query

Description

Counts records in the result of an SQL SELECT query (simple/join)

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
sqlQuery string
SQL SELECT query from which to count (simple/join)
errMessage string
Returned by ref, error/success message

Returns

GetRecordCount() integer
Number of records as Integer
ref licenseStatus string
ref errMessage string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
int result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string sqlQuery = "SQL SELECT query from which to count (simple/join): String (ByVal)";
string errMessage = "";

//Function call
result = db2.GetRecordCount(connString ,sessionID ,licenseStatus ,sqlQuery ,errMessage);

//Returned results
result = "";
licenseStatus = "125";
errMessage = "Returned by ref, error/success message: String (ByRef)";


'Parameters
Dim db2 As New Link2i
Dim result As Integer
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim sqlQuery As String = "SQL SELECT query from which to count (simple/join): String (ByVal)"
Dim errMessage As String = ""

'Function call
result = db2.GetRecordCount(connString ,sessionID ,licenseStatus ,sqlQuery ,errMessage)

'Returned results
result = ""
licenseStatus = "125"
errMessage = "Returned by ref, error/success message: String (ByRef)"

Programs

These functions allow you to run existing IBM i programs from .NET environments, perform joint develoment and run ILE modules. You can also retreive, edit and recompile programs using Excel/text files.

RunProgram Running an existing program on IBM i

Description

RunProgram executes a program on the targeted IBM i without parameter.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
library string
Name of the IBM i library/database that contains the program
pgmName string
Name of the IBM i program to launch

Returns

RunProgram() string
Error/success message as string
ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string library = "Name of the IBM i library/database that contains the program : String (ByVal)";
string pgmName = "Name of the IBM i program to launch : String (ByVal)";

//Function call
result = db2.RunProgram(connString ,sessionID ,licenseStatus ,library ,pgmName);

//Returned results
result = "";
licenseStatus = "125";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim library As String = "Name of the IBM i library/database that contains the program : String (ByVal)"
Dim pgmName As String = "Name of the IBM i program to launch : String (ByVal)"

'Function call
result = db2.RunProgram(connString ,sessionID ,licenseStatus ,library ,pgmName)

'Returned results
result = ""
licenseStatus = "125"

RunProgramParam Running an existing program on IBM i with input parameters

Description

RunProgramParam executes a program on the targeted IBM i with input parameters.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
library string
Name of the IBM i library/database that contains the program
pgmName string
Name of the IBM i program to launch
prmList string
List of parameters values (input and output) as a list. More details about passing parameters here
prmLength string
List of parameters sizes (input and output) as a list. More details about passing parameters here
delimiter string
Delimiter used in parameter lists

Returns

RunProgramParam() string
Error/success message as string
ref licenseStatus string
ref prmList string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string library = "Name of the IBM i library/database that contains the program : String (ByVal)";
string pgmName = "Name of the IBM i program to launch : String (ByVal)";
string prmList = "";
string prmLength = ""List of parameters sizes (input and output) as a list. More details about passing parameters here : www.knowledge.aumerial.com : String (ByVal)";
string delimiter = "Delimiter used in parameter lists: String (ByVal)";

//Function call
result = db2.RunProgramParam(connString ,sessionID ,licenseStatus ,library ,pgmName ,prmList ,prmLength ,delimiter);

//Returned results
result = "";
licenseStatus = "125";
prmList = ""List of parameters values (input and output) as a list. More details about passing parameters here : www.knowledge.aumerial.com : String (ByRef)";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim library As String = "Name of the IBM i library/database that contains the program : String (ByVal)"
Dim pgmName As String = "Name of the IBM i program to launch : String (ByVal)"
Dim prmList As String = ""
Dim prmLength As String = ""List of parameters sizes (input and output) as a list. More details about passing parameters here : www.knowledge.aumerial.com : String (ByVal)"
Dim delimiter As String = "Delimiter used in parameter lists: String (ByVal)"

'Function call
result = db2.RunProgramParam(connString ,sessionID ,licenseStatus ,library ,pgmName ,prmList ,prmLength ,delimiter)

'Returned results
result = ""
licenseStatus = "125"
prmList = ""List of parameters values (input and output) as a list. More details about passing parameters here : www.knowledge.aumerial.com : String (ByRef)"

RunProgramParamReturn Running an existing program on IBM i with input and return parameters

Description

RunProgram executes a program on the targeted IBM i with input and returned parameters.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
library string
Name of the IBM i library/database that contains the program
pgmName string
Name of the IBM i program to launch
prmList string
List of parameters values (input and output) as a list. More details about passing parameters here
prmLength string
List of parameters sizes (input and output) as a list. More details about passing parameters here
prmReturned string
Position in prmList of the parameters to be returned. More details about passing parameters here
delimiter string
Delimiter used in parameter lists

Returns

RunProgramParamReturn() string
Error/success message as string
ref licenseStatus string
ref prmList string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string library = "Name of the IBM i library/database that contains the program : String (ByVal)";
string pgmName = "Name of the IBM i program to launch : String (ByVal)";
string prmList = "";
string prmLength = ""List of parameters sizes (input and output) as a list. More details about passing parameters here : www.knowledge.aumerial.com : String (ByVal)";
string prmReturned = ""Position in prmList of the parameters to be returned. More details about passing parameters here : www.knowledge.aumerial.com : String (ByVal)";
string delimiter = "Delimiter used in parameter lists: String (ByVal)";

//Function call
result = db2.RunProgramParamReturn(connString ,sessionID ,licenseStatus ,library ,pgmName ,prmList ,prmLength ,prmReturned ,delimiter);

//Returned results
result = "";
licenseStatus = "125";
prmList = ""List of parameters values (input and output) as a list. More details about passing parameters here : www.knowledge.aumerial.com : String (ByRef)";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim library As String = "Name of the IBM i library/database that contains the program : String (ByVal)"
Dim pgmName As String = "Name of the IBM i program to launch : String (ByVal)"
Dim prmList As String = ""
Dim prmLength As String = ""List of parameters sizes (input and output) as a list. More details about passing parameters here : www.knowledge.aumerial.com : String (ByVal)"
Dim prmReturned As String = ""Position in prmList of the parameters to be returned. More details about passing parameters here : www.knowledge.aumerial.com : String (ByVal)"
Dim delimiter As String = "Delimiter used in parameter lists: String (ByVal)"

'Function call
result = db2.RunProgramParamReturn(connString ,sessionID ,licenseStatus ,library ,pgmName ,prmList ,prmLength ,prmReturned ,delimiter)

'Returned results
result = ""
licenseStatus = "125"
prmList = ""List of parameters values (input and output) as a list. More details about passing parameters here : www.knowledge.aumerial.com : String (ByRef)"

RunModuleILE Running an existing ILE Module on IBM i

Description

RunModuleILE executes ILE modules on the targeted IBM i.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
Library string
Name of the IBM i library/database that contains the temporary program to run ILE module
pgmName string
Name of the IBM i temporary program
modules string
List of ILE modules to run, in Library/Module form (from 1 to 300 modules separated by a space)
currentLibrary string
Currency library to run temporary program
listLibrary string
Additional library referenced to run temporary program

Returns

RunModuleILE() string
Error/success message as string
ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string Library = "Name of the IBM i library/database that contains the temporary program to run ILE module: String (ByVal)";
string pgmName = "Name of the IBM i temporary program : String (ByVal)";
string modules = ""List of ILE modules to run, in "Library/Module" form (from 1 to 300 modules separated by a space)  : String (ByRef)";
string currentLibrary = ""Currency library to run temporary program: String (ByVal)";
string listLibrary = "Additional library referenced to run temporary program: String (ByVal)";

//Function call
result = db2.RunModuleILE(connString ,sessionID ,licenseStatus ,Library ,pgmName ,modules ,currentLibrary ,listLibrary);

//Returned results
result = "";
licenseStatus = "125";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim Library As String = "Name of the IBM i library/database that contains the temporary program to run ILE module: String (ByVal)"
Dim pgmName As String = "Name of the IBM i temporary program : String (ByVal)"
Dim modules As String = ""List of ILE modules to run, in "Library/Module" form (from 1 to 300 modules separated by a space)  : String (ByRef)"
Dim currentLibrary As String = ""Currency library to run temporary program: String (ByVal)"
Dim listLibrary As String = "Additional library referenced to run temporary program: String (ByVal)"

'Function call
result = db2.RunModuleILE(connString ,sessionID ,licenseStatus ,Library ,pgmName ,modules ,currentLibrary ,listLibrary)

'Returned results
result = ""
licenseStatus = "125"

GetSourceXLSX Exporting a source member in an Excel Edit structure

Description

GetSourceXLSX retreives a source file from the targeted IBM i as an XLSX file.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
base string
Database/library whose members are to be listed
srcFile string
Source file whose members are to be listed
member string
Name of the member to export as an xlsx file
dirPath string
Directory path where the source file has to be extracted on the Windows machine (uses '\' and must finish by '\')
outputFileName string
Name of the excel file

Returns

GetSourceXLSX() string
Error/success message as string
ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string base = "Database/library whose members are to be listed : String (ByVal)";
string srcFile = "Source file whose members are to be listed : String (ByVal)";
string member = "Name of the member to export as an xlsx file: String (ByVal)";
string dirPath = ""Directory path where the source file has to be extracted on the Windows machine (uses ""\"" and must finish by ""\"")": String (ByVal)";
string outputFileName = "Name of the excel file: String (ByVal)";

//Function call
result = db2.GetSourceXLSX(connString ,sessionID ,licenseStatus ,base ,srcFile ,member ,dirPath ,outputFileName);

//Returned results
result = "";
licenseStatus = "125";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim base As String = "Database/library whose members are to be listed : String (ByVal)"
Dim srcFile As String = "Source file whose members are to be listed : String (ByVal)"
Dim member As String = "Name of the member to export as an xlsx file: String (ByVal)"
Dim dirPath As String = ""Directory path where the source file has to be extracted on the Windows machine (uses ""\"" and must finish by ""\"")": String (ByVal)"
Dim outputFileName As String = "Name of the excel file: String (ByVal)"

'Function call
result = db2.GetSourceXLSX(connString ,sessionID ,licenseStatus ,base ,srcFile ,member ,dirPath ,outputFileName)

'Returned results
result = ""
licenseStatus = "125"

GetSourceTXT Exporting a source member to a text file

Description

GetSourceTXT retreives a source file from the targeted IBM i as an text file.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
base string
Database/library whose members are to be listed
srcFile string
Source file whose members are to be listed
member string
Name of the member to export as a text file
dirPath string
Directory path where the source file has to be extracted on the Windows machine (uses '\' and must finish by '\')
outputFileName string
Name of the text file

Returns

GetSourceTXT() string
Error/success message as string
ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string base = "Database/library whose members are to be listed : String (ByVal)";
string srcFile = "Source file whose members are to be listed : String (ByVal)";
string member = "Name of the member to export as a text file: String (ByVal)";
string dirPath = ""Directory path where the source file has to be extracted on the Windows machine (uses ""\"" and must finish by ""\"")": String (ByVal)";
string outputFileName = "Name of the text file: String (ByVal)";

//Function call
result = db2.GetSourceTXT(connString ,sessionID ,licenseStatus ,base ,srcFile ,member ,dirPath ,outputFileName);

//Returned results
result = "";
licenseStatus = "125";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim base As String = "Database/library whose members are to be listed : String (ByVal)"
Dim srcFile As String = "Source file whose members are to be listed : String (ByVal)"
Dim member As String = "Name of the member to export as a text file: String (ByVal)"
Dim dirPath As String = ""Directory path where the source file has to be extracted on the Windows machine (uses ""\"" and must finish by ""\"")": String (ByVal)"
Dim outputFileName As String = "Name of the text file: String (ByVal)"

'Function call
result = db2.GetSourceTXT(connString ,sessionID ,licenseStatus ,base ,srcFile ,member ,dirPath ,outputFileName)

'Returned results
result = ""
licenseStatus = "125"

PostSource Post a source member in the targeted IBM i

Description

Copies a source member from an Excel file to specified database/library and file in the targeted IBM i. The excel workbook to apply has to be formatted as GetSourceXLSX result files.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
base string
Library/database where to post the source member
srcFile string
Source file where to post the source member
member string
Name of the new member
memberDescription string
Short description of the new member (max 72 characters)
filePath string
Full path of the Xlsx file of the member to send
srcType string
Type of source (RPG or CLP)

Returns

PostSource() string
Error/success message as string
ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string base = "Name of the database/library for which a source file member is compiled : String (ByVal)";
string srcFile = "Name of the source file for which a source member is compiled : String (ByVal)";
string member = "Name of the source member to compile : String (ByVal)";
string memberDescription = "Type of source to compile (RPG, CBL, CLP etc…) : String (ByVal)";
string filePath = "Name of the destination database/library of the compiled program: String (ByVal)";
string srcType = "Name of the compiled program : String (ByVal)";

//Function call
result = db2.PostSource(connString ,sessionID ,licenseStatus ,base ,srcFile ,member ,memberDescription ,filePath ,srcType);

//Returned results
result = "";
licenseStatus = "125";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim base As String = "Name of the database/library for which a source file member is compiled : String (ByVal)"
Dim srcFile As String = "Name of the source file for which a source member is compiled : String (ByVal)"
Dim member As String = "Name of the source member to compile : String (ByVal)"
Dim memberDescription As String = "Type of source to compile (RPG, CBL, CLP etc…) : String (ByVal)"
Dim filePath As String = "Name of the destination database/library of the compiled program: String (ByVal)"
Dim srcType As String = "Name of the compiled program : String (ByVal)"

'Function call
result = db2.PostSource(connString ,sessionID ,licenseStatus ,base ,srcFile ,member ,memberDescription ,filePath ,srcType)

'Returned results
result = ""
licenseStatus = "125"

CreateProgram Generating an executable (compilation)

Description

CreateProgram compiles a member of the targeted IBM i into a program.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
base string
Type of source to compile (RPG, CBL, CLP etc...)
srcFile string
Name of the source file for which a source member is compiled
member string
Name of the source member to compile
srcType string
Type of source to compile (RPG, CBL, CLP etc...)
destBase string
Name of the destination database/library of the compiled program
pgmName string
Name of the compiled program

Returns

CreateProgram() string
Error/success message as string
ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string base = "Name of the database/library for which a source file member is compiled : String (ByVal)";
string srcFile = "Name of the source file for which a source member is compiled : String (ByVal)";
string member = "Name of the source member to compile : String (ByVal)";
string srcType = "Type of source to compile (RPG, CBL, CLP etc…) : String (ByVal)";
string destBase = "Name of the destination database/library of the compiled program: String (ByVal)";
string pgmName = "Name of the compiled program : String (ByVal)";

//Function call
result = db2.CreateProgram(connString ,sessionID ,licenseStatus ,base ,srcFile ,member ,srcType ,destBase ,pgmName);

//Returned results
result = "";
licenseStatus = "125";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim base As String = "Name of the database/library for which a source file member is compiled : String (ByVal)"
Dim srcFile As String = "Name of the source file for which a source member is compiled : String (ByVal)"
Dim member As String = "Name of the source member to compile : String (ByVal)"
Dim srcType As String = "Type of source to compile (RPG, CBL, CLP etc…) : String (ByVal)"
Dim destBase As String = "Name of the destination database/library of the compiled program: String (ByVal)"
Dim pgmName As String = "Name of the compiled program : String (ByVal)"

'Function call
result = db2.CreateProgram(connString ,sessionID ,licenseStatus ,base ,srcFile ,member ,srcType ,destBase ,pgmName)

'Returned results
result = ""
licenseStatus = "125"

CL commands from .Net

Run CL commands from .NET

RunCLCmd Running an IBM i command

Description

Executes any CL command from .NET

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
cmd string
Command to execute

Returns

RunCLCmd() string
Error/success message as string
ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string cmd = "Command to execute: String (ByVal)";

//Function call
result = db2.RunCLCmd(connString ,sessionID ,licenseStatus ,cmd);

//Returned results
result = "";
licenseStatus = "125";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim cmd As String = "Command to execute: String (ByVal)"

'Function call
result = db2.RunCLCmd(connString ,sessionID ,licenseStatus ,cmd)

'Returned results
result = ""
licenseStatus = "125"

Using Excel

Use Excel as an input-output peripheral to manually create, edit or delete data

XlsxUpdate Creating an EXCEL document for updating data

Description

Exports an Excel workbook that can be used to manually edit records, and posted back for update to the targeted IBM i using XlsxApply function.

Parameters

connString string
Current HTML Session ID or custom session identifier
sessionID string
Returned by ref, status of the LINK2i licence in remaining days
licenseStatus string
SQL SELECT query to execute
sqlQuery string
Complement to SQL ORDER BY statement. Fields separated by commas, can be followed by ASC or DESC (ex:'Field1 DESC, Field2, Field3 DESC')
keyField string
Path of the directory to export files into, uses '\' directories delimiter and ens by '\'
dirPath string
Name of the resulting xlsx file

Returns

XlsxUpdate() string
Error/success message as string
ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "125";
string licenseStatus = "";
string sqlQuery = ""Complement to SQL ORDER BY statement. Fields separated by commas, can be followed by ASC or DESC (ex: ""Field1 DESC, Field2, Field3 DESC"")": String (ByVal)";
string keyField = ""Path of the directory to export files into, uses ""\"" directories delimiter and ens by ""\""": String (ByVal)";
string dirPath = "Name of the resulting xlsx file: String (ByVal)";

//Function call
result = db2.XlsxUpdate(connString ,sessionID ,licenseStatus ,sqlQuery ,keyField ,dirPath);

//Returned results
result = "";
licenseStatus = "SQL SELECT query to execute : String (ByVal)";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "125"
Dim licenseStatus As String = ""
Dim sqlQuery As String = ""Complement to SQL ORDER BY statement. Fields separated by commas, can be followed by ASC or DESC (ex: ""Field1 DESC, Field2, Field3 DESC"")": String (ByVal)"
Dim keyField As String = ""Path of the directory to export files into, uses ""\"" directories delimiter and ens by ""\""": String (ByVal)"
Dim dirPath As String = "Name of the resulting xlsx file: String (ByVal)"

'Function call
result = db2.XlsxUpdate(connString ,sessionID ,licenseStatus ,sqlQuery ,keyField ,dirPath)

'Returned results
result = ""
licenseStatus = "SQL SELECT query to execute : String (ByVal)"

XlsxCreate Creating an EXCEL document for creating data

Description

Exports an Excel workbook that can be used to manually add records, and posted back for update to the targeted IBM i using XlsxApply function.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Returned by ref, status of the LINK2i licence in remaining days
licenseStatus string
SQL SELECT query to execute
sqlQuery string
Complement to SQL ORDER BY statement. Fields separated by commas, can be followed by ASC or DESC (ex:'Field1 DESC, Field2, Field3 DESC')
keyField string
Path of the directory to export files into, uses '\' directories delimiter and ens by '\'
dirPath string
Name of the resulting xlsx file

Returns

XlsxCreate() string
Error/success message as string
ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "125";
string licenseStatus = "";
string sqlQuery = ""Complement to SQL ORDER BY statement. Fields separated by commas, can be followed by ASC or DESC (ex: ""Field1 DESC, Field2, Field3 DESC"")": String (ByVal)";
string keyField = ""Path of the directory to export files into, uses ""\"" directories delimiter and ens by ""\""": String (ByVal)";
string dirPath = "Name of the resulting xlsx file: String (ByVal)";

//Function call
result = db2.XlsxCreate(connString ,sessionID ,licenseStatus ,sqlQuery ,keyField ,dirPath);

//Returned results
result = "";
licenseStatus = "SQL SELECT query to execute : String (ByVal)";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "125"
Dim licenseStatus As String = ""
Dim sqlQuery As String = ""Complement to SQL ORDER BY statement. Fields separated by commas, can be followed by ASC or DESC (ex: ""Field1 DESC, Field2, Field3 DESC"")": String (ByVal)"
Dim keyField As String = ""Path of the directory to export files into, uses ""\"" directories delimiter and ens by ""\""": String (ByVal)"
Dim dirPath As String = "Name of the resulting xlsx file: String (ByVal)"

'Function call
result = db2.XlsxCreate(connString ,sessionID ,licenseStatus ,sqlQuery ,keyField ,dirPath)

'Returned results
result = ""
licenseStatus = "SQL SELECT query to execute : String (ByVal)"

XlsxCreateWithGeneric Creating an EXCEL document for creating data with a generic

Description

Exports an Excel workbook that can be used to manually add records, and posted back for update to the targeted IBM i using XlsxApply function.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
SQL SELECT query to execute
sqlQuery string
Complement to SQL ORDER BY statement. Fields separated by commas, can be followed by ASC or DESC (ex:'Field1 DESC, Field2, Field3 DESC')
keyField string
Path of the directory to export files into, uses '\' directories delimiter and ens by '\'
dirPath string
Name of the resulting xlsx file

Returns

XlsxCreateWithGeneric() string
Error/success message as string
ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string sqlQuery = ""Complement to SQL ORDER BY statement. Fields separated by commas, can be followed by ASC or DESC (ex: ""Field1 DESC, Field2, Field3 DESC"")": String (ByVal)";
string keyField = ""Path of the directory to export files into, uses ""\"" directories delimiter and ens by ""\""": String (ByVal)";
string dirPath = "Name of the resulting xlsx file: String (ByVal)";

//Function call
result = db2.XlsxCreateWithGeneric(connString ,sessionID ,licenseStatus ,sqlQuery ,keyField ,dirPath);

//Returned results
result = "";
licenseStatus = "SQL SELECT query to execute : String (ByVal)";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim sqlQuery As String = ""Complement to SQL ORDER BY statement. Fields separated by commas, can be followed by ASC or DESC (ex: ""Field1 DESC, Field2, Field3 DESC"")": String (ByVal)"
Dim keyField As String = ""Path of the directory to export files into, uses ""\"" directories delimiter and ens by ""\""": String (ByVal)"
Dim dirPath As String = "Name of the resulting xlsx file: String (ByVal)"

'Function call
result = db2.XlsxCreateWithGeneric(connString ,sessionID ,licenseStatus ,sqlQuery ,keyField ,dirPath)

'Returned results
result = ""
licenseStatus = "SQL SELECT query to execute : String (ByVal)"

XlsxDelete Creating an EXCEL document for deleting data

Description

Exports an Excel workbook that can be used to manually delete records and posted back for update to the targeted IBM i using XlsxApply function.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
sqlQuery string
SQL SELECT query to execute
keyField string
Complement to SQL ORDER BY statement. Fields separated by commas, can be followed by ASC or DESC (ex:'Field1 DESC, Field2, Field3 DESC')
dirPath string
Path of the directory to export files into, uses '\' directories delimiter and ens by '\'
outputFileName string
Name of the resulting xlsx file

Returns

XlsxDelete() string
Error/success message as string
ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string sqlQuery = "SQL SELECT query to execute : String (ByVal)";
string keyField = ""Complement to SQL ORDER BY statement. Fields separated by commas, can be followed by ASC or DESC (ex: ""Field1 DESC, Field2, Field3 DESC"")": String (ByVal)";
string dirPath = ""Path of the directory to export files into, uses ""\"" directories delimiter and ens by ""\""": String (ByVal)";
string outputFileName = "Name of the resulting xlsx file: String (ByVal)";

//Function call
result = db2.XlsxDelete(connString ,sessionID ,licenseStatus ,sqlQuery ,keyField ,dirPath ,outputFileName);

//Returned results
result = "";
licenseStatus = "125";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim sqlQuery As String = "SQL SELECT query to execute : String (ByVal)"
Dim keyField As String = ""Complement to SQL ORDER BY statement. Fields separated by commas, can be followed by ASC or DESC (ex: ""Field1 DESC, Field2, Field3 DESC"")": String (ByVal)"
Dim dirPath As String = ""Path of the directory to export files into, uses ""\"" directories delimiter and ens by ""\""": String (ByVal)"
Dim outputFileName As String = "Name of the resulting xlsx file: String (ByVal)"

'Function call
result = db2.XlsxDelete(connString ,sessionID ,licenseStatus ,sqlQuery ,keyField ,dirPath ,outputFileName)

'Returned results
result = ""
licenseStatus = "125"

XlsxApply Applying an EXCEL document to DB2 for i

Description

Applies Excel workbooks generated by XlsxUpdate, XlsxCreate, XlsxCreateWithGeneric and XlsxDelete functions.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
resultFilePath string
Full path of the file to apply, using '\' as directory delimiter

Returns

XlsxApply() string
Error/success message as string
ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string resultFilePath = ""Full path of the file to apply, using ""\"" as directory delimiter": String (ByVal)";

//Function call
result = db2.XlsxApply(connString ,sessionID ,licenseStatus ,resultFilePath);

//Returned results
result = "";
licenseStatus = "125";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim resultFilePath As String = ""Full path of the file to apply, using ""\"" as directory delimiter": String (ByVal)"

'Function call
result = db2.XlsxApply(connString ,sessionID ,licenseStatus ,resultFilePath)

'Returned results
result = ""
licenseStatus = "125"

Utility functions

These functions provide you with an out-of-the-box user interface to work with your data. Display and edit data from an ASP.NET page as you would do on a 5250 screen. Go further and exploit XML data to build your own user interfaces to master your data.

UtilityDisplayGet Composition of a display for displaying

Description

Displays the first record returned by an SQL SELECT Query (simple/join) in an System.Web.Panel control (optional) and as an XML string, to display records only.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
keyField string
key(s) field(s) of the table separated by a comma
sqlQuery string
SQL SELECT query (simple/join)
promptPanel System.Web.UI.WebControls.Panel
Panel used to display utility user interface

Returns

UtilityDisplayGet() string
Data formatted as XML string
Error message on failure as String
Optional - Populates a System.Web.Panel passed ByRef
ref licenseStatus string
ref promptPanel System.Web.UI.WebControls.Panel

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string keyField = "key(s) field(s) of the table separated by a comma : String (ByVal)";
string sqlQuery = "SQL SELECT query (simple/join) : String (ByVal)";
System.Web.UI.WebControls.Panel promptPanel = new System.Web.UI.WebControls.Panel();

//Function call
result = db2.UtilityDisplayGet(connString ,sessionID ,licenseStatus ,keyField ,sqlQuery ,promptPanel);

//Returned results
result = "";
licenseStatus = "125";
promptPanel //Panel used to display utility user interface: Optional - System.Web.UI.WebControls.Panel(Optional ByRef);


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim keyField As String = "key(s) field(s) of the table separated by a comma : String (ByVal)"
Dim sqlQuery As String = "SQL SELECT query (simple/join) : String (ByVal)"
Dim promptPanel As New System.Web.UI.WebControls.Panel

'Function call
result = db2.UtilityDisplayGet(connString ,sessionID ,licenseStatus ,keyField ,sqlQuery ,promptPanel)

'Returned results
result = ""
licenseStatus = "125"
promptPanel 'Panel used to display utility user interface: Optional - System.Web.UI.WebControls.Panel(Optional ByRef)

UtilityUpdateGet Composition of a display for update

Description

Displays the first record returned by an SQL SELECT Query (simple) in an System.Web.Panel control (optional) and as an XML string, to manually edit records only.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
keyField string
key(s) field(s) of the table separated by a comma
sqlQuery string
SQL SELECT query (simple/join)
promptPanel System.Web.UI.WebControls.Panel
Panel used to display utility user interface

Returns

UtilityUpdateGet() string
Data formatted as XML string
Error message on failure as String
Optional - Populates a System.Web.Panel passed ByRef
ref licenseStatus string
ref promptPanel System.Web.UI.WebControls.Panel

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string keyField = "key(s) field(s) of the table separated by a comma : String (ByVal)";
string sqlQuery = "SQL SELECT query (simple/join) : String (ByVal)";
System.Web.UI.WebControls.Panel promptPanel = new System.Web.UI.WebControls.Panel();

//Function call
result = db2.UtilityUpdateGet(connString ,sessionID ,licenseStatus ,keyField ,sqlQuery ,promptPanel);

//Returned results
result = "";
licenseStatus = "125";
promptPanel //Panel used to display utility user interface: Optional - System.Web.UI.WebControls.Panel(Optional ByRef);


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim keyField As String = "key(s) field(s) of the table separated by a comma : String (ByVal)"
Dim sqlQuery As String = "SQL SELECT query (simple/join) : String (ByVal)"
Dim promptPanel As New System.Web.UI.WebControls.Panel

'Function call
result = db2.UtilityUpdateGet(connString ,sessionID ,licenseStatus ,keyField ,sqlQuery ,promptPanel)

'Returned results
result = ""
licenseStatus = "125"
promptPanel 'Panel used to display utility user interface: Optional - System.Web.UI.WebControls.Panel(Optional ByRef)

UtilityCreateGet Composition of a display for create

Description

Displays a blank record formatted according to an SQL SELECT Query (simple) in an System.Web.Panel control (optional) and as an XML string, to manually add records only.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
keyField string
key(s) field(s) of the table separated by a comma
sqlQuery string
SQL SELECT query (simple/join)
promptPanel System.Web.UI.WebControls.Panel
Panel used to display utility user interface

Returns

UtilityCreateGet() string
Data formatted as XML string
Error message on failure as String
Optional - Populates a System.Web.Panel passed ByRef
ref licenseStatus string
ref promptPanel System.Web.UI.WebControls.Panel

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string keyField = "key(s) field(s) of the table separated by a comma : String (ByVal)";
string sqlQuery = "SQL SELECT query (simple/join) : String (ByVal)";
System.Web.UI.WebControls.Panel promptPanel = new System.Web.UI.WebControls.Panel();

//Function call
result = db2.UtilityCreateGet(connString ,sessionID ,licenseStatus ,keyField ,sqlQuery ,promptPanel);

//Returned results
result = "";
licenseStatus = "125";
promptPanel //Panel used to display utility user interface: Optional - System.Web.UI.WebControls.Panel (Optional ByRef);


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim keyField As String = "key(s) field(s) of the table separated by a comma : String (ByVal)"
Dim sqlQuery As String = "SQL SELECT query (simple/join) : String (ByVal)"
Dim promptPanel As New System.Web.UI.WebControls.Panel

'Function call
result = db2.UtilityCreateGet(connString ,sessionID ,licenseStatus ,keyField ,sqlQuery ,promptPanel)

'Returned results
result = ""
licenseStatus = "125"
promptPanel 'Panel used to display utility user interface: Optional - System.Web.UI.WebControls.Panel (Optional ByRef)

UtilityDeleteGet Composition of a display for delete

Description

Displays the first record returned by an SQL SELECT Query (simple) in an System.Web.Panel control, to manually delete records only.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
keyField string
key(s) field(s) of the table separated by a comma
sqlQuery string
SQL SELECT query (simple/join)
promptPanel System.Web.UI.WebControls.Panel
Panel used to display utility user interface

Returns

UtilityDeleteGet() string
Data formatted as XML string
Error message on failure as String
Optional - Populates a System.Web.Panel passed ByRef
ref licenseStatus string
ref promptPanel System.Web.UI.WebControls.Panel

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string keyField = "key(s) field(s) of the table separated by a comma : String (ByVal)";
string sqlQuery = "SQL SELECT query (simple/join) : String (ByVal)";
System.Web.UI.WebControls.Panel promptPanel = new System.Web.UI.WebControls.Panel();

//Function call
result = db2.UtilityDeleteGet(connString ,sessionID ,licenseStatus ,keyField ,sqlQuery ,promptPanel);

//Returned results
result = "";
licenseStatus = "125";
promptPanel //Panel used to display utility user interface: Optional - System.Web.UI.WebControls.Panel(Optional ByRef);


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim keyField As String = "key(s) field(s) of the table separated by a comma : String (ByVal)"
Dim sqlQuery As String = "SQL SELECT query (simple/join) : String (ByVal)"
Dim promptPanel As New System.Web.UI.WebControls.Panel

'Function call
result = db2.UtilityDeleteGet(connString ,sessionID ,licenseStatus ,keyField ,sqlQuery ,promptPanel)

'Returned results
result = ""
licenseStatus = "125"
promptPanel 'Panel used to display utility user interface: Optional - System.Web.UI.WebControls.Panel(Optional ByRef)

UtilityUpdatePost ASP Panel variant Update records from display

Description

Applies user inputs (updated record) from a Sytem.Web.Panel control populated by UtilityUpdateGet function.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
promptPanel System.Web.UI.WebControls.Panel
Panel used to display utility user interface

Returns

UtilityUpdatePost() string
Error message on failure as string
ref licenseStatus string
ref promptPanel System.Web.UI.WebControls.Panel

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
System.Web.UI.WebControls.Panel promptPanel = new System.Web.UI.WebControls.Panel();

//Function call
result = db2.UtilityUpdatePost(connString ,sessionID ,licenseStatus ,promptPanel);

//Returned results
result = "";
licenseStatus = "125";
promptPanel //Panel used to display utility user interface: System.Web.UI.WebControls.Panel(ByRef);


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim promptPanel As New System.Web.UI.WebControls.Panel

'Function call
result = db2.UtilityUpdatePost(connString ,sessionID ,licenseStatus ,promptPanel)

'Returned results
result = ""
licenseStatus = "125"
promptPanel 'Panel used to display utility user interface: System.Web.UI.WebControls.Panel(ByRef)

UtilityUpdatePost XML variant Update records from XML stream

Description

Applies altered XML String (updates a record) originally obtained by UtilityUpdateGet function.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
xmlStr string
XML string returned by UtilityToXML or Utility…GetXML functions

Returns

UtilityUpdatePost() string
Error message on failure as string
ref licenseStatus string
ref xmlStr string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string xmlStr = "";

//Function call
result = db2.UtilityUpdatePost(connString ,sessionID ,licenseStatus ,xmlStr);

//Returned results
result = "";
licenseStatus = "125";
xmlStr = "XML string returned by UtilityToXML or Utility…GetXML functions: String (ByRef)";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim xmlStr As String = ""

'Function call
result = db2.UtilityUpdatePost(connString ,sessionID ,licenseStatus ,xmlStr)

'Returned results
result = ""
licenseStatus = "125"
xmlStr = "XML string returned by UtilityToXML or Utility…GetXML functions: String (ByRef)"

UtilityCreatePost ASP Panel variant Create records from display

Description

Applies user inputs (new record) from a Sytem.Web.Panel control populated by UtilityCreateGet function.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
promptPanel System.Web.UI.WebControls.Panel
Panel used to display utility user interface

Returns

UtilityCreatePost() string
Error message on failure as string
ref licenseStatus string
ref promptPanel System.Web.UI.WebControls.Panel

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
System.Web.UI.WebControls.Panel promptPanel = new System.Web.UI.WebControls.Panel();

//Function call
result = db2.UtilityCreatePost(connString ,sessionID ,licenseStatus ,promptPanel);

//Returned results
result = "";
licenseStatus = "125";
promptPanel //Panel used to display utility user interface: System.Web.UI.WebControls.Panel(ByRef);


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim promptPanel As New System.Web.UI.WebControls.Panel

'Function call
result = db2.UtilityCreatePost(connString ,sessionID ,licenseStatus ,promptPanel)

'Returned results
result = ""
licenseStatus = "125"
promptPanel 'Panel used to display utility user interface: System.Web.UI.WebControls.Panel(ByRef)

UtilityCreatePost XML variant Create records from XML stream

Description

Applies altered XML String (creates a new record) originally obtained by UtilityCreateGet function.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
xmlStr string
XML string returned by UtilityToXML or Utility…GetXML functions

Returns

UtilityCreatePost() string
Error message on failure as string
ref licenseStatus string
ref xmlStr string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string xmlStr = "";

//Function call
result = db2.UtilityCreatePost(connString ,sessionID ,licenseStatus ,xmlStr);

//Returned results
result = "";
licenseStatus = "125";
xmlStr = "XML string returned by UtilityToXML or Utility…GetXML functions: String (ByRef)";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim xmlStr As String = ""

'Function call
result = db2.UtilityCreatePost(connString ,sessionID ,licenseStatus ,xmlStr)

'Returned results
result = ""
licenseStatus = "125"
xmlStr = "XML string returned by UtilityToXML or Utility…GetXML functions: String (ByRef)"

UtilityDeletePost ASP Panel variant Delete records from display

Description

Applies user inputs (deleted records) from a Sytem.Web.Panel control populated by UtilityDeleteGet function.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
promptPanel System.Web.UI.WebControls.Panel
Panel used to display utility user interface

Returns

UtilityDeletePost() string
Error message on failure as string
ref licenseStatus string
ref promptPanel System.Web.UI.WebControls.Panel

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
System.Web.UI.WebControls.Panel promptPanel = new System.Web.UI.WebControls.Panel();

//Function call
result = db2.UtilityDeletePost(connString ,sessionID ,licenseStatus ,promptPanel);

//Returned results
result = "";
licenseStatus = "125";
promptPanel //Panel used to display utility user interface: System.Web.UI.WebControls.Panel(ByRef);


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim promptPanel As New System.Web.UI.WebControls.Panel

'Function call
result = db2.UtilityDeletePost(connString ,sessionID ,licenseStatus ,promptPanel)

'Returned results
result = ""
licenseStatus = "125"
promptPanel 'Panel used to display utility user interface: System.Web.UI.WebControls.Panel(ByRef)

UtilityDeletePost XML variant Delete records from XML stream

Description

Applies altered XML String (deletes selected record) originally obtained by UtilityDeleteGet function.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
xmlStr string
XML string returned by UtilityToXML or Utility…GetXML functions

Returns

UtilityDeletePost() string
Error message on failure as string
ref licenseStatus string
ref xmlStr string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string xmlStr = "";

//Function call
result = db2.UtilityDeletePost(connString ,sessionID ,licenseStatus ,xmlStr);

//Returned results
result = "";
licenseStatus = "125";
xmlStr = "XML string returned by UtilityToXML or Utility…GetXML functions: String (ByRef)";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim xmlStr As String = ""

'Function call
result = db2.UtilityDeletePost(connString ,sessionID ,licenseStatus ,xmlStr)

'Returned results
result = ""
licenseStatus = "125"
xmlStr = "XML string returned by UtilityToXML or Utility…GetXML functions: String (ByRef)"

UtilityCLCmdGet Retrieving IBM i command in XML format

Description

Retreives a CL command builder in a System.Web.Panel control or as an XML string, used to compose a CL command with a 5250-like interface in an ASP.NET web page.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
cmd string
CL command to get a prompt from
nbItems string
Number of items in the command
promptPanel System.Web.UI.WebControls.Panel
Panel used to display utility user interface

Returns

UtilityCLCmdGet() string
Data formatted as XML string
Error message on failure as String
Optional - Populates a System.Web.Panel passed ByRef
ref licenseStatus string
ref cmd string
ref nbItems string
ref promptPanel System.Web.UI.WebControls.Panel

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string cmd = "";
string nbItems = "";
System.Web.UI.WebControls.Panel promptPanel = new System.Web.UI.WebControls.Panel();

//Function call
result = db2.UtilityCLCmdGet(connString ,sessionID ,licenseStatus ,cmd ,nbItems ,promptPanel);

//Returned results
result = "";
licenseStatus = "125";
cmd = "CL command to get a prompt from: String (ByRef)";
nbItems = "Number of items in the command: String (ByRef)";
promptPanel //Panel used to display utility user interface: Optional - System.Web.UI.WebControls.Panel(Optional ByRef);


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim cmd As String = ""
Dim nbItems As String = ""
Dim promptPanel As New System.Web.UI.WebControls.Panel

'Function call
result = db2.UtilityCLCmdGet(connString ,sessionID ,licenseStatus ,cmd ,nbItems ,promptPanel)

'Returned results
result = ""
licenseStatus = "125"
cmd = "CL command to get a prompt from: String (ByRef)"
nbItems = "Number of items in the command: String (ByRef)"
promptPanel 'Panel used to display utility user interface: Optional - System.Web.UI.WebControls.Panel(Optional ByRef)

UtilityCLCmdBuild ASP Panel variant Creating an IBM i command from a formatted prompt using a panel

Description

Generates a valid CL command ready to be executed using RunCLCmd function from a System.Web.Panel control pouplated using UtilityCLCmdGet function and edited by the user.

Parameters

nbItems string
Returned by ref, the number of items composing the command
promptPanel System.Web.UI.WebControls.Panel
Utility panel used to compose the command (populated using UtilityCLCmdGet)

Returns

UtilityCLCmdBuild() string
A CL Command as String
Error message on failure as String
ref nbItems string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string nbItems = "";
System.Web.UI.WebControls.Panel promptPanel = new System.Web.UI.WebControls.Panel();

//Function call
result = db2.UtilityCLCmdBuild(nbItems ,promptPanel);

//Returned results
result = "";
nbItems = "Returned by ref, the number of items composing the command: String (ByRef)";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim nbItems As String = ""
Dim promptPanel As New System.Web.UI.WebControls.Panel

'Function call
result = db2.UtilityCLCmdBuild(nbItems ,promptPanel)

'Returned results
result = ""
nbItems = "Returned by ref, the number of items composing the command: String (ByRef)"

UtilityCLCmdBuild XML variant Creating an IBM i command from a formatted prompt using XML

Description

Generates a valid CL command ready to be executed using RunCLCmd function from an XML string retreived by UtilityCLCmdGet function and edited by the user.

Parameters

xmlStr string
In this case, the character string is not XML formatted.

Returns

UtilityCLCmdBuild() string
A CL Command as String
Error message on failure as String

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string xmlStr = "In this case, the character string is not XML formatted.: String (ByVal)";

//Function call
result = db2.UtilityCLCmdBuild(xmlStr);

//Returned results
result = "";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim xmlStr As String = "In this case, the character string is not XML formatted.: String (ByVal)"

'Function call
result = db2.UtilityCLCmdBuild(xmlStr)

'Returned results
result = ""

Data conversion

A set of utility functions for data conversion (date formats and ASCII/EBCDIC).

ConvertTime Time conversion from IBM i to .NET format

Description

Convert time from IBM i to .NET format.

Parameters

inputStr string
String to translate from DB2 time to .NET time

Returns

ConvertTime() string
Time as String
Error message on failure as String

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string inputStr = "String to translate from DB2 time to .NET time: String (ByVal)";

//Function call
result = db2.ConvertTime(inputStr);

//Returned results
result = "";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim inputStr As String = "String to translate from DB2 time to .NET time: String (ByVal)"

'Function call
result = db2.ConvertTime(inputStr)

'Returned results
result = ""

ConvertDate Date conversion from IBM i to .NET format

Description

Convert date from IBM i to .NET format.

Parameters

inputStr string
String to translate from DB2 date to .NET date

Returns

ConvertDate() string
Date as String
Error message on failure as String

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string inputStr = "String to translate from DB2 date to .NET date: String (ByVal)";

//Function call
result = db2.ConvertDate(inputStr);

//Returned results
result = "";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim inputStr As String = "String to translate from DB2 date to .NET date: String (ByVal)"

'Function call
result = db2.ConvertDate(inputStr)

'Returned results
result = ""

ConvertTimeStamp Timestamp conversion from IBM i to .NET format

Description

Convert timestamp from IBM i to .NET format.

Parameters

inputStr string
String to translate from DB2 timestamp to .NET time

Returns

ConvertTimeStamp() string
TimeStamp as String
Error message on failure as String

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string inputStr = "String to translate from DB2 timestamp to .NET time: String (ByVal)";

//Function call
result = db2.ConvertTimeStamp(inputStr);

//Returned results
result = "";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim inputStr As String = "String to translate from DB2 timestamp to .NET time: String (ByVal)"

'Function call
result = db2.ConvertTimeStamp(inputStr)

'Returned results
result = ""

ConvertEbcdicToAcscii EBCDIC to ASCII conversion (all characters)

Description

Convert EBCDIC string to ASCII

Parameters

inputStr string
String to translate from ASCII to EBCDIC

Returns

ConvertEbcdicToAcscii() string
Converted ASCII String
Error message on failure as String

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string inputStr = "String to translate from ASCII to EBCDIC: String (ByVal)";

//Function call
result = db2.ConvertEbcdicToAcscii(inputStr);

//Returned results
result = "";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim inputStr As String = "String to translate from ASCII to EBCDIC: String (ByVal)"

'Function call
result = db2.ConvertEbcdicToAcscii(inputStr)

'Returned results
result = ""

ConvertEbcdicToAsciiCSV EBCDIC to ASCII conversion (except semicolon )

Description

Convert EBCDIC string to ASCII without altering semicolumns ( ; )

Parameters

inputStr string
CSV string to translate from ASCII to EBCDIC

Returns

ConvertEbcdicToAsciiCSV() string
Converted ASCII String
Error message on failure as String

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string inputStr = "CSV string to translate from ASCII to EBCDIC: String (ByVal)";

//Function call
result = db2.ConvertEbcdicToAsciiCSV(inputStr);

//Returned results
result = "";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim inputStr As String = "CSV string to translate from ASCII to EBCDIC: String (ByVal)"

'Function call
result = db2.ConvertEbcdicToAsciiCSV(inputStr)

'Returned results
result = ""

FTP functions

Send or receive files between .NET and the targeted IBM i using FTP protocol

FtpChr Send and receive non-binary data using FTP

Description

Perform a data transfer in normal format (not binary) between the Windows server and an IBM i server via the FTP protocol.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
base string
Name of the database/library on Power i
filePath string
Directory path on non Power system
direction string
Direction
ftpFile string
File

Returns

FtpChr() string
Error/success message as string
ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string base = "Name of the database/library on Power i: String (ByVal)";
string filePath = "Directory path on non Power system: String (ByVal)";
string direction = "Direction: 'S' to send, 'R' to receive: String (ByVal)";
string ftpFile = "File: the name of the file or a generic to be transferred: String (ByVal)";

//Function call
result = db2.FtpChr(connString ,sessionID ,licenseStatus ,base ,filePath ,direction ,ftpFile);

//Returned results
result = "";
licenseStatus = "125";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim base As String = "Name of the database/library on Power i: String (ByVal)"
Dim filePath As String = "Directory path on non Power system: String (ByVal)"
Dim direction As String = "Direction: 'S' to send, 'R' to receive: String (ByVal)"
Dim ftpFile As String = "File: the name of the file or a generic to be transferred: String (ByVal)"

'Function call
result = db2.FtpChr(connString ,sessionID ,licenseStatus ,base ,filePath ,direction ,ftpFile)

'Returned results
result = ""
licenseStatus = "125"

FtpBin Send and receive binary data using FTP

Description

Perform a data transfer in binary format between the Windows server and an IBM i server via the FTP protocol.

Parameters

connString string
Encrypted connection string (obtained with GetConnectionString function)
sessionID string
Current HTML Session ID or custom session identifier
licenseStatus string
Returned by ref, status of the LINK2i licence in remaining days
base string
Name of the database/library on Power i
filePath string
Directory path on non Power system
direction string
Direction
ftpFile string
File

Returns

FtpBin() string
Error/success message as string
ref licenseStatus string

C#.NET
VB.NET


//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ABCDEFGHIJKLMNOPQRSTUV";
string licenseStatus = "";
string base = "Name of the database/library on Power i: String (ByVal)";
string filePath = "Directory path on non Power system: String (ByVal)";
string direction = "Direction: 'S' to send, 'R' to receive: String (ByVal)";
string ftpFile = "File: the name of the file or a generic to be transferred: String (ByVal)";

//Function call
result = db2.FtpBin(connString ,sessionID ,licenseStatus ,base ,filePath ,direction ,ftpFile);

//Returned results
result = "";
licenseStatus = "125";


'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ABCDEFGHIJKLMNOPQRSTUV"
Dim licenseStatus As String = ""
Dim base As String = "Name of the database/library on Power i: String (ByVal)"
Dim filePath As String = "Directory path on non Power system: String (ByVal)"
Dim direction As String = "Direction: 'S' to send, 'R' to receive: String (ByVal)"
Dim ftpFile As String = "File: the name of the file or a generic to be transferred: String (ByVal)"

'Function call
result = db2.FtpBin(connString ,sessionID ,licenseStatus ,base ,filePath ,direction ,ftpFile)

'Returned results
result = ""
licenseStatus = "125"

2021 AUMERIAL About AUMERIAL Contact Legal notice Privacy policy