image/svg+xml AUMERIAL
  • about LINK2i
  • features & specifications
  • pricing
  • about us
  • contact
  • Knowledge Centre
  • LINK2i
    Knowledge Centre
  • Getting started
  • Introduction
    • Specifications
    • Overview
    • Prerequisites
    • Thin client architecture
    • Thick client architecture
    • Hybrid cloud architecture
    • Specific aspects
    • Connection strings
    • License status
    • SessionID parameter
    • SQL with LINK2i
    • Mass extraction chunks
    • Utility functions
    • Enumerations
    • IBM i object types
    • Utility opType
    • Known issues
    • Unobtrusive validation
    • Excel Issues
  • Installation
    • IBM i Side
    • Prerequisites
    • Initial setup
    • License key renewal
    • Uninstallation
    • .NET Side
    • Prerequisites
    • Installation
    • Initial setup
    • License key renewal
    • Uninstallation
  • .NET Framework
    • Overview
    • Introduction
    • Implementation
    • Functions
    • Targeted IBM i information
    • Programs
    • Database
    • Annexes
    • CL commands
    • Data export
    • Using Excel
    • Utility functions
    • FTP
  • .NET Core
    • Overview
    • Introduction
    • Setup
    • Functions
    • Targeted IBM i information
    • Programs
    • Database
    • Annexes
    • CL commands
    • Data export
    • Using Excel
    • Utility functions
  • XML structures
    • Overview
    • Targeted IBM i information
    • Programs
    • Database
    • CL commands
  • Docker
    • Overview
    • Introduction
    • Implementation
  •  Code snippets on GitHub

.NET Framework Functions


All XML streams are described in detail here.
About Link2i
Description

This function retrieves Link2i version level

Parameters
Returns
  • Version() string
    Formatted character string
  • C#.NET
  • VB.NET

//Parameters
Link2i db2 = new Link2i();
string result;

//Function call
result = db2.Version();

//Returned results
result = "LINK2i - V1R0M0 - March 15 2021 - www.aumerial.com/knowledge.aspx";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String

'Function call
result = db2.Version()

'Returned results
result = "LINK2i - V1R0M0 - March 15 2021 - www.aumerial.com/knowledge.aspx"
                                
Create connection strings
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
    IBM i account username
  • password string
    IBM i account password
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...

Description

retrieves licence status

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
Returns
  • AboutLink2iLicense() string
    Formatted message to warn about licence validity expressed in remaining days
  • C#.NET
  • VB.NET

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

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

//Returned results
result = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

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

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

'Returned results
result = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Description

Retrieves targeted IBM i serial number, OS and processor group.

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";

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

//Returned results
result = "V7R4M0 ABC123 - connection OK";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

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

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

'Returned results
result = "V7R4M0 ABC123 - connection OK"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
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
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current LINK2i licence in remaining days.
  • resultList System.Data.DataTable
    Returned by ref, list of databases/libraries 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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
System.Data.DataTable resultList = new System.Data.DataTable();

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

//Returned results
result = "<Databases>...</Databases>";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
resultList; //List of databases/libraries names as a DataTable
                                

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

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

'Returned results
result = "<Databases>...</Databases>"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
resultList 'List of databases/libraries names as a DataTable
                                
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
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 tables/files 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 = "ab4cd89rf2thi47qzfl3641d";
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 = "<Tables>...</Tables>";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
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 = "ab4cd89rf2thi47qzfl3641d"
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 = "<Tables>...</Tables>"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
resultList 'list of tables/files in LIBTEST
                                
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
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 fields 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 = "ab4cd89rf2thi47qzfl3641d";
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 = "<Fields>...</Fields>";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
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 = "ab4cd89rf2thi47qzfl3641d"
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 = "<Fields>...</Fields>"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
recCount = "25"
resultList 'list of LIBTEST.TABLETEST fields
                                
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
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current LINK2i licence in remaining days.
  • base string
    Database/library whose programs are to be listed
  • resultList System.Data.DataTable
    Returned by ref, list of programs 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 = "ab4cd89rf2thi47qzfl3641d";
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 = "<Programs>...</Programs>";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
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 = "ab4cd89rf2thi47qzfl3641d"
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 = "<Programs>...</Programs>"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
resultList 'list of programs in LIBTEST
                                
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
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 sources files 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 = "ab4cd89rf2thi47qzfl3641d";
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 = "<Sources>...</Sources>";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
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 = "ab4cd89rf2thi47qzfl3641d"
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 = "<Sources>...</Sources>"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
resultList 'list of sources in LIBTEST
                                
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
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 members 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 = "ab4cd89rf2thi47qzfl3641d";
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 = "<Members>...</Members>";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
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 = "ab4cd89rf2thi47qzfl3641d"
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 = "<Members>...</Members>"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
resultList 'list of LIBTEST.SOURCETEST members
                                
Description

GetObjectDetails retrieves 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
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 = "ab4cd89rf2thi47qzfl3641d";
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 = "<ObjDet>...</ObjDet>";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
gridViewObject; //ASP GridView control populated with object details rows
formViewObject; //ASP FormView control 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 = "ab4cd89rf2thi47qzfl3641d"
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 = "<ObjDet>...</ObjDet>"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
gridViewObject 'ASP GridView control populated with object details rows
formViewObject 'ASP FormView control populated with object details rows
                                
Database

Run SQL queries and retrieves 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.

Description

Runs an SQL query on the targeted IBM i.

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 = "ab4cd89rf2thi47qzfl3641d";
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 = "ASP0001 - Operation sucessful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
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 = "ASP0001 - Operation sucessful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Description

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

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 = "ab4cd89rf2thi47qzfl3641d";
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 = "ASP0001 - Operation sucessful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
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 = "ASP0001 - Operation sucessful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
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
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 = "ab4cd89rf2thi47qzfl3641d";
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 = "ASP0001 - Operation sucessful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
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 = "ASP0001 - Operation sucessful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
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
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 without suffix
  • delimiter string
    CSV separator
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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string sqlQuery = "select * from libtest.tabletest";
string dirPath = "c:\csv\";
string outputFileName = "csvfile.csv";
string delimiter = ";";

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

//Returned results
result = "ASP0001 - Operation sucessful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

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

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

'Returned results
result = "ASP0001 - Operation sucessful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
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
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 without suffix
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 = "ab4cd89rf2thi47qzfl3641d";
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 = "ASP0001 - Operation sucessful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
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 = "ASP0001 - Operation sucessful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
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
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 without suffix
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 = "ab4cd89rf2thi47qzfl3641d";
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 = "ASP0001 - Operation sucessful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
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 = "ASP0001 - Operation sucessful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Description

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

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 with suffix
  • chunk integer
    Chunking parameter affecting the overall speed of the process. Find more details here
Returns
  • GetMassData() 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 = "ab4cd89rf2thi47qzfl3641d";
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
result = "ASP0001 - Operation sucessful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
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
result = "ASP0001 - Operation sucessful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Description

PutMassData uses a CSV file (with a separator). The CSV file must have values and types in the same position than the fields contained in the destination DB2 for i table. The separator must be an insignificant character on the CSV file values. An intermediate table with only one field must first be created in DB2 for i to receive the transferred data.

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 CSV File to send
  • delimiter string
    Delimiter
Returns
  • PutMassData() 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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string txtField = "field01";
string base = "libtest";
string table = "tabletest";
string docCsv = "c:\extractions\extract.csv";
string delimiter = ";";

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

//Returned results
result = "ASP0001 - Operation sucessful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim txtField As String = "field01"
Dim base As String = "libtest"
Dim table As String = "tabletest"
Dim docCsv As String = "c:\extractions\extract.csv"
Dim delimiter As String = ";"

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

'Returned results
result = "ASP0001 - Operation sucessful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
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
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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
    Existing ASP Panel control containing textboxes named identically to the fields to retrieve (using TextBox.Id property)
Returns
  • GetFormattedData() string
    Data as XML String
    Error message on failure as String
    Optional - Populates a panel object passed by ref
  • 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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string keyField = "ID";
string sqlQuery = "select ID, NAME, AGE from LIBTEST.TABLETEST WHERE ID = '41587'";
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 = "<FormattedData>...</FormattedData>";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
promptPanel; //populated ASP Panel control
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim keyField As String = "ID"
Dim sqlQuery As String = "select ID, NAME, AGE from LIBTEST.TABLETEST WHERE ID = '41587'"
Dim promptPanel As New System.Web.UI.WebControls.Panel

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

'Returned results
result = "<FormattedData>...</FormattedData>"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
promptPanel 'populated ASP Panel control
                                
Description

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

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current LINK2i licence in remaining days.
  • 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')
  • sqlQuery string
    SQL SELECT query (simple/join)
  • 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
    Data as DataTable
    and Data as XML string passed by ref
  • 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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string keyField = "ID";
string sqlQuery = "select ID, NAME, AGE from LIBTEST.TABLETEST WHERE age > 18";
int nbrRec = 2500;
string xmlStr = "";
string errMessage = "";

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

//Returned results
result; //
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
xmlStr = "<Data>...</Data>";
errMessage = "ASP0001 - Operation sucessful";
                                

'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 = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim keyField As String = "ID"
Dim sqlQuery As String = "select ID, NAME, AGE from LIBTEST.TABLETEST WHERE age > 18"
Dim nbrRec As Integer = 2500
Dim xmlStr As String = ""
Dim errMessage As String = ""

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

'Returned results
result '
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
xmlStr = "<Data>...</Data>"
errMessage = "ASP0001 - Operation sucessful"
                                
Description

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

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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)
Returns
  • GetRecord() string
    List of string used to retrieve data
  • ref licenseStatus string
  • C#.NET
  • VB.NET

//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string keyField = "NUMART";
string sqlQuery = "SELECT NUMART,DESART,DOMAIN FROM newrmf.tarticle WHERE NUMART='2TS4F07800001A'";

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

//Returned results
result = "NUMART;2TS4F07800001A
DESART;YD.ZZN JUCK 185RC 46/51 33.47QQ
DOMAIN;2
===============================================
SELECT NUMART,DESART,DOMAIN FROM newrmf.tarticle WHERE NUMART='2TS4F07800001A'$§$NUMART$§$NUMART-A-NUMERO_ARTICLE$|$DESART-A-DESIGNATION$|$DOMAIN-A-CODE_DOMAINE$|$
32-0-A-NUMERO_ARTICLE-NUMERO ARTICLE......-0-NUMERO ARTICLE......-NUMART-Y-NUMART$|$64-0-A-DESIGNATION-DESIGNATION.........-0-DESIGNATION.........- - -DESART$|$1-0-A-CODE_DOMAINE-CODE DOMAINE........-0-CODE DOMAINE........- - -DOMAIN$|$
";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim keyField As String = "NUMART"
Dim sqlQuery As String = "SELECT NUMART,DESART,DOMAIN FROM newrmf.tarticle WHERE NUMART='2TS4F07800001A'"

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

'Returned results
result = "NUMART;2TS4F07800001A
DESART;YD.ZZN JUCK 185RC 46/51 33.47QQ
DOMAIN;2
===============================================
SELECT NUMART,DESART,DOMAIN FROM newrmf.tarticle WHERE NUMART='2TS4F07800001A'$§$NUMART$§$NUMART-A-NUMERO_ARTICLE$|$DESART-A-DESIGNATION$|$DOMAIN-A-CODE_DOMAINE$|$
32-0-A-NUMERO_ARTICLE-NUMERO ARTICLE......-0-NUMERO ARTICLE......-NUMART-Y-NUMART$|$64-0-A-DESIGNATION-DESIGNATION.........-0-DESIGNATION.........- - -DESART$|$1-0-A-CODE_DOMAINE-CODE DOMAINE........-0-CODE DOMAINE........- - -DOMAIN$|$
"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Description

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

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 query providing the structure of the result, required in some cases, for instance when using FINAL TABLE statement.
Returns
  • GetRecordFields() string
    Fields values separated by the value of delimiter parameter 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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string keyField = "ID";
string sqlQuery = "select * from FINAL TABLE (insert into LIBTEST.TABLETEST (NAME, AGE) VALUES ('JOHN', 45))";
string fieldName = "ID;NAME;AGE";
string delimiter = ";";
string sqlRef = "select ID, NAME, AGE from LIBTEST.TABLETEST";

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

//Returned results
result = "1258;JOHN;45";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim keyField As String = "ID"
Dim sqlQuery As String = "select * from FINAL TABLE (insert into LIBTEST.TABLETEST (NAME, AGE) VALUES ('JOHN', 45))"
Dim fieldName As String = "ID;NAME;AGE"
Dim delimiter As String = ";"
Dim sqlRef As String = "select ID, NAME, AGE from LIBTEST.TABLETEST"

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

'Returned results
result = "1258;JOHN;45"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Description

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

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string sqlQuery = "select * from LIBTEST.TABLETEST";
string errMessage = "";

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

//Returned results
result = 129000;
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
errMessage = "ASP0001 - Operation successful";
                                

'Parameters
Dim db2 As New Link2i
Dim result As Integer
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim sqlQuery As String = "select * from LIBTEST.TABLETEST"
Dim errMessage As String = ""

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

'Returned results
result = 129000
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
errMessage = "ASP0001 - Operation successful"
                                
Description

Builds data structure from SQL QUERY to insert into a source code and returns a string

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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)
  • nameClass string
    name of the data structure
  • CSharpOrVB string
    asked syntax ("C#" or "VB")
Returns
  • GetDataStructure() string
    Data structure in a string
  • ref licenseStatus string
  • C#.NET
  • VB.NET

//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string keyField = "ID";
string sqlQuery = "select ID, NAME, AGE from LIBTEST.TABLETEST WHERE ID = '1258'";
string nameClass = "CLASS001";
string CSharpOrVB = "C#";

//Function call
result = db2.GetDataStructure(connString, sessionID, licenseStatus, keyField, sqlQuery, nameClass, CSharpOrVB);

//Returned results
result = "Public Class CLASS1
{
    Public String NUMERO_ARTICLE { get; set; }
    Public String CODE_DOMAINE { get; set; }
}
";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim keyField As String = "ID"
Dim sqlQuery As String = "select ID, NAME, AGE from LIBTEST.TABLETEST WHERE ID = '1258'"
Dim nameClass As String = "CLASS001"
Dim CSharpOrVB As String = "C#"

'Function call
result = db2.GetDataStructure(connString, sessionID, licenseStatus, keyField, sqlQuery, nameClass, CSharpOrVB)

'Returned results
result = "Public Class CLASS1
{
    Public String NUMERO_ARTICLE { get; set; }
    Public String CODE_DOMAINE { get; set; }
}
"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Programs

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

Description

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

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string library = "LIBTEST";
string pgmName = "PGMTEST";

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

//Returned results
result = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim library As String = "LIBTEST"
Dim pgmName As String = "PGMTEST"

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

'Returned results
result = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Description

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

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string library = "LIBTEST";
string pgmName = "PGMTEST";
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 = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
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 = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim library As String = "LIBTEST"
Dim pgmName As String = "PGMTEST"
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 = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
prmList = ""List of parameters values (input and output) as a list. More details about passing parameters here : www.knowledge.aumerial.com : String (ByRef)"
                                
Description

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

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string library = "LIBTEST";
string pgmName = "PGMTEST";
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 = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
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 = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim library As String = "LIBTEST"
Dim pgmName As String = "PGMTEST"
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 = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
prmList = ""List of parameters values (input and output) as a list. More details about passing parameters here : www.knowledge.aumerial.com : String (ByRef)"
                                
Description

RunILEModule executes ILE module(s) on the targeted IBM i.

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current LINK2i licence in remaining days.
  • library string
    Name of the IBM i library/database that contains the temporary program to run ILE module(s)
  • pgmName string
    Name of the IBM i temporary program
  • modules string
    List of ILE module(s) to run, in Library/Module form (from 1 to 300 modules separated by a space)
  • currentLib string
    Current library to run temporary program
  • additionalLib string
    Additional libraries (separator '$,$') referenced to run temporary program
Returns
  • RunILEModule() 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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string library = "LIBTEST";
string pgmName = "PGMTEST";
string modules = "MDLILE01 MDLILE02 MDLILE03 ";
string currentLib = "CURLIBTEST";
string additionalLib = "LIBTEST01$,$LIBTEST02";

//Function call
result = db2.RunILEModule(connString, sessionID, licenseStatus, library, pgmName, modules, currentLib, additionalLib);

//Returned results
result = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim library As String = "LIBTEST"
Dim pgmName As String = "PGMTEST"
Dim modules As String = "MDLILE01 MDLILE02 MDLILE03 "
Dim currentLib As String = "CURLIBTEST"
Dim additionalLib As String = "LIBTEST01$,$LIBTEST02"

'Function call
result = db2.RunILEModule(connString, sessionID, licenseStatus, library, pgmName, modules, currentLib, additionalLib)

'Returned results
result = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Description

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

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 without suffix
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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string base = "LIBTEST";
string srcFile = "QDDSSRC";
string member = "FILE001";
string dirPath = "c:\xlsx\";
string outputFileName = "Filetest01";

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

//Returned results
result = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim base As String = "LIBTEST"
Dim srcFile As String = "QDDSSRC"
Dim member As String = "FILE001"
Dim dirPath As String = "c:\xlsx\"
Dim outputFileName As String = "Filetest01"

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

'Returned results
result = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Description

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

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 without sufix
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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string base = "LIBTEST";
string srcFile = "QDDSSRC";
string member = "FILE001";
string dirPath = "c:\txt\";
string outputFileName = "Filetest01";

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

//Returned results
result = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim base As String = "LIBTEST"
Dim srcFile As String = "QDDSSRC"
Dim member As String = "FILE001"
Dim dirPath As String = "c:\txt\"
Dim outputFileName As String = "Filetest01"

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

'Returned results
result = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Description

Copies a source member from an Excel file to the specified database/library and source file in the targeted IBM i. The Excel workbook to be applied must be formatted as a result file of GetSourceXLSX.

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 (with suffix 'xlsx') of the member to send
  • srcType string
    Link2i predefined source type 'TypeSource' (RPG, CLP, PF...)
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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string base = "LIBTEST";
string srcFile = "QDDSSRC";
string member = "FILE001";
string memberDescription = "Customers file";
string filePath = "c:\xlsx\source01.xlsx";
string srcType = "Link2i.TypeSource.PF";

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

//Returned results
result = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim base As String = "LIBTEST"
Dim srcFile As String = "QDDSSRC"
Dim member As String = "FILE001"
Dim memberDescription As String = "Customers file"
Dim filePath As String = "c:\xlsx\source01.xlsx"
Dim srcType As String = "Link2i.TypeSource.PF"

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

'Returned results
result = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Description

CreateObject compiles a member of the targeted IBM i into an executable object.

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current LINK2i licence in remaining days.
  • base string
    Name of the database/library for which a source file member is compiled
  • 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
    Link2i predefined source type 'TypeSource' (RPG, CLP, PF...)
  • destBase string
    Name of the destination database/library of the compiled object
  • objName string
    Name of the compiled object
Returns
  • CreateObject() 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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string base = "LIBTEST";
string srcFile = "QDDSSRC";
string member = "FILE001";
string srcType = "Link2i.TypeSource.PF";
string destBase = "LIBOBJ";
string objName = "OBJ001";

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

//Returned results
result = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim base As String = "LIBTEST"
Dim srcFile As String = "QDDSSRC"
Dim member As String = "FILE001"
Dim srcType As String = "Link2i.TypeSource.PF"
Dim destBase As String = "LIBOBJ"
Dim objName As String = "OBJ001"

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

'Returned results
result = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Description

RunStoredProcedure runs an existing stored procedure on the targeted IBM i.

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current LINK2i licence in remaining days.
  • library string
    Name of the targeted IBM i library/database that contains the stored procedure
  • prcName string
    Name of the IBM i stored procedure to launch
  • absoluteRec integer
    Occurence number to start reading
  • nbrRec integer
    Number of records to read
  • returnCursor string
    Value of returned data of stored procedure called
  • execCommit string
    Value indicating whether a Commit is necessary or not
  • xmlStr string
    Raw data formatted in XML : String (ByRef)
  • errMessage string
    Returned by ref, error/success message
  • prmDataType string
    List of predefined Link2i 'DB2ForiType' data types (_CHAR, _DECIMAL, _INTEGER...) matching the parameters values of prmDataList
  • prmDataList string
    List of parameters (input, output and inoutput) as a string list. For each output or inoutput list item, you must declare an empty value.
  • prmDirection string
    Directions (values 'IN', 'OUT', 'INOUT') matching prmDataList parameters as a list of string.
  • prmReturned string
    List of parameters values returned (OUT, INOUT) as a list of string. When calling the function, the list of string of the prmReturned parameter must have the same number of empty values as prmDataList.
Returns
  • RunStoredProcedure() System.Data.DataTable
    Retrieves the result of a stored procedure as a System.Data.DataTable object and data as XML string passed by ref (if cursor request) and/ or a list of string containing the returned parameters values.
  • ref licenseStatus string
  • ref xmlStr string
  • ref errMessage string
  • ref prmReturned 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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string library = "LIBTEST";
string prcName = "STPROC01";
int absoluteRec = 10;
int nbrRec = 120;
string returnCursor = "Y";
string execCommit = "Y";
string xmlStr = "";
string errMessage = "";
string prmDataType = "{Link2i.DB2ForiType._Char, Link2i.DB2ForiType._Char, Link2i.DB2ForiType._Decimal, Link2i.DB2ForiType._Char}";
string prmDataList = "{"2TRAY31", "ZSZ NOD", "20", " "}";
string prmDirection = "{"IN", "IN", "IN", "OUT"}";
string prmReturned = "";

//Function call
result = db2.RunStoredProcedure(connString, sessionID, licenseStatus, library, prcName, absoluteRec, nbrRec, returnCursor, execCommit, xmlStr, errMessage, prmDataType, prmDataList, prmDirection, prmReturned);

//Returned results
result; //
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
xmlStr = "<DataSet>...</DataSet>";
errMessage = "Returned by ref, error/success message";
prmReturned = "{" ", " ", " ", " "}";
                                

'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 = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim library As String = "LIBTEST"
Dim prcName As String = "STPROC01"
Dim absoluteRec As Integer = 10
Dim nbrRec As Integer = 120
Dim returnCursor As String = "Y"
Dim execCommit As String = "Y"
Dim xmlStr As String = ""
Dim errMessage As String = ""
Dim prmDataType As String = "{Link2i.DB2ForiType._Char, Link2i.DB2ForiType._Char, Link2i.DB2ForiType._Decimal, Link2i.DB2ForiType._Char}"
Dim prmDataList As String = "{"2TRAY31", "ZSZ NOD", "20", " "}"
Dim prmDirection As String = "{"IN", "IN", "IN", "OUT"}"
Dim prmReturned As String = ""

'Function call
result = db2.RunStoredProcedure(connString, sessionID, licenseStatus, library, prcName, absoluteRec, nbrRec, returnCursor, execCommit, xmlStr, errMessage, prmDataType, prmDataList, prmDirection, prmReturned)

'Returned results
result '
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
xmlStr = "<DataSet>...</DataSet>"
errMessage = "Returned by ref, error/success message"
prmReturned = "{" ", " ", " ", " "}"
                                
Description

RunStoredProcedureForNetCore runs an existing stored procedure on the targeted IBM i.

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current LINK2i licence in remaining days.
  • library string
    Name of the targeted IBM i library/database that contains the stored procedure
  • prcName string
    Name of the IBM i stored procedure to launch
  • absoluteRec integer
    Occurence number to start reading
  • nbrRec integer
    Number of records to read
  • returnCursor string
    Value of returned data of stored procedure called
  • execCommit string
    Value indicating whether a Commit is necessary or not
  • prmDataType string
    List of predefined Link2i 'DB2ForiType' data types (_CHAR, _DECIMAL, _INTEGER...) matching the parameters values of prmDataList
  • prmDataList string
    List of parameters (input, output and inoutput) as a string list. For each output or inoutput list item, you must declare an empty value.
  • prmDirection string
    Directions (values 'IN', 'OUT', 'INOUT') matching prmDataList parameters as a list of string.
  • prmReturned string
    List of parameters values returned (OUT, INOUT) as a list of string. When calling the function, the list of string of the prmReturned parameter must have the same number of empty values as prmDataList.
Returns
  • RunStoredProcedureForNetCore() string
    Retrieves the result of a stored procedure as data in an XML string (if cursor request) and/ or a list of string containing the returned parameters values (added at the end of the XML string if existing).
  • ref licenseStatus string
  • ref prmReturned string
  • C#.NET
  • VB.NET

//Parameters
Link2i db2 = new Link2i();
string result;
string connString = "Generated using GetConnectionString function";
string sessionID = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string library = "LIBTEST";
string prcName = "STPROC01";
int absoluteRec = 10;
int nbrRec = 120;
string returnCursor = "Y";
string execCommit = "Y";
string prmDataType = "{Link2i.DB2ForiType._Char, Link2i.DB2ForiType._Char, Link2i.DB2ForiType._Decimal, Link2i.DB2ForiType._Char}";
string prmDataList = "{"2TRAY31", "ZSZ NOD", "20", " "}";
string prmDirection = "{"IN", "IN", "IN", "OUT"}";
string prmReturned = "";

//Function call
result = db2.RunStoredProcedureForNetCore(connString, sessionID, licenseStatus, library, prcName, absoluteRec, nbrRec, returnCursor, execCommit, prmDataType, prmDataList, prmDirection, prmReturned);

//Returned results
result = "";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
prmReturned = "{" ", " ", " ", " "}";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim library As String = "LIBTEST"
Dim prcName As String = "STPROC01"
Dim absoluteRec As Integer = 10
Dim nbrRec As Integer = 120
Dim returnCursor As String = "Y"
Dim execCommit As String = "Y"
Dim prmDataType As String = "{Link2i.DB2ForiType._Char, Link2i.DB2ForiType._Char, Link2i.DB2ForiType._Decimal, Link2i.DB2ForiType._Char}"
Dim prmDataList As String = "{"2TRAY31", "ZSZ NOD", "20", " "}"
Dim prmDirection As String = "{"IN", "IN", "IN", "OUT"}"
Dim prmReturned As String = ""

'Function call
result = db2.RunStoredProcedureForNetCore(connString, sessionID, licenseStatus, library, prcName, absoluteRec, nbrRec, returnCursor, execCommit, prmDataType, prmDataList, prmDirection, prmReturned)

'Returned results
result = ""
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
prmReturned = "{" ", " ", " ", " "}"
                                
CL commands from .Net

Run CL commands from .NET

Description

Executes any CL command from .NET

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string cmd = ""CRTLIB LIB(LIBTEST) TEXT(LIBRARY TEST)"";

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

//Returned results
result = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim cmd As String = ""CRTLIB LIB(LIBTEST) TEXT(LIBRARY TEST)""

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

'Returned results
result = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Using Excel

Use Excel as an input-output peripheral to manually create, edit or delete 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
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current LINK2i licence in remaining days.
  • sqlQuery string
    SQL SELECT query to execute
  • orderByFields 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 ends by '\'
  • outputFileName string
    Name of the resulting xlsx file without suffix
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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string sqlQuery = "select ID, NAME, AGE from LIBTEST.TABLETEST WHERE age > 18";
string orderByFields = "ID, NAME DESC";
string dirPath = "c:\xlsx\";
string outputFileName = "FileXlsx";

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

//Returned results
result = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim sqlQuery As String = "select ID, NAME, AGE from LIBTEST.TABLETEST WHERE age > 18"
Dim orderByFields As String = "ID, NAME DESC"
Dim dirPath As String = "c:\xlsx\"
Dim outputFileName As String = "FileXlsx"

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

'Returned results
result = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Description

Composes an Excel workbook based on an SQL SELECT query that can be used to manually add records, and posted back for addition to the targeted IBM i using XlsxApply function.

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current LINK2i licence in remaining days.
  • sqlQuery string
    SQL SELECT query to execute
  • orderByFields string
    Not necessary in creating mode. 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 ends by '\'
  • outputFileName string
    Name of the resulting xlsx file without suffix
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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string sqlQuery = "select * from LIBTEST.TABLETEST";
string orderByFields = "" "";
string dirPath = "c:\xlsx\";
string outputFileName = "FileXlsx";

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

//Returned results
result = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim sqlQuery As String = "select * from LIBTEST.TABLETEST"
Dim orderByFields As String = "" ""
Dim dirPath As String = "c:\xlsx\"
Dim outputFileName As String = "FileXlsx"

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

'Returned results
result = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Description

Composes an Excel workbook based on an SQL SELECT query with a sample line that can be used to manually add records, and posted back for addition to the targeted IBM i using XlsxApply function.

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current LINK2i licence in remaining days.
  • sqlQuery string
    SQL SELECT query to execute
  • orderByFields string
    Not necessary in creating mode. 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 ends by '\'
  • outputFileName string
    Name of the resulting xlsx file without suffix
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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string sqlQuery = "select * from LIBTEST.TABLETEST";
string orderByFields = "" "";
string dirPath = "c:\xlsx\";
string outputFileName = "FileXlsx";

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

//Returned results
result = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim sqlQuery As String = "select * from LIBTEST.TABLETEST"
Dim orderByFields As String = "" ""
Dim dirPath As String = "c:\xlsx\"
Dim outputFileName As String = "FileXlsx"

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

'Returned results
result = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Description

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

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current LINK2i licence in remaining days.
  • sqlQuery string
    SQL SELECT query to execute
  • orderByFields 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 ends by '\'
  • outputFileName string
    Name of the resulting xlsx file without suffix
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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string sqlQuery = "select ID, NAME, AGE from LIBTEST.TABLETEST WHERE age > 18";
string orderByFields = "ID, NAME DESC";
string dirPath = "c:\xlsx\";
string outputFileName = "FileXlsx";

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

//Returned results
result = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim sqlQuery As String = "select ID, NAME, AGE from LIBTEST.TABLETEST WHERE age > 18"
Dim orderByFields As String = "ID, NAME DESC"
Dim dirPath As String = "c:\xlsx\"
Dim outputFileName As String = "FileXlsx"

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

'Returned results
result = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Description

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

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string resultFilePath = "c:\xlsx\FileXlsx.xlsx";

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

//Returned results
result = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim resultFilePath As String = "c:\xlsx\FileXlsx.xlsx"

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

'Returned results
result = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
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.

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
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current 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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string keyField = "KEYFLD";
string sqlQuery = "select ID, NAME, AGE from LIBTEST.TABLETEST WHERE ID=18";
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 = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
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 = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim keyField As String = "KEYFLD"
Dim sqlQuery As String = "select ID, NAME, AGE from LIBTEST.TABLETEST WHERE ID=18"
Dim promptPanel As New System.Web.UI.WebControls.Panel

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

'Returned results
result = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
promptPanel 'Panel used to display utility user interface: Optional - System.Web.UI.WebControls.Panel(Optional ByRef)
                                
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
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current LINK2i licence in remaining days.
  • keyField string
    key(s) field(s) of the table separated by a comma
  • sqlQuery string
    SQL SELECT query with WHERE clause required. JOIN queries not allowed.
  • 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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string keyField = "KEYFLD";
string sqlQuery = "select ID, NAME, AGE from LIBTEST.TABLETEST WHERE ID=18";
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 = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
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 = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim keyField As String = "KEYFLD"
Dim sqlQuery As String = "select ID, NAME, AGE from LIBTEST.TABLETEST WHERE ID=18"
Dim promptPanel As New System.Web.UI.WebControls.Panel

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

'Returned results
result = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
promptPanel 'Panel used to display utility user interface: Optional - System.Web.UI.WebControls.Panel(Optional ByRef)
                                
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
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current LINK2i licence in remaining days.
  • keyField string
    key(s) field(s) of the table separated by a comma
  • sqlQuery string
    SQL SELECT query with WHERE clause required. JOIN queries not allowed.
  • 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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string keyField = "KEYFLD";
string sqlQuery = "select ID, NAME, AGE from LIBTEST.TABLETEST WHERE ID=18";
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 = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
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 = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim keyField As String = "KEYFLD"
Dim sqlQuery As String = "select ID, NAME, AGE from LIBTEST.TABLETEST WHERE ID=18"
Dim promptPanel As New System.Web.UI.WebControls.Panel

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

'Returned results
result = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
promptPanel 'Panel used to display utility user interface: Optional - System.Web.UI.WebControls.Panel (Optional ByRef)
                                
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
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current LINK2i licence in remaining days.
  • keyField string
    key(s) field(s) of the table separated by a comma
  • sqlQuery string
    SQL SELECT query with WHERE clause required. JOIN queries not allowed.
  • 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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string keyField = "KEYFLD";
string sqlQuery = "select ID, NAME, AGE from LIBTEST.TABLETEST WHERE ID=18";
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 = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
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 = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim keyField As String = "KEYFLD"
Dim sqlQuery As String = "select ID, NAME, AGE from LIBTEST.TABLETEST WHERE ID=18"
Dim promptPanel As New System.Web.UI.WebControls.Panel

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

'Returned results
result = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
promptPanel 'Panel used to display utility user interface: Optional - System.Web.UI.WebControls.Panel(Optional ByRef)
                                
Description

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

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current LINK2i licence in remaining days.
  • promptPanel System.Web.UI.WebControls.Panel
    Panel used to update utility user interface
Returns
  • UtilityUpdatePost() 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 = "ab4cd89rf2thi47qzfl3641d";
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 = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
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 = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Description

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

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current LINK2i licence in remaining days.
  • xmlStr string
    XML string returned by UtilityUpdateGet function: String (ByRef)
Returns
  • UtilityUpdatePost() 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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string xmlStr = "XML string returned by UtilityUpdateGet function: String (ByRef)";

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

//Returned results
result = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim xmlStr As String = "XML string returned by UtilityUpdateGet function: String (ByRef)"

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

'Returned results
result = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Description

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

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current LINK2i licence in remaining days.
  • promptPanel System.Web.UI.WebControls.Panel
    Panel used to create utility user interface
Returns
  • UtilityCreatePost() 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 = "ab4cd89rf2thi47qzfl3641d";
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 = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
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 = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Description

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

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current LINK2i licence in remaining days.
  • xmlStr string
    XML string returned by UtilityCreateGet function: String (ByRef)
Returns
  • UtilityCreatePost() 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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string xmlStr = "XML string returned by UtilityCreateGet function: String (ByRef)";

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

//Returned results
result = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim xmlStr As String = "XML string returned by UtilityCreateGet function: String (ByRef)"

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

'Returned results
result = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Description

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

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current LINK2i licence in remaining days.
  • promptPanel System.Web.UI.WebControls.Panel
    Panel used to delete utility user interface
Returns
  • UtilityDeletePost() 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 = "ab4cd89rf2thi47qzfl3641d";
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 = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
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 = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Description

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

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current LINK2i licence in remaining days.
  • xmlStr string
    XML string returned by UtilityDeleteGet function: String (ByRef)
Returns
  • UtilityDeletePost() 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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string xmlStr = "XML string returned by UtilityDeleteGet function: String (ByRef)";

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

//Returned results
result = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim xmlStr As String = "XML string returned by UtilityDeleteGet function: String (ByRef)"

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

'Returned results
result = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Description

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

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current LINK2i licence in remaining days.
  • cmd string
    CL command to get a prompt from
  • 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 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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string cmd = "";
System.Web.UI.WebControls.Panel promptPanel = new System.Web.UI.WebControls.Panel();

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

//Returned results
result = "";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
cmd = "CPYF";
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 = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim cmd As String = ""
Dim promptPanel As New System.Web.UI.WebControls.Panel

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

'Returned results
result = ""
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
cmd = "CPYF"
promptPanel 'Panel used to display utility user interface: Optional - System.Web.UI.WebControls.Panel(Optional ByRef)
                                
Description

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

Parameters
  • 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
  • C#.NET
  • VB.NET

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

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

//Returned results
result = "CRTLIB LIB(LIBTEST) TEXT(LIBRARY TEST)";
                                

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

'Function call
result = db2.UtilityCLCmdBuild(promptPanel)

'Returned results
result = "CRTLIB LIB(LIBTEST) TEXT(LIBRARY TEST)"
                                
Description

Generates a valid CL command ready to be executed using RunCLCmd function from a parameters chars string getting using the UtilityCLCmdGet function.

Parameters
  • clParametersStr string
    List of parameters in a chars string used to compose the CL command
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 clParametersStr = "CRTLIB| LIBTEST,*PROD,*LIBCRTAUT,1,*ASP,*SYSVAL,*SYSVAL,Test Library,|LIB,TYPE,AUT,ASP,ASPDEV,CRTAUT,CRTOBJAUD,TEXT,|-,-,-,-,-,-,-,-,|,*PROD,*LIBCRTAUT,1,*ASP,*SYSVAL,*SYSVAL,*BLANK,";

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

//Returned results
result = "CRTLIB LIB(LIBTEST) TEXT(LIBRARY TEST)";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim clParametersStr As String = "CRTLIB| LIBTEST,*PROD,*LIBCRTAUT,1,*ASP,*SYSVAL,*SYSVAL,Test Library,|LIB,TYPE,AUT,ASP,ASPDEV,CRTAUT,CRTOBJAUD,TEXT,|-,-,-,-,-,-,-,-,|,*PROD,*LIBCRTAUT,1,*ASP,*SYSVAL,*SYSVAL,*BLANK,"

'Function call
result = db2.UtilityCLCmdBuild(clParametersStr)

'Returned results
result = "CRTLIB LIB(LIBTEST) TEXT(LIBRARY TEST)"
                                
Data conversion

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

Description

Converts 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 = "17:12:43";

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

//Returned results
result = "17.12.43";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim inputStr As String = "17:12:43"

'Function call
result = db2.ConvertTime(inputStr)

'Returned results
result = "17.12.43"
                                
Description

Converts 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 = "2019-07-15";

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

//Returned results
result = "15/07/2019";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim inputStr As String = "2019-07-15"

'Function call
result = db2.ConvertDate(inputStr)

'Returned results
result = "15/07/2019"
                                
Description

Converts 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 = "2019-07-15 17:12:43";

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

//Returned results
result = "15/07/2019 17.12.43";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim inputStr As String = "2019-07-15 17:12:43"

'Function call
result = db2.ConvertTimeStamp(inputStr)

'Returned results
result = "15/07/2019 17.12.43"
                                
Description

Converts 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 process ;";

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

//Returned results
result = "String © to process";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim inputStr As String = "String © to process ;"

'Function call
result = db2.ConvertEbcdicToAcscii(inputStr)

'Returned results
result = "String © to process"
                                
Description

Converts 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 = "String © to process ;";

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

//Returned results
result = "String © to process ;";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim inputStr As String = "String © to process ;"

'Function call
result = db2.ConvertEbcdicToAsciiCSV(inputStr)

'Returned results
result = "String © to process ;"
                                
FTP functions

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

Description

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

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current LINK2i licence in remaining days.
  • base string
    Name of the database/library on Power i
  • filePath string
    Directory path on Link2i server
  • direction string
    Link2i predefined direction type 'FTPDirection' (ftpReceive, ftpSend)
  • ftpFile string
    File or generic to be transferred
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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string base = "LIBTEST";
string filePath = "c:\ftpdir\";
string direction = "Link2i.FTPDirection.ftpReceive";
string ftpFile = "*.FLIC";

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

//Returned results
result = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim base As String = "LIBTEST"
Dim filePath As String = "c:\ftpdir\"
Dim direction As String = "Link2i.FTPDirection.ftpReceive"
Dim ftpFile As String = "*.FLIC"

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

'Returned results
result = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
Description

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

Parameters
  • connString string
    LINK2i connection string (obtained with GetConnectionString function)
  • sessionID string
    Any 24 characters string. Can be user generated (random) or based on HTTP session id.
  • licenseStatus string
    Returned by ref, status of the current LINK2i licence in remaining days.
  • base string
    Name of the database/library on Power i
  • filePath string
    Directory path on Link2i server
  • direction string
    Link2i predefined direction type 'FTPDirection' (ftpReceive, ftpSend)
  • ftpFile string
    File or generic to be transferred
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 = "ab4cd89rf2thi47qzfl3641d";
string licenseStatus = "";
string base = "LIBTEST";
string filePath = "c:\ftpdir\";
string direction = "Link2i.FTPDirection.ftpSend";
string ftpFile = "*.txt";

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

//Returned results
result = "ASP0001 - Operation successful";
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40";
                                

'Parameters
Dim db2 As New Link2i
Dim result As String
Dim connString As String = "Generated using GetConnectionString function"
Dim sessionID As String = "ab4cd89rf2thi47qzfl3641d"
Dim licenseStatus As String = ""
Dim base As String = "LIBTEST"
Dim filePath As String = "c:\ftpdir\"
Dim direction As String = "Link2i.FTPDirection.ftpSend"
Dim ftpFile As String = "*.txt"

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

'Returned results
result = "ASP0001 - Operation successful"
licenseStatus = "Valid license for 232 days for IBM i Number 78CFF40 - Partition Name S78CFF40"
                                
 2021 AUMERIAL About AUMERIAL Contact Legal notice Privacy policy
In construction
We are migrating our documentation. Some sections & links may be uncomplete/unexact and will be updated soon.
This website uses cookies to ensure you get the best experience on our website
By using our website, you agree to our privacy policy
Legal Notice
  • Company Name: AUMERIAL
  • Legal form: SAS
  • Address:
    12 rue Albert Einstein
    48000 MENDE
    FRANCE
  • Share capital: 1208�
  • Company registry number: 809 900 723
  • VAT number: FR9809900723
  • Email: contact@aumerial.com
  • Phone: +33 (0) 325 746 436
  • Publication director: R�mi ROUILLOT
  • CNIL declaration: 2026526
  • Hosted by AUMERIAL
Privacy Policy
  1. Collecte de l�information
    Nous recueillons des informations lorsque vous vous inscrivez sur notre site, lorsque vous vous connectez � votre compte, faites un achat, participez � un concours, et / ou lorsque vous vous d�connectez. Les informations recueillies incluent votre nom, votre adresse e-mail, num�ro de t�l�phone, et / ou carte de cr�dit.
    En outre, nous recevons et enregistrons automatiquement des informations � partir de votre ordinateur et navigateur, y compris votre adresse IP, vos logiciels et votre mat�riel, et la page que vous demandez.
  2. Utilisation des informations
    Toutes les informations que nous recueillons aupr�s de vous peuvent �tre utilis�es pour :
    • Personnaliser votre exp�rience et r�pondre � vos besoins individuels
    • Fournir un contenu publicitaire personnalis�
    • Am�liorer notre site
    • Am�liorer le service client et vos besoins de prise en charge
    • Vous contacter par e-mail
    • Administrer un concours, une promotion, ou une enqu�te
  3. Confidentialit� du commerce en ligne
    Nous sommes les seuls propri�taires des informations recueillies sur ce site. Vos informations personnelles ne seront pas vendues, �chang�es, transf�r�es, ou donn�es � une autre soci�t� pour n�importe quelle raison, sans votre consentement, en dehors de ce qui est n�cessaire pour r�pondre � une demande et / ou une transaction, comme par exemple pour exp�dier une commande.
  4. Divulgation � des tiers
    Nous ne vendons, n��changeons et ne transf�rons pas vos informations personnelles identifiables � des tiers. Cela ne comprend pas les tierce parties de confiance qui nous aident � exploiter notre site Web ou � mener nos affaires, tant que ces parties conviennent de garder ces informations confidentielles.
    Nous pensons qu�il est n�cessaire de partager des informations afin d�enqu�ter, de pr�venir ou de prendre des mesures concernant des activit�s ill�gales, fraudes pr�sum�es, situations impliquant des menaces potentielles � la s�curit� physique de toute personne, violations de nos conditions d�utilisation, ou quand la loi nous y contraint.
    Les informations non-priv�es, cependant, peuvent �tre fournies � d�autres parties pour le marketing, la publicit�, ou d�autres utilisations.
  5. Protection des informations
    Nous recueillons des informations lorsque vous vous inscrivez sur notre site, lorsque vous vous connectez � votre compte, faites un achat, participez � un concours, et / ou lorsque vous vous d�connectez. Les informations recueillies incluent votre nom, votre adresse e-mail, num�ro de t�l�phone, et / ou carte de cr�dit.
    En outre, nous recevons et enregistrons automatiquement des informations � partir de votre ordinateur et navigateur, y compris votre adresse IP, vos logiciels et votre mat�riel, et la page que vous demandez.
  6. Se d�sabonner
    Nous mettons en �uvre une vari�t� de mesures de s�curit� pour pr�server la s�curit� de vos informations personnelles. Nous utilisons un cryptage � la pointe de la technologie pour prot�ger les informations sensibles transmises en ligne. Nous prot�geons �galement vos informations hors ligne. Seuls les employ�s qui ont besoin d�effectuer un travail sp�cifique (par exemple, la facturation ou le service � la client�le) ont acc�s aux informations personnelles identifiables. Les ordinateurs et serveurs utilis�s pour stocker des informations personnelles identifiables sont conserv�s dans un environnement s�curis�.
    Est-ce que nous utilisons des cookies ?
    Nos cookies am�liorent l�acc�s � notre site et identifient les visiteurs r�guliers. En outre, nos cookies am�liorent l�exp�rience d�utilisateur gr�ce au suivi et au ciblage de ses int�r�ts. Cependant, cette utilisation des cookies n�est en aucune fa�on li�e � des informations personnelles identifiables sur notre site.
  7. Consentement
    Nous recueillons des informations lorsque vous vous inscrivez sur notre site, lorsque vous vous connectez � votre compte, faites un achat, participez � un concours, et / ou lorsque vous vous d�connectez. Les informations recueillies incluent votre nom, votre adresse e-mail, num�ro de t�l�phone, et / ou carte de cr�dit.
    En outre, nous recevons et enregistrons automatiquement des informations � partir de votre ordinateur et navigateur, y compris votre adresse IP, vos logiciels et votre mat�riel, et la page que vous demandez.