Click here to Skip to main content
Click here to Skip to main content

Using EHLLAPI in C#

, 17 Feb 2005 CPOL
Rate this:
Please Sign up or sign in to vote.
This article will explain how to interact with AS/400 applications using the PCSHLL32.DLL library distributed with IBM Client Access emulator.

Using EHLLAPI from C#

EHLLAPI (Extended High Level Language Application Programming Interface) is a standard library to build interfaces to AS400 applications. It's distributed with all major emulation vendors (RUMBA, IBM Client Access, ...), and it's installed automatically as DLL.

This article will explain how to interact with AS/400 applications using the library distributed with IBM Client Access emulator: PCSHLL32.DLL. If you use a different emulation software, you can apply the concepts exposed in this article with some minor modifications.


In a lot of companies, data integration is not so simple because a lot of programs are very old and databases are not well structured. Even if data can be accessed using ODBC drivers, the real problem is the knowledge of data structures and integration: which tables I must change to insert a new product code? Where are all the data of a customer (in which tables)? These and a lot of other questions have a simple answer: ask to users and learn the commands they type on the screen to insert or read information. You translate the problem: it's not important to know the logic to manipulate data, what's important is to know the "video" command the users type.

The interface used to interact with AS/400 is called "screen scraping": it's based on the fact that emulator software use a char interface to interact with AS/400 programs. Using this interface, you can read from and write to emulation screens. This really simple mechanism reveals all its power if inserted in a high level window program.

DLL Exported Function

PCSHLL32.DLL includes just a function named HLLAPI that receives a parameter (function code): by changing the value of this parameter, we can perform all the operations. There are almost one hundred functions available in the DLL and declared as const inside code. In my experience, I used just five of these functions:

  • HA_CONNECT_PS: connect to a client session (every session is identified by an ID: "A", "B", and so on).
  • HA_DISCONNECT_PS: disconnect from a client session.
  • HA_SET_CURSOR: set the cursor in the absolute position (rows * 80 (or 132) + cols).
  • HA_SENDKEY: send a string to a client session.
  • HA_COPY_PS_TO_STR: read from video.
  • HA_WAIT: wait for session deblocking.

To import the DLL function, I used this code:

public class EhllapiFunc
    public static extern UInt32 hllapi(out UInt32 Func, 
      StringBuilder Data, out UInt32 Length, out UInt32 RetC);

This class contains just a static function referrer to the PCSHLL32 function. This function return 0 if all is OK, otherwise it returns an error code (see inside the code). Parameters are declared without statement because they are used in two directions (to send and receive value). Depending on the Func parameter, Data, Length and RetC parameters have different meanings.

Inside Class Code

I created a class named EhllapiWrapper. This class exposes five static methods. The structure of these methods is very simple: initialize parameter, call HLLAPI function exposed by the EhllapiFunc class, and return value:

public static UInt32 Connect(string sessionID) 
 StringBuilder Data = new StringBuilder(4);
 //Data will contain the ID code of Session

 UInt32 rc=0;
 UInt32 f=HA_CONNECT_PS; //function code
 UInt32 l=4; //lenght of data parameter
 return  EhllapiFunc.hllapi(out f, Data, out l, out rc);
 //return error code
public static UInt32 Disconnect(string sessionID) 
 StringBuilder Data = new StringBuilder(4); 
 UInt32 rc=0;
 UInt32 l=4;
return  EhllapiFunc.hllapi(out f, Data, out l, out rc);
public static UInt32 SetCursorPos(int p)
 StringBuilder Data = new StringBuilder(0);
 //no Data parameter is required

 UInt32 rc=(UInt32) p;
 //rc parameter contains the curson position

 UInt32 l=0;
 return EhllapiFunc.hllapi(out f, Data, out l, out rc);
public static UInt32 GetCursorPos(out int p)
 StringBuilder Data = new StringBuilder(0);
 UInt32 rc=0;
 UInt32 l=0; //return position
 UInt32 r = EhllapiFunc.hllapi(out f, Data, out l, out rc);
 p = (int)l;
 return r;
public static UInt32 SendStr(string cmd)
 StringBuilder Data = new StringBuilder(cmd.Length);
 //Data has the length of cmd string

 UInt32 rc=0;
 UInt32 l=(UInt32)cmd.Length;
 //l parameter contain the length of cmd string

 return  EhllapiFunc.hllapi(out f, Data, out l, out rc);

public static UInt32 ReadScreen(int position, int len, out string txt)
 StringBuilder Data = new StringBuilder(3000);
 //Initialization to a MAX char 
 //(> maximum number of char in a screen session)

 UInt32 rc=(UInt32)position;
 //set initial position to start reading from

 UInt32 l=(UInt32)len;
 //set the number of chars that 
 //function will read from position

 UInt32 r = EhllapiFunc.hllapi(out f, Data, out l, out rc);
 txt=Data.ToString(); //result
 return r;
public static UInt32 Wait()
//just wait for execution of a command on session
 StringBuilder Data = new StringBuilder(0);
 UInt32 rc=0;
 UInt32 f=HA_WAIT ;
 UInt32 l=0;
 UInt32 r = EhllapiFunc.hllapi(out f, Data, out l, out rc);
 return r;

Using EhllapiWrapper Class

A typical use of the wrapper class is this one:

  1. Connect to session.
  2. Set cursor position.
  3. Send string.
  4. Read screen.
  5. Disconnect.

Some Notes

Session ID for Client Access emulator is a char where "A" identifies the first session opened, "B" the second one, and so on. You can send a special key to the session using a particular syntax (see the comment section inside Wrapper class code). For example, ENTER corresponds to @E, F1 key to @1, and so on.

Demo Code

Demo code includes a simple form containing five buttons (one for every method). I used a different color to identify functions and parameters. Form has TopMost = true, so it remains visible when you interact with session. So start a Client Access session, specify ID (typically "A" if it's the first session started), and push Connect. A message box is displayed with return code.


This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


About the Author

Luca Bertoncini
Web Developer
Italy Italy
I'm a Delphi programmer since the 1.0 version.
My acual interest concern all modern language and development tools.
I'm a runner (3H:12M) to Pisa Marathon in 2002.

Comments and Discussions

QuestionDo you have delphi wrapper of this? PinmemberMember 331807831-Aug-09 6:28 
GeneralSeagull Emulator Pinmembercaherdavinbhoy4-Mar-09 6:24 
General3270 vs 5250 Problem PinmemberDeadmeat25-Jul-07 8:32 
GeneralVBA EHLLAPI Question Pinmemberfoundryqa9-Jul-07 14:07 
GeneralRe: VBA EHLLAPI Question Pinmemberbertonciniluca10-Jul-07 23:38 
GeneralRe: VBA EHLLAPI Question Pinmemberfoundryqa29-Jul-07 12:57 
QuestionDebug v Release Issue PinmemberGrandizer Coen22-Mar-07 14:04 
AnswerRe: Debug v Release Issue Pinmemberbertonciniluca22-Mar-07 22:45 
QuestionRe: Debug v Release Issue PinmemberGrandizer Coen23-Mar-07 3:29 
QuestionIs there new way to handle mainframe in C#? Pinmemberli_robert15-Mar-07 9:40 
AnswerRe: Is there new way to handle mainframe in C#? PinmemberLuca Bertoncini15-Mar-07 10:07 
GeneralRemote control PinmemberRogerFoxDogs26-Jan-07 14:45 
AnswerRe: Remote control PinmemberLuca Bertoncini26-Jan-07 21:43 
GeneralDllNotFoundException PinmemberSwenni19-Jun-06 7:06 
GeneralRe: DllNotFoundException PinmemberLuca Bertoncini29-Jul-06 8:33 
GeneralRe: DllNotFoundException Pinmembergavin.morris16-Mar-07 1:46 
GeneralRe: DllNotFoundException Pinmemberbertonciniluca16-Mar-07 3:50 
GeneralRe: DllNotFoundException Pinmembergavin.morris16-Mar-07 5:34 
AnswerRe: DllNotFoundException Pinmemberbertonciniluca16-Mar-07 5:45 
GeneralRe: DllNotFoundException Pinmembergavin.morris16-Mar-07 7:34 
GeneralRe: DllNotFoundException Pinmemberbertonciniluca16-Mar-07 11:54 
GeneralRe: DllNotFoundException PinmemberMember 35367588-Oct-14 3:17 
GeneralVery Good Solution PinmemberChris Meech22-Feb-05 4:59 
GeneralRe: Very Good Solution PinmemberLuca Bertoncini22-Feb-05 11:13 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web04 | 2.8.1411023.1 | Last Updated 17 Feb 2005
Article Copyright 2005 by Luca Bertoncini
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid