09
Sat, Nov
10 New Articles

Visual Basic APIs to Work with Pointers

APIs
Typography
  • Smaller Small Medium Big Bigger
  • Default Helvetica Segoe Georgia Times

If you’re working with the PC Support or Client Access/400 APIs to develop Visual Basic programs, you soon discover that you need to be able to pass and dereference pointers. For example, the data transform APIs, used to convert numeric values from ASCII to AS/400 packed and binary format, require that you supply a pointer as a function argument. Other APIs return a pointer to a value, which you must then dereference into a field that Visual Basic can work with.

Two relatively obscure API functions are provided with PC Support and Client Access. The APIs are EHNDT_GetPtr, to get a pointer to a variable, and EHNDT_MemCopy, to copy a value referenced by a pointer to a memory buffer that Visual Basic can work with. The APIs are not documented in the CA/400 for Windows
3.1 API and Technical Reference (SC41-3531), nor in any of the previous versions of that manual.

However, there are sample Visual Basic function declares and examples of the APIs in the Visual Basic sample programs provided with PCS or CA/400. In the QIWSTOOL folder, package WVBSAMP includes three sample projects. Project RQSAMP.MAK (Remote SQL sample) uses the EHNDT_GetPtr API. Project TFSAMP.MAK (file transfer sample) uses the EHNDT_MemCopy API.

The sample code shown here demonstrates how to use both APIs with the EHNDT_ASCIIToPacked API. The form shown in Figure 1 is used to get an input value that you enter. When you press the Calculate command button, routine cmdCalculate_Click runs. The routine prepares the input value for the API, calls the ASCII to packed conversion API, then displays the number, converted to packed format, in the Output value text box.

The EHNDT_ASCIIToPacked API requires pointers to the source and target strings. Those strings are the second and third parameters of the API. To get the


pointers, use the EHNDT_GetPtr API for both of those parameters. You can see this in the sample code shown in Figure 2, where EHNDT_GetPtr is called for the source and target strings before EHNDT_ASCIIToPacked.

The packed value produced by EHNDT_ASCIIToPacked is available to your program as a pointer. To get the value referenced by the pointer, use the EHNDT_MemCopy API. This is shown immediately after the EHNDT_ASCIIToPacked call. EHNDT_MemCopy copies the specified number of bytes from the memory location pointed to by the pointer, to the buffer specified as the target string.

To run this sample program, first check for the PCSMCPY.DLL in your PCS, CAWIN, or WINDOWSSYSTEM paths. If the DLL is not on your disk, you’ll have to extract it from the WVBSAMP program package. The file is also available on the CA/400 Toolkit CD-ROM (SK2T-2829). You’ll also need the EHNDTW.DLL, which is loaded onto your PC when you load the code for the Windows APIs.

You can either type this code directly into Visual Basic and create a form like this, or download the code from the AS/400 file area on the Midrange Computing BBS. (The number for the BBS is on page 2 of this issue.) You do not need an active router connection to run this program.

Figure 1: Test Form for Pointer APIs

(Note: long lines are indented on the following line, but are entered as one line in the VB editor)
Option Explicit
Declare Function EHNDT_ASCIIToPacked Lib "EHNDTW.DLL" (ByVal hWnd As

Integer, ByVal lpTarget As Long, ByVal lpSource As Long, ByVal
length As Integer, ByVal decimal_position As Integer) As Integer
Declare Sub EHNDT_GetPtr Lib "PCSMCPY.DLL" (lpVariable As Any, lpPtr As Long)
Declare Sub EHNDT_MemCopy Lib "PCSMCPY.DLL" (ByVal lpbSource As Long, ByVal
lpbTarget As String, ByVal uiLength As Integer)
Sub cmdCalculate_Click ()
'Demonstrate call to EHNDT_ASCIIToPacked API.
'Get numeric value as input from from. Use EHNDT_GetPtr
'APIs to prepare for Visual Basic call to EHNDT_ASCIIToPacked.
'Upon return from EHNDT_ASCIIToPacked, show hex value
'of packed number.

Dim APIReturnCode As Integer 'return code
Dim DecPos As Integer 'decimal positions
Dim I As Integer 'loop index
Dim lpSourcePtr As Long 'long pointer to source
Dim lpTargetPtr As Long 'long pointer to target
Dim ParmLength As Long 'parameter length
Dim SourceString As String 'source string (input)

Dim TargetString As String 'target string (output)

'initialize values for EHNDT_ASCIIToPacked API
ParmLength = 5
DecPos = 0
SourceString = Format$(Val(txtInputValue), "0000000000")
TargetString = Space$(ParmLength)
'Get pointers to source and target strings

Visual_Basic_APIs_to_Work_with_Pointers02-00.jpg 450x213


Call EHNDT_GetPtr(ByVal SourceString, lpSourcePtr)
Call EHNDT_GetPtr(ByVal TargetString, lpTargetPtr)
'convert ASCII to packed
APIReturnCode = EHNDT_ASCIIToPacked(hWnd, lpTargetPtr, lpSourcePtr, ParmLength, DecPos)
'copy packed variable, pointed to by pointer returned from
'EHNDT_ASCIIToPacked, to Visual Basic string variable
Call EHNDT_MemCopy(lpTargetPtr, TargetString, ParmLength)
'convert packed return variable to displayable output field
txtOutputValue = ""

For I = 1 To ParmLength
txtOutputValue = txtOutputValue + Format$(Hex$(Asc(Mid$(TargetString, I, 1))), "00")
Next I
End Sub
Sub cmdExit_Click () End
End Sub

Figure 2: Sample Visual Basic Code


BLOG COMMENTS POWERED BY DISQUS

LATEST COMMENTS

Support MC Press Online

$

Book Reviews

Resource Center

  • SB Profound WC 5536 Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application. You can find Part 1 here. In Part 2 of our free Node.js Webinar Series, Brian May teaches you the different tooling options available for writing code, debugging, and using Git for version control. Brian will briefly discuss the different tools available, and demonstrate his preferred setup for Node development on IBM i or any platform. Attend this webinar to learn:

  • SB Profound WP 5539More than ever, there is a demand for IT to deliver innovation. Your IBM i has been an essential part of your business operations for years. However, your organization may struggle to maintain the current system and implement new projects. The thousands of customers we've worked with and surveyed state that expectations regarding the digital footprint and vision of the company are not aligned with the current IT environment.

  • SB HelpSystems ROBOT Generic IBM announced the E1080 servers using the latest Power10 processor in September 2021. The most powerful processor from IBM to date, Power10 is designed to handle the demands of doing business in today’s high-tech atmosphere, including running cloud applications, supporting big data, and managing AI workloads. But what does Power10 mean for your data center? In this recorded webinar, IBMers Dan Sundt and Dylan Boday join IBM Power Champion Tom Huntington for a discussion on why Power10 technology is the right strategic investment if you run IBM i, AIX, or Linux. In this action-packed hour, Tom will share trends from the IBM i and AIX user communities while Dan and Dylan dive into the tech specs for key hardware, including:

  • Magic MarkTRY the one package that solves all your document design and printing challenges on all your platforms. Produce bar code labels, electronic forms, ad hoc reports, and RFID tags – without programming! MarkMagic is the only document design and print solution that combines report writing, WYSIWYG label and forms design, and conditional printing in one integrated product. Make sure your data survives when catastrophe hits. Request your trial now!  Request Now.

  • SB HelpSystems ROBOT GenericForms of ransomware has been around for over 30 years, and with more and more organizations suffering attacks each year, it continues to endure. What has made ransomware such a durable threat and what is the best way to combat it? In order to prevent ransomware, organizations must first understand how it works.

  • SB HelpSystems ROBOT GenericIT security is a top priority for businesses around the world, but most IBM i pros don’t know where to begin—and most cybersecurity experts don’t know IBM i. In this session, Robin Tatam explores the business impact of lax IBM i security, the top vulnerabilities putting IBM i at risk, and the steps you can take to protect your organization. If you’re looking to avoid unexpected downtime or corrupted data, you don’t want to miss this session.

  • SB HelpSystems ROBOT GenericCan you trust all of your users all of the time? A typical end user receives 16 malicious emails each month, but only 17 percent of these phishing campaigns are reported to IT. Once an attack is underway, most organizations won’t discover the breach until six months later. A staggering amount of damage can occur in that time. Despite these risks, 93 percent of organizations are leaving their IBM i systems vulnerable to cybercrime. In this on-demand webinar, IBM i security experts Robin Tatam and Sandi Moore will reveal:

  • FORTRA Disaster protection is vital to every business. Yet, it often consists of patched together procedures that are prone to error. From automatic backups to data encryption to media management, Robot automates the routine (yet often complex) tasks of iSeries backup and recovery, saving you time and money and making the process safer and more reliable. Automate your backups with the Robot Backup and Recovery Solution. Key features include:

  • FORTRAManaging messages on your IBM i can be more than a full-time job if you have to do it manually. Messages need a response and resources must be monitored—often over multiple systems and across platforms. How can you be sure you won’t miss important system events? Automate your message center with the Robot Message Management Solution. Key features include:

  • FORTRAThe thought of printing, distributing, and storing iSeries reports manually may reduce you to tears. Paper and labor costs associated with report generation can spiral out of control. Mountains of paper threaten to swamp your files. Robot automates report bursting, distribution, bundling, and archiving, and offers secure, selective online report viewing. Manage your reports with the Robot Report Management Solution. Key features include:

  • FORTRAFor over 30 years, Robot has been a leader in systems management for IBM i. With batch job creation and scheduling at its core, the Robot Job Scheduling Solution reduces the opportunity for human error and helps you maintain service levels, automating even the biggest, most complex runbooks. Manage your job schedule with the Robot Job Scheduling Solution. Key features include:

  • LANSA Business users want new applications now. Market and regulatory pressures require faster application updates and delivery into production. Your IBM i developers may be approaching retirement, and you see no sure way to fill their positions with experienced developers. In addition, you may be caught between maintaining your existing applications and the uncertainty of moving to something new.

  • LANSAWhen it comes to creating your business applications, there are hundreds of coding platforms and programming languages to choose from. These options range from very complex traditional programming languages to Low-Code platforms where sometimes no traditional coding experience is needed. Download our whitepaper, The Power of Writing Code in a Low-Code Solution, and:

  • LANSASupply Chain is becoming increasingly complex and unpredictable. From raw materials for manufacturing to food supply chains, the journey from source to production to delivery to consumers is marred with inefficiencies, manual processes, shortages, recalls, counterfeits, and scandals. In this webinar, we discuss how:

  • The MC Resource Centers bring you the widest selection of white papers, trial software, and on-demand webcasts for you to choose from. >> Review the list of White Papers, Trial Software or On-Demand Webcast at the MC Press Resource Center. >> Add the items to yru Cart and complet he checkout process and submit

  • Profound Logic Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application.

  • SB Profound WC 5536Join us for this hour-long webcast that will explore:

  • Fortra IT managers hoping to find new IBM i talent are discovering that the pool of experienced RPG programmers and operators or administrators with intimate knowledge of the operating system and the applications that run on it is small. This begs the question: How will you manage the platform that supports such a big part of your business? This guide offers strategies and software suggestions to help you plan IT staffing and resources and smooth the transition after your AS/400 talent retires. Read on to learn: