Table Of ContentSAP Automation GUI Interfaces
(BC-FES-AIT)
9
E
D
S
E
F
C
B
.
P
L
E
H
Release 4.6C
SAP Automation GUI Interfaces (BC-FES-AIT) SAP AG
Copyright
© Copyright 2001 SAP AG. Alle Rechte vorbehalten.
Weitergabe und Vervielfältigung dieser Publikation oder von Teilen daraus sind, zu welchem
Zweck und in welcher Form
auch immer, ohne die ausdrückliche schriftliche Genehmigung durch SAP AG nicht gestattet. In
dieser Publikation enthaltene Informationen können ohne vorherige Ankündigung geändert
werden.
Die von SAP AG oder deren Vertriebsfirmen angebotenen Software-Produkte können Software-
Komponenten auch anderer Software-Hersteller enthalten.
Microsoft®, WINDOWS®, NT®, EXCEL®, Word®, PowerPoint® und SQL Server® sind eingetragene
Marken der
Microsoft Corporation.
IBM®, DB2®, OS/2®, DB2/6000®, Parallel Sysplex®, MVS/ESA®, RS/6000®, AIX®, S/390®,
AS/400®, OS/390® und OS/400® sind eingetragene Marken der IBM Corporation.
ORACLE® ist eine eingetragene Marke der ORACLE Corporation.
INFORMIX®-OnLine for SAP und Informix® Dynamic ServerTM sind eingetragene Marken der
Informix Software Incorporated.
UNIX®, X/Open®, OSF/1® und Motif® sind eingetragene Marken der Open Group.
HTML, DHTML, XML, XHTML sind Marken oder eingetragene Marken des W3C®, World Wide
Web Consortium,
Massachusetts Institute of Technology.
JAVA® ist eine eingetragene Marke der Sun Microsystems, Inc.
JAVASCRIPT® ist eine eingetragene Marke der Sun Microsystems, Inc., verwendet unter der
Lizenz der von Netscape entwickelten und implementierten Technologie.
SAP, SAP Logo, R/2, RIVA, R/3, ABAP, SAP ArchiveLink, SAP Business Workflow, WebFlow,
SAP EarlyWatch, BAPI, SAPPHIRE, Management Cockpit, mySAP.com Logo und mySAP.com
sind Marken oder eingetragene Marken der SAP AG in Deutschland und vielen anderen Ländern
weltweit. Alle anderen Produkte sind Marken oder eingetragene Marken der jeweiligen Firmen.
2 April 2001
SAP AG SAP Automation GUI Interfaces (BC-FES-AIT)
Symbole
Symbol Bedeutung
Achtung
Beispiel
Hinweis
Empfehlung
Syntax
April 2001 3
SAP Automation GUI Interfaces (BC-FES-AIT) SAP AG
Inhalt
SAP Automation GUI Interfaces (BC-FES-AIT).................................................9
Components of the SAP Automation GUI Interfaces................................................................13
New Features in Release 4.5.......................................................................................................14
New Features in Release 4.6.......................................................................................................17
Restrictions...................................................................................................................................19
GUI Library Restrictions..............................................................................................................20
GUI Component Restrictions......................................................................................................21
Kit Contents..................................................................................................................................22
Files You Need for Working with the GUI Library.....................................................................24
Files You Need when Using the GUI Component.....................................................................25
Files You Need for Using the Code Generator..........................................................................27
Building and Running the Programs..........................................................................................29
The GUI Library.............................................................................................................................30
Architecture..................................................................................................................................31
A Bit of History.............................................................................................................................33
Using the GUI Library..................................................................................................................34
The SAPGUI Screen and the GUI Library................................................................................35
The GUI Library Event Structure (IT_EVENT).....................................................................37
Other GUI Library Structures...............................................................................................38
Working R/3 Transactions and Screens...................................................................................39
Connecting to R/3 Application Server..................................................................................40
Handling Multiple Sessions.............................................................................................41
Disconnecting from R/3..................................................................................................44
Terminating the Connection to R/3.................................................................................45
Using the Event Structure (It_Event)...................................................................................46
Using Menus........................................................................................................................50
Choosing Buttons on Toolbars.............................................................................................51
Windows Virtual Key Values...........................................................................................52
Using Controls.....................................................................................................................53
Using Matchcodes..........................................................................................................54
Selecting a Radio Button................................................................................................55
Handling a Tab Strip Control..........................................................................................56
Handling a Table Control................................................................................................59
Control Hierarchy............................................................................................................63
Specifying Coordinates of Controls................................................................................65
Finding Controls..............................................................................................................66
Callback Functions and Macro Recording...........................................................................67
Listing Screen and Control Information...............................................................................68
Using Screens with ActiveX Controls..................................................................................70
Sample Program: SAMPLE.C...................................................................................................72
GUI Library Reference.................................................................................................................75
Data Structures.........................................................................................................................76
4 April 2001
SAP AG SAP Automation GUI Interfaces (BC-FES-AIT)
IT_EVENT............................................................................................................................77
Eventtype Member of IT_EVENT...................................................................................81
IT_SCREEN.........................................................................................................................85
IT_CTRL..............................................................................................................................88
Control Type (Dlgtype) Values.......................................................................................91
IT_CTRL Flags Values...................................................................................................93
DwStyle Values...............................................................................................................94
IT_PFKEYS..........................................................................................................................95
IT_PFKEY............................................................................................................................96
IT_MENUS...........................................................................................................................98
IT_MENU.............................................................................................................................99
IT_TABLEINFO..................................................................................................................101
Table Control Style Flags.............................................................................................103
IT_TABSTRIPINFO............................................................................................................104
Tab Strip Control Style Flags........................................................................................106
Functions.................................................................................................................................109
It_AbortGetEvent...............................................................................................................110
It_Dup.................................................................................................................................111
It_DupTo............................................................................................................................112
It_FreeConnection.............................................................................................................113
It_FreeEvent.......................................................................................................................114
It_GetEvent........................................................................................................................115
It_GetEventEx....................................................................................................................116
It_GetEventEx Flags.....................................................................................................118
It_GetEventPtr...................................................................................................................120
It_GetTransaction..............................................................................................................121
It_GroupLookup.................................................................................................................122
It_IsGuiRunning.................................................................................................................124
It_ListControls....................................................................................................................125
It_Login..............................................................................................................................126
It_Logoff.............................................................................................................................127
It_NewConnection..............................................................................................................128
Connection Functions Flags.........................................................................................129
It_NewGroupConnection....................................................................................................131
It_NewServerConnection...................................................................................................132
It_PeekEvent......................................................................................................................133
It_PeekTitle........................................................................................................................134
It_RegisterCallback............................................................................................................135
It_SendEvent......................................................................................................................136
It_SendEventEx.................................................................................................................138
It_SendPFKeyID................................................................................................................140
It_SendReturn....................................................................................................................141
It_ServerLookup.................................................................................................................142
It_SetDelSessionHook.......................................................................................................144
It_SetDumpHook................................................................................................................145
April 2001 5
SAP Automation GUI Interfaces (BC-FES-AIT) SAP AG
It_SetNewSessionHook.....................................................................................................146
It_StartSapGui...................................................................................................................147
It_StopSapGui....................................................................................................................148
ItEv_CustomizeTable.........................................................................................................149
ItEv_DumpEvent................................................................................................................150
Finding Controls.................................................................................................................151
Specifying the Control Parameter.................................................................................152
Specifying the Flags Parameter...................................................................................153
ItEv_FindControl................................................................................................................155
ItEv_FindControlEx............................................................................................................156
ItEv_FindControlByPos......................................................................................................157
ItEv_FindPFKeyID.............................................................................................................158
ItEv_GetAccelerator...........................................................................................................159
ItEv_GetControlCode.........................................................................................................160
ItEv_GetControlCount........................................................................................................161
ItEv_GetControlInfo...........................................................................................................162
ItEv_GetControlTooltip.......................................................................................................163
ItEv_GetSessionCount.......................................................................................................164
ItEv_SetCheck...................................................................................................................165
ItEv_SetControlInfo............................................................................................................166
ItEv_SetCurPos.................................................................................................................167
ItEv_SetCurPosByCtrl........................................................................................................168
ItEv_SetMenu.....................................................................................................................169
ItEv_SetMenuID.................................................................................................................170
ItEv_SetMenuKey..............................................................................................................171
ItEv_SetOKCode................................................................................................................172
ItEv_SetPFKey...................................................................................................................173
ItEv_SetPFKeyID...............................................................................................................174
ItEv_SetTableColumnPermutation....................................................................................175
ItEv_SetValue....................................................................................................................176
ItEv_SetWidth....................................................................................................................177
ItEv_SetTabButton.............................................................................................................178
ItEv_SupportFlags.............................................................................................................179
GUI Component: ActiveX/OLE Automation.............................................................................180
GUI Component Objects............................................................................................................181
Connecting to R/3.......................................................................................................................183
Using Multiple Sessions..........................................................................................................184
GUI Component Application Examples...................................................................................187
Spreadsheet Playback from Excel..........................................................................................188
Screen Capture from Visual FoxPro.......................................................................................192
GUI Component Reference........................................................................................................197
SapEvent Object.....................................................................................................................198
SapEvent Properties..........................................................................................................199
SapEvent Methods.............................................................................................................203
Connect.........................................................................................................................204
6 April 2001
SAP AG SAP Automation GUI Interfaces (BC-FES-AIT)
DisplaySapGui..............................................................................................................205
FindByField...................................................................................................................206
FindByValue.................................................................................................................207
FindExtended................................................................................................................208
FindFrom......................................................................................................................209
FindFromExtended.......................................................................................................210
FindKey.........................................................................................................................211
FindMenu......................................................................................................................212
GetEvent.......................................................................................................................213
GetEventAlways...........................................................................................................214
GetEventExtended........................................................................................................215
GetEventFull.................................................................................................................216
GetEventFront..............................................................................................................217
HasEvent......................................................................................................................218
Logoff............................................................................................................................219
Logon............................................................................................................................220
NewGroupConnection..................................................................................................221
NewServerConnection..................................................................................................222
NewServerConnectionEx..............................................................................................223
OpenConnection...........................................................................................................224
Quit...............................................................................................................................225
SendEvent....................................................................................................................226
SendEventAlways.........................................................................................................227
SendEventToFront........................................................................................................228
SendKey.......................................................................................................................229
SendKeyName..............................................................................................................230
SendMenu.....................................................................................................................231
SendMenuName...........................................................................................................232
SendMessageHelp.......................................................................................................233
SendOKHelp.................................................................................................................234
SendScrollColumn........................................................................................................235
SendScrollRow.............................................................................................................236
SendTabButton.............................................................................................................237
SetControlSelected.......................................................................................................238
SetControlValue............................................................................................................239
SetCursorByControl......................................................................................................240
SetKeyByName............................................................................................................241
SetMenuByName..........................................................................................................242
StartGui.........................................................................................................................243
StopGui.........................................................................................................................244
SupportFlags................................................................................................................245
TableEntry.....................................................................................................................246
Transaction...................................................................................................................247
SapEvent Events...............................................................................................................248
OnDelSession...............................................................................................................249
April 2001 7
SAP Automation GUI Interfaces (BC-FES-AIT) SAP AG
OnLogoff.......................................................................................................................250
OnNewEvent.................................................................................................................251
OnNewSession.............................................................................................................252
SapMenus Object Collection...................................................................................................253
SapMenus Properties........................................................................................................254
SapMenus Methods...........................................................................................................255
SapMenu Object.....................................................................................................................256
SapMenu Properties..........................................................................................................257
SapKeys Object Collection......................................................................................................258
SapKeys Properties...........................................................................................................259
SapKeys Methods..............................................................................................................260
SapKey Object........................................................................................................................261
SapKey Properties.............................................................................................................262
SapControls Object Collection................................................................................................263
SapControls Properties......................................................................................................264
SapControls Methods........................................................................................................265
SapControl Object...................................................................................................................266
SapControl Properties........................................................................................................267
SapTableControlInfo Properties...................................................................................270
SapTabStripControlInfo Properties...............................................................................271
Enumerated Types..................................................................................................................272
SapControlType Enumeration............................................................................................273
SapDirection Enumeration.................................................................................................274
SapGetType Enumeration.................................................................................................275
SapGuiFlags Enumeration.................................................................................................276
SapSelectionType Enumeration........................................................................................277
SAP Automation GUI Code Generator (BC-FES-AIT).............................................................278
GUI Code Generator and Related Products.............................................................................279
Recording the SAP Session......................................................................................................280
Starting Session Recording.....................................................................................................281
Opening a Connection............................................................................................................282
Logging On..............................................................................................................................283
Using the Generator GUI........................................................................................................284
SAP GUI and Code Generator Display Differences..........................................................285
Adding a Program Variable................................................................................................286
Creating a New Subroutine................................................................................................287
Inserting a Message Check...............................................................................................288
Controls window.................................................................................................................289
Logging Off..............................................................................................................................290
Adapting the Generated Program.............................................................................................291
Understanding Generated Code.............................................................................................292
Avoiding Menus.......................................................................................................................298
Finding Controls......................................................................................................................299
8 April 2001
SAP AG SAP Automation GUI Interfaces (BC-FES-AIT)
SAP Automation GUI Interfaces (BC-FES-AIT)
SAP Automation GUI Interfaces (BC-FES-AIT)
SAP GUI Interfaces
The R/3 application server sends and receives data to and from its SAPGUI when displaying R/3
application screens to an end user. The SAPGUI process interacts with one or more Front
processes, one for each user session.
The following diagram shows the standard SAPGUI and its Front processes.
R/3 Middle Tier Client
Front
User’s
AApppplliiccaattiioonn SAPGUI Screen
SSeerrvveerr
DDaattaabbaassee
Using the GUI interfaces to R/3, an external program can access the data that is communicated
between the R/3 application server and its SAPGUI as a method of getting data from or into R/3.
As the following diagram illustrates, the GUI interfaces allow an external program to access R/3
screen data by communicating with the R/3 application server and the SAPGUI.
April 2001 9
SAP Automation GUI Interfaces (BC-FES-AIT) SAP AG
SAP Automation GUI Interfaces
R/3 Middle Tier Client
Front
User’s
Screen
AApppplliiccaattiioonn SAPGUI
SSeerrvveerr
Your
Application
GUI Interfaces
DDaattaabbaassee
By using the GUI interfaces an external program can replace the standard SAPGUI with another
user interface, which can be either graphical or non-graphical (for example, it can be voice
driven).
Programming using the GUI interfaces also allows an external program to monitor or record an
end user interaction with SAPGUI screens.
Using the GUI interfaces method requires no knowledge of ABAP programming. It also
eliminates the need to learn the business and transaction logic behind an existing R/3 application
for which the external program is providing an alternative user interface.
However, since R/3 transaction screens may change between R/3 versions, using this method of
integration with R/3 is the most vulnerable to changes.
SAP Automation GUI Interfaces
SAP Automation [Extern] is a suite of products that allow external programs to integrate with R/3.
SAP Automation GUI Interfaces is a set of products that uses the SAP GUI interface (also called
GUI channel).
These products allow desktop and PC programmers to:
(cid:1) Develop another GUI interface for existing R/3 applications
The alternative GUI you develop may better fit your users or it may better satisfy the
application requirements in your company.
(cid:1) Integrate alternative interfaces with R/3
10 April 2001
Description:SAP EarlyWatch, BAPI, SAPPHIRE, Management Cockpit, mySAP.com Logo und mySAP.com sind Marken oder eingetragene Marken der SAP AG in
