connect for sap ® - gs-soft€¦ · connect for sap ® v. ... applications as well as receiving...

Connect for SAP ®

Copyright (c) 2000-2016. All rights reserved.

Table of Contents

Connect for SAP ® 1About Connect for SAP® 1

Installation 1

Requirements 2

Installing components 2

Component's description 3

Architecture 4

Overview 4

RFC function architecture 4

Mapping RFC data types 5

Early and late function binding 7

Client application architecture 8

Server application architecture 10

Units 13

gsfSAPxRFCLogin 13

Classes 13

TfrmSAPxRFCLoginGS 13

Variables 13

frmSAPxRFCLoginGS 14

gsSAPxRFCBase 14

Classes 21

ESAPxRFCExceptionGS 21

Functions 21

SAPxRFCLoadLib 21

SAPxRFCUnLoadLib 21

Records, Enums 22

RFC_ATTRIBUTES 22

RFC_ENV 24

RFC_ERROR_INFO_EX 24

RFC_ITMODE 24

RFC_PARAMETER 25

RFC_RC 26

RFC_TABLE 28

RFC_TYPE_ELEMENT 29

RFC_UNICODE_TYPE_ELEMENT 29

RFC_XSTRING 29

SAP_RFC_STATISTIC 30

Connect for SAP ®

iii

Types 31

ITAB_H 31

PBoolean 31

ppRfc_char_t 32

pRFC_ATTRIBUTES 32

pRFC_BCD 32

pRFC_BYTE 32

pRFC_CHAR 32

pRfc_char_t 33

pRFC_DATE 33

pRFC_ENV 33

pRFC_ERROR_INFO_EX 33

pRFC_FLOAT 33

pRFC_INT 34

pRFC_INT1 34

pRFC_INT2 34

pRFC_IUNKNOWN 34

pRFC_NUM 34

pRFC_PARAMETER 35

pRFC_STRING 35

pRFC_STRUCT_TYPE_ID 35

pRFC_TABLE 35

pRFC_TIME 35

pRFC_TYPE_ELEMENT 36

pRFC_UNICODE 36

pRFC_UNICODE_TYPE_ELEMENT 36

pRFC_WCHAR 36

pRFC_WSTRING 36

pRFC_XMLDATA 37

pRFC_XSTRING 37

pSAP_RFC_STATISTIC 37

RFC_ALLOCATE 37

RFC_BCD 37

RFC_BYTE 38

rfc_byte_t 38

RFC_CANCEL_TYPE 38

RFC_CHAR 38

rfc_char_t 39

RFC_DATE 39

RFC_ERROR_GROUP 39

RFC_ERROR_HANDLER 39

RFC_FLOAT 39

Connect for SAP ®

iv

RFC_FUNCTIONNAME 40

RFC_FUNCTIONNAMEArr 40

RFC_HANDLE 40

RFC_INT 40

RFC_INT1 41

RFC_INT2 41

RFC_IUNKNOWN 41

RFC_NUM 41

RFC_ON_CHECK_TID 42

RFC_ON_CHECK_TID_EX 42

RFC_ON_COMMIT 42

RFC_ON_COMMIT_EX 42

RFC_ON_CONFIRM_TID 42

RFC_ON_CONFIRM_TID_EX 43

RFC_ON_ROLLBACK 43

RFC_ON_ROLLBACK_EX 43

RFC_ONCALL 43

RFC_STRING 43

RFC_STRUCT_TYPE_ID 44

RFC_TID 44

RFC_TIDArr 44

RFC_TIME 44

RFC_TYPEHANDLE 44

RFC_UNICODE 45

rfc_unicode_t 45

RFC_WCHAR 45

RFC_WSTRING 45

RFC_XMLDATA 46

RFCTYPE 46

SAP_UTF8 46

TSAPxRFCAbortGS 46

TSAPxRFCAcceptGS 46

TSAPxRFCAllocStringGS 47

TSAPxRfcAllowStartProgram 47

TSAPxRFCCallGS 47

TSAPxRFCCallReceiveGS 47

TSAPxRFCCancelGS 47

TSAPxRFCCloseGS 48

TSAPxRFCConfirmTransIDGS 48

TSAPxRFCConvertBCDToCharGS 48

TSAPxRFCConvertCharToBCDGS 48

TSAPxRFCCreateTransIDGS 48

Connect for SAP ®

v

TSAPxRFCDispatchGS 49

TSAPxRFCEnumGS 49

TSAPxRFCEnvironment_prcGS 49

TSAPxRfcExidToRfcTypeGS 49

TSAPxRFCFreeStringGS 49

TSAPxRFCGetAttributesGS 50

TSAPxRFCGetDataGS 50

TSAPxRFCGetNameGS 50

TSAPxRFCIndirectCallExGS 50

TSAPxRFCInstallFunctionExtGS 51

TSAPxRFCInstallFunctionGS 51

TSAPxRFCInstallStructureGS 51

TSAPxRFCInstallTransactionControl2GS 51

TSAPxRFCInstallTransactionControlGS 51

TSAPxRFCitAppLineGS 52

TSAPxRFCitCpyLineGS 52

TSAPxRFCitCreateGS 52

TSAPxRFCitDeleteGS 52

TSAPxRFCitDelLineGS 52

TSAPxRFCitFillGS 53

TSAPxRFCitFreeGS 53

TSAPxRFCitGetLineGS 53

TSAPxRFCitGupLineGS 53

TSAPxRFCitInsLineGS 53

TSAPxRFCitLengGS 54

TSAPxRFCitPutLineGS 54

TSAPxRFCLastErrorExGS 54

TSAPxRFCListenGS 54

TSAPxRFCOpenExGS 54

TSAPxRFCRaiseGS 55

TSAPxRFCRaiseTablesGS 55

TSAPxRFCReceiveGS 55

TSAPxRFCResizeXStringGS 55

TSAPxRFCSendDataGS 56

TSAPxRFCStatisticGS 56

TSAPxRFCTraceProcGS 56

TSAPxRFCUninstallFunctionGS 56

TSAPxRFCWaitForRequestGS 56

Variables 57

_RFCTYPE_max_value 57

FSAPxRFCDllFileName 57

FSAPxRFCEnableUnload 57

Connect for SAP ®

vi

FSAPxRFChDll 57

FSAPxRFCInitialized 58

FSAPxRFCLibVersion 58

FSAPxRFCLock 58

FSAPxRFCTraceProc 58

itAppLine 59

itCpyLine 59

itCreate 59

itDelete 59

itDelLine 59

itFill 60

itFree 60

itGetLine 60

itGupLine 60

itInsLine 60

itLeng 61

itPutLine 61

RfcAbort 61

RfcAccept 61

RfcAllocString 61

RfcAllowStartProgram 62

RfcCall 62

RfcCallReceive 62

RfcCancel 62

RfcClose 62

RfcConfirmTransID 63

RfcConvertBCDToChar 63

RfcConvertCharToBCD 63

RfcCreateTransID 63

RfcDispatch 63

RfcEnvironment 64

RfcExidToRfcType 64

RfcFreeString 64

RfcGetAttributes 64

RfcGetData 64

RfcGetName 65

RfcIndirectCallEx 65

RfcInstallFunction 65

RfcInstallFunctionExt 65

RfcInstallStructure 65

RfcInstallTransactionControl 66

RfcInstallTransactionControl2 66

Connect for SAP ®

vii

RfcLastErrorEx 66

RfcListen 66

RfcOpenEx 66

RfcRaise 67

RfcRaiseTables 67

RfcReceive 67

RfcResizeXString 67

RfcSendData 67

RfcStatistic 68

RfcUninstallFunction 68

RfcWaitForRequest 68

Constants 68

__RFCTYPE_max_value_v4 68

__RFCTYPE_max_value_v6 69

_RFCTYPE_differ_from_abap 69

_RFCTYPE_illegal_wchar 69

_RFCTYPE_the_last_line_without_colon 69

C_RFC_ERROR_APPLICATION_EXCEPTION 70

C_RFC_ERROR_BUSY 70

C_RFC_ERROR_CANCELLED 70

C_RFC_ERROR_COMMUNICATION 70

C_RFC_ERROR_INTERNAL 70

C_RFC_ERROR_LOGON_FAILURE 71

C_RFC_ERROR_PROGRAM 71

C_RFC_ERROR_PROTOCOL 71

C_RFC_ERROR_RESOURCE 71

C_RFC_ERROR_SYSTEM_FAILURE 71

C_SAPxRFC_V46 72

C_SAPxRFC_V60 72

C_SAPxRFC_V61 72

C_SAPxRFC_V62 72

C_SAPxRFC_V64 73

C_SAPxRFC_V70 73

C_SAPxRFC_V71 73

C_SAPxRFC_V72 73

C_TRFC_CANCEL 74

C_TRFC_INTERNAL_ERROR 74

C_TRFC_OK 74

ITAB_NULL 74

RFC_CANCEL_CLOSE 74

RFC_CANCEL_HARD 75

RFC_CANCEL_SOFT 75

Connect for SAP ®

viii

RFC_CONV_ID_LN 75

RFC_FUNCTIONNAME_LN 75

RFC_HANDLE_NULL 76

RFC_ROLE_Client 76

RFC_ROLE_SERVER 76

RFC_SERVER_EXT 76

RFC_SERVER_EXT_REG 76

RFC_SERVER_R2 77

RFC_SERVER_R3 77

RFC_STRING_MAX_LEN 77

RFC_TID_LN 77

RFC_TRACE_OFF 77

RFC_TRACE_ON 78

RFCTYPE_ABAP4OBJECT 78

RFCTYPE_BCD 78

RFCTYPE_BLOB 78

RFCTYPE_BYTE 79

RFCTYPE_CHAR 79

RFCTYPE_CORBA_OBJECT 79

RFCTYPE_DATE 79

RFCTYPE_DATE_1 80

RFCTYPE_DATE_2 80

RFCTYPE_FLOAT 80

RFCTYPE_INT 80

RFCTYPE_INT1 81

RFCTYPE_INT2 81

RFCTYPE_ITAB 81

RFCTYPE_IUNKNOWN 81

RFCTYPE_NULL 82

RFCTYPE_NUM 82

RFCTYPE_PADDING 82

RFCTYPE_SAPAUTOMATION 82

RFCTYPE_STRING 83

RFCTYPE_STRUCTURE 83

RFCTYPE_STUB 83

RFCTYPE_TIME 83

RFCTYPE_UNICODE 84

RFCTYPE_WCHAR 84

RFCTYPE_WIDE_2 84

RFCTYPE_WIDE_4 84

RFCTYPE_WIRE_OBJECT 85

RFCTYPE_WSTRING 85

Connect for SAP ®

ix

RFCTYPE_XMLDATA 85

RFCTYPE_XSTRING 85

gsSAPxRFCClient 86

Classes 86

TSAPxRFCAliasGS 87

TSAPxRFCClientConnectionGS 97

TSAPxRFCCustomAliasListGS 109

TSAPxRFCFileAliasListGS 114

TSAPxRFCRegistryAliasListGS 116

Records, Enums 119

TSAPxRFCAliasPasswordModeGS 119

TSAPxRFCSapTypeGS 119

TSAPxRFCSncQopGS 119

TSAPxRFCUseSapGUIGS 120

Types 120

TSAPxRFCConnectionLoginEventGS 120

TSAPxRFCCustomAliasListClassGS 120

gsSAPxRFCDataMove 121

Classes 121

TSAPxRFCEasyDataMoveGS 121

gsSAPxRFCServer 128

Classes 129

TSAPxRFCServerApplicationGS 130

TSAPxRFCServerCommandLineGS 137

TSAPxRFCServerConnectionGS 141

TSAPxRFCServerConnectionListGS 152

TSAPxRFCServerFunctionGS 155

TSAPxRFCSrvConnectionThreadGS 160

TSAPxMulticastCheckTIDEventGS 162

TSAPxMulticastCommitEventGS 163

TSAPxMulticastConfirmEventGS 164

TSAPxMulticastRollbackEventGS 165

TSAPxMulticastTIDEventGS 166

TSAPxRFCEventCounterGS 167

Functions 168

SAPxRFCServerApplication 168

Records, Enums 168

TSAPxRFCCheckTIDResultGS 169

TSAPxRFCSrvAppActionGS 169

TSAPxRFCSrvAppStateGS 169

TSAPxRFCSrvConThreadStateGS 170

Types 170

Connect for SAP ®

x

TSAPxRFCServerFunctionExecuteEventGS 170

TSAPxRFCSrvAppStatesGS 171

TSAPxRFCTxCheckTIDEventGS 171

TSAPxRFCTxCommitEventGS 171

TSAPxRFCTxConfirmEventGS 171

TSAPxRFCTxRollbackEventGS 172

TSAPxRFCTxTIDEventGS 172

gsSAPxRFCStdFunc 172

Classes 173

TSAPxRFCFunctionFactoryGS 173

TSAPxRFCFunctionSearchGS 174

TSAPxRFCGetFunctionInterfaceGS 178

TSAPxRFCGetFunctionInterfaceUSGS 182

TSAPxRFCGetStructureDefinitionGS 187

TSAPxRFCGetUnicodeStructureGS 191

TSAPxRFCGroupSearchGS 195

TSAPxRFCReadTableGS 200

TSAPxRFCSIStrGS 205

TSAPxRFCSystemInfoGS 209

Constants 214

CSAPXRFCReadTabWASize 214

gsSAPxRFCStdObj 215

Classes 218

ESAPxRFCCustomExceptionGS 218

ESAPxRFCNativeExceptionGS 220

TSAPxMulticastErrorEventGS 221

TSAPxRFCConnectedObjectGS 222

TSAPxRFCConnectionAttributesGS 229

TSAPxRFCCustomConnectionGS 236

TSAPxRFCDataFormatGS 250

TSAPxRFCDataObjectGS 257

TSAPxRFCEnvironmentGS 260

TSAPxRFCErrorInfoGS 280

TSAPxRFCFieldGS 281

TSAPxRFCFieldsListGS 293

TSAPxRFCFunctionGS 299

TSAPxRFCListObjectGS 310

TSAPxRFCObjectBaseGS 314

TSAPxRFCObjectGS 314

TSAPxRFCObjectsListGS 316

TSAPxRFCParameterGS 324

TSAPxRFCParametersListGS 335

Connect for SAP ®

xi

TSAPxRFCRemoteObjectGS 340

TSAPxRFCStructureCacheGS 345

TSAPxRFCStructureCacheItemGS 349

TSAPxRFCTableGS 351

TSAPxRFCTablesListGS 366

TSAPxRFCTracingObjectGS 369

TSAPxRFCTypeElementGS 370

TSAPxRFCTypeElementsListGS 377

TSAPxRFCValueAdapterGS 380

Interfaces 388

ISAPxRFCErrorHandlerGS 388

Functions 389

SAPxRFCDataType2Str 389

SAPxRFCFinalize 389

SAPxRFCGetSAPRFCINIFileName 390

SAPxRFCGetTracing 390

SAPxRFCInitialize 390

SAPxRFCIsStructType 390

SAPxRFCParameterType2Str 391

SAPxRFCRaiseCustomException 391

SAPxRFCRaiseException 391

SAPxRFCRaiseNativeException 391

SAPxRFCSetTracing 391

SAPxRFCSetTracing 392

Records, Enums 392

TSAPxRFCBytesPerCharGS 392

TSAPxRFCDataFormatValueGS 392

TSAPxRFCDataTypeGS 393

TSAPxRFCErrorActionGS 394

TSAPxRFCFloatTypeGS 394

TSAPxRFCFunctionCallTypeGS 395

TSAPxRFCIntTypeGS 395

TSAPxRFCMapBCDToTypeGS 396

TSAPxRFCParameterTypeGS 396

TSAPxRFCReadTableFormatGS 396

TSAPxRFCRemoteObjectDefinitionStateGS 397

TSAPxRFCTableStateGS 397

TSAPxRFCTreeStateGS 398

TSAPxRFCValueFormatGS 398

Types 398

ISAPxInterfaceBaseGS 398

TSAPxRFCConnectedObjectClassGS 398

Connect for SAP ®

xii

TSAPxRFCCustomConnectionClassGS 399

TSAPxRFCDataFormatValuesGS 399

TSAPxRFCErrorEventGS 399

TSAPxRFCFieldClassGS 400

TSAPxRFCListObjectClassGS 400

TSAPxRFCLoginCallBackGS 400

TSAPxRFCParameterClassGS 400

TSAPxRFCRemoteObjectClassGS 401

TSAPxRFCTableClassGS 401

TSAPxRFCValueAdapterGetDataFormatEventGS 401

TSAPxRFCValueAdapterGetEventGS 402

TSAPxRFCValueAdapterSetEventGS 402

TSAPxRFCWaitEventGS 402

Variables 403

FSAPxRFCEnvironment 403

FSAPxRFCLoginCallBack 403

Constants 403

CSAPxRFCMaxNonFlatSize 403

SSAPxRFCCfgKeyName 403

SSAPxRFCCfgValName 404

SSAPxRFCDefCfgFileName 404

SSAPxRFCDefCfgKeyName 404

SSAPxRFCDefRootKey 404

SSAPxRFCDefRootKeyOld 405

gsSAPxRFCUtil 405

Classes 406

TSAPxMulticastEventBaseGS 407

TSAPxMulticastNotifyEventGS 408

TSAPxRFCFuncWrapperGS 409

TSAPxRFCStringBuilderGS 410

Functions 412

Pos 412

SAPxRFCAnsiToUtf8 413

SAPxRFCCharInSet 413

SAPxRFCCurrToStr 413

SAPxRFCFloatToStr 413

SAPxRFCGetModuleName 413

SAPxRFCGetVersionInfo 414

SAPxRFCIsNumEmpty 414

SAPxRFCIsTextNum 414

SAPxRFCMemFill 414

SAPxRFCMemMove 414

Connect for SAP ®

xiii

SAPxRFCPadLeft 415

SAPxRFCReverseBytes 415

SAPxRFCStrToAPIStr 416

SAPxRFCStrToCh 416

SAPxRFCToolVer 416

SAPxRFCTrimAll 416

SAPxRFCUtf8Decode 417

SAPxRFCUtf8Encode 417

SAPxRFCUtf8ToAnsi 417

SAPxRFCWideStrLen 417

SAPxRFCWStrCopy 418

Types 418

IntPtr 418

PBoolean 418

PRawByteString 418

PUInt64 419

RawByteString 419

TBytes 419

TSAPxNativeInt 419

TSAPxNativeUInt 419

TSysCharSet 420

UInt64 420

UnicodeString 420

UTF8String 420

Constants 421

C_SAPxVersion 421

PathDelim 421

PathSep 421

sLineBreak 421

gsSAPxRFCvClient 422

Classes 423

TSAPxRFCvBlobStreamGS 423

TSAPxRFCvClientConnectionGS 424

TSAPxRFCvCustomTableGS 433

TSAPxRFCvFunctionGS 449

TSAPxRFCvParamsGS 455

TSAPxRFCvRemoteObjectGS 466

TSAPxRFCvServerTableGS 474

TSAPxRFCvTableGS 486

TSAPxRFCvCustomClientConnectionGS 496

TSAPxRFCvCustomRemoteObjectGS 498

Records, Enums 498

Connect for SAP ®

xiv

TSAPxRFCvParamKindGS 498

Types 498

TRecBuf 499

TRecordBuffer 499

TSAPxRFCvParamKindsGS 499

TSAPxRFCvParamSetKindGS 499

TValueBuffer 499

gsSAPxRFCvServer 500

Classes 500

TSAPxRFCvServerConnectionGS 500

TSAPxRFCvServerFunctionGS 507

gsSAPxRFCvStdObj 514

Classes 515

TSAPxMulticastActiveChangeEventGS 515

TSAPxRFCvCustomConnectionGS 516

TSAPxRFCvCustomObjectGS 523

Types 523

TSAPxRFCActiveChangeEventGS 523

Examples 523

Client transactional management 524

Index o

Connect for SAP ®

xv

1 Connect for SAP ®

1.1 About Connect for SAP® About

Connect for SAP® is an objected-oriented software library for Embarcadero Delphi, C++ Builder tools. Library allows:

• access to SAP application servers and call ABAP/4 function modules.

• implement partner server programs and function modules callable from ABAP/4.

Connect for SAP® encapsulates the Remote Function Call (RFC) interface and provides higher-level software componentsand classes.

SAP RFC

The Remote Function Call API (RFC API) allows - remotely or locally - calling ABAP/4 function modules from customapplications as well as receiving call request issued from an ABAP/4 program by the CALL FUNCTION interface. The RFCAPI supports several external systems, such as OS/2, Windows, WindowsNT and Windows95, and all R/3-based UNIXplatforms and makes it possible to use the RFC functionality between an SAP System and a custom applications on theabove platforms. Although Connect for SAP® is limited to Windows OS family and Linux.

Potential Connect for SAP® Applications

Connect for SAP® provides developers with the flexibility and versatility to:

• Integrate existing Delphi™ applications with SAP systems. This allows corporations to use their information system and make superstructure allowing to get new capabilities.

• Develop new systems and applications accessing to SAP application server as clients.

• Expand functionality of SAP system with Connect for SAP® to build external non-SAP servers. This Connect for SAP® feature gives a chance to avoid costs connected with ABAP/4 learning by developers because all functionality extensions are implemented in Delphi™ programs.

1.2 Installation

1.2 Installation Connect for SAP ® Requirements

1

1

1.2.1 Requirements

Before you install Connect for SAP®, ensure that you have the following:

System Requirements

• SAP RFC non-Unicode library version 6 or higher is installed on your PC. It is required for Delphi versions prior Delphi 2009.

• SAP RFC Unicode library version 6 or higher is installed on your PC. It is required for Delphi 2009 and higher versions.

SAP RFC library may be installed as part of SAP GUI installation.

SAP RFC library from SAP GUI v 6.x has a bug – each unload of librfc32.dll will result memory loss around 6Mb.

UTF8 character data is supported properly by SAP RFC library from SAP GUI v 6.x or higher.

• SAP R/3 system you want to work with is at least Release 2.1.

• Embarcadero Delphi™ 5 / 6 / 7 / 2005 / 2006 / 2009 / 2010 / XE ... 10.1 Berlin or Embarcadero C++Builder™ 6 / 2006 / 2007 / 2009 / 2010 / XE ... 10.1 Berlin is installed on your PC.

Only Delphi 2009 and higher offers full Unicode support.

At moment x32 and x64 platforms are supported for native code.

Additional requirements

• SAP user account used by Connect for SAP ® client application should have all required privileges to execute RFC function modules.

1.2.2 Installing components

To install Connect for SAP® library in Delphi IDE use following steps:

1. Run Delphi or C++ Builder IDE.

2. Choose File -> Open. Set "Files of type" to "Delphi package (*.dpk)" and open the appropriate Package Project files in theConnect for SAP® installation directory. Naming of runtime and design time packages are correspondinglygsSAPxRFC<Suffix>.dpk and gsSAPxRFC<Suffix>D.dpk. Values of Suffix parameters are specified in the table below

Suffix Tool

d5…d7 Delphi 5…7

d9…d11 Delphi / C++ Builder 2005…2007

d12 Delphi / C++ Builder 2009

d14 Delphi / C++ Builder 2010

d15..d24 Delphi / C++ Builder XE…10.1 Berlin

1.2 Installation Connect for SAP ® Installing components

2

1

3. Click on the "Compile" button, in Package window and then press "Install" button. The new components appear in the IDEComponent Palette:

1.2.3 Component's description

The set of Connect for SAP® components is divided into two parts: components for building client programs and non-SAPserver ones.

Client components

The set of Connect for SAP® client components is used to access to SAP application server's function modules.

The TSAPxRFCvClientConnectionGS ( seepage 424) is the main client component. Itconnects to the specified SAP system andprovides exchanging data between a clientprogram and the SAP system.

The TSAPxRFCvFunctionGS ( see page 449)component allows executing an ABAP RFCfunction module. It has a set of inputparameters, output parameters and table lists,which are used to access the function moduledata.

The TSAPxRFCvTableGS ( see page 486) isa TDataSet inherited component, therefore itcan be used by data aware controls. It allowsaccessing to the specified table from theTSAPxRFCvFunctionGS ( see page 449)table list.

The TSAPxRFCvServerTableGS ( see page474) is a descendant of TDataSet component;therefore it can be used by data aware controls.It allows getting dictionary information aboutspecified SAP DB table (fields description) anddata stored inside this table.

The TSAPxRFCvParamsGS ( see page 455)corresponds to a set of function's parameters. Itallows editing and displaying the parameter setwith data aware controls.

Server components

The set of Connect for SAP® server components implements non-SAP server programs, which enhance functionality of aSAP system.

The TSAPxRFCvServerConnectionGS ( seepage 500) is the main component for anon-SAP server program. It registers allsupported server functions on a SAP gateway;processes client requests and dispatches them.

The TSAPxRFCvServerFunctionGS ( seepage 507) component allows implementingsome part of server functionality. Each ofTSAPxRFCvServerFunctionGS ( see page507) components belongs to specified serverconnection and receives client requests from itonly.

1.3 Architecture Connect for SAP ®

3

1

1.3 Architecture

1.3.1 Overview

Picture below shows how Delphi applications can interact with a SAP system through Connect for SAP®. The library may beused both in client applications and in server ones.

In client applications, when developer want to call an ABAP/4 function, he uses Connect for SAP® function object's methodsand properties. In its turn Connect for SAP® packs all necessary data, translates the call to the RFC API and send to SAPsystem. Having received the request a SAP application server processes it and returns result. Then Connect for SAP® getsresult data from the RFC library and a developer can process it.

In server applications, Connect for SAP® is waiting for a client request from a SAP system. When a client request isreceived, Connect for SAP® processes it. Then Connect for SAP® takes care of sending the result to the SAP system incorrect format.

1.3.2 RFC function architecture

To understand how RFC function may be called, and how to work with function parameters, it's necessary to considerarchitecture of RFC function. Following picture shows that:

1.3 Architecture Connect for SAP ® RFC function architecture

4

1

As you see, RFC function receives data from Export parameters (InParams ( see page 454)), returns data in Importparameters (OutParams ( see page 454)) and Tables ( see page 454) transfer rowsets in both directions. All dataimported from and exported to the RFC function have RFC data format and specific byte order. So, data representationdiffers from Delphi one. One of the Connect for SAP® tasks is to map RFC data types on Delphi ones and backward.

See Mapping RFC data types ( see page 5) and Early and late function binding ( see page 7) for more details.

1.3.3 Mapping RFC data types

All RFC data types may be divided in three groups: simple data type, structured data types and tables. Each group has itsown mapping method.

Simple data types

Mapping of simple RFC data type is performed according to table below. dtBCDGS ( see page 393) data type hasambiguous mapping and a developer can explicitly point a target Delphi data type. Otherwise, Connect for SAP® maps thisdata type on the most suitable Delphi data type. See TSAPxRFCDataFormatGS ( see page 250) class and propertyDataFormat ( see page 92).

RFC data type Delphi data type Delphi field type

dtCharGS

(Pre Delphi 2009)

AnsiString • ftString (size <= 8192)

• ftMemo (size > 8192)

1.3 Architecture Connect for SAP ® Mapping RFC data types

5

1

dtCharGS

(Delphi 2009 and higher)

UnicodeString • ftWideString (size <= 8192)

• ftWideMemo (size > 8192)

dtNumGS Int64 • ftSmallInt (size <= 4)

• ftInteger (size <= 9)

• ftLargeint (size > 9)

dtBytesGS RawByteString • ftVarBytes (size <= 8192)

• ftBlob (size > 8192)

dtBCDGS • Integer

• Int64

• Currency

• Double

• String

ftFloat

dtIntGS Integer ftInteger

dtInt1GS ShortInt ftSmallInt

dtInt2GS SmallInt dtSmallInt

dtFloatGS Double ftFloat

dtDateGS TDateTime ftDate

dtTimeGS TDateTime ftTime

dtStringGS UnicodeString • ftWideString (size <= 8192)

• ftWideMemo (size > 8192)

dtXMLDataGS UnicodeString ftWideMemo

dtXStringGS RawByteString ftBlob

dtLineTypeGS Not supported Not supported

Structured data types

The structured data type, dtStructureGS ( see page 393), in contrast of simple ones has no Delphi analogous type. ThusConnect for SAP® imitates dtStructureGS ( see page 393) type by means of TSAPxRFCParameterGS ( see page 324)class containing field list of TSAPxRFCFieldsListGS ( see page 293) class. So a structure corresponds a field list and anindividual field of TSAPxRFCFieldGS ( see page 281) class represents each structure item. Connect for SAP® does notsupport nested structured data types. It means that each structure item must have a simple data type.

For functions having structured parameters it's necessary to install (register) a structure layout at RFC library. It allows theRFC library automatically convert data representations on different platforms to each other (for example, a platform mayhave its own byte order). Connect for SAP® takes care about automatic installation of a structure's description in clientapplications.

Table above shows that simple RFC data types are translated to Delphi field types easily enough. Table below demonstrateshow dtStructureGS ( see page 393) type is converted to Delphi field type.

1.3 Architecture Connect for SAP ® Mapping RFC data types

6

1


dtStructureGS TSAPxRFCParameterGS

[owns single]

TSAPxRFCFieldsListGS

[ownc one or many]

TSAPxRFCFieldGS

TSAPxRFCvTableGS

RFC table parameters

Connect for SAP® includes the TSAPxRFCvTableGS ( see page 486) component inherited from TDataSet, that on the onehand provides easy and clear interface for Delphi developers, on the other hand works with RFC library using RFC datatypes and formats.


RFC table parameter TSAPxRFCTableGS TSAPxRFCvTableGS

1.3.4 Early and late function binding

In general, binding is a way to get ABAP/4 function module meta data by Connect for SAP® function object and define input,output parameter lists and table list. In Connect for SAP® property Prepared ( see page 229) controls binding. Librarysupports two ways of function object binding with ABAP function module - early and late binding.

Early binding means that required meta data about ABAP function parameters is already known before the function objectwill be prepared. Standard way to get that - statically define all parameters and tables in objects constructor. It'srecommended to get a wrapping code for the ABAP functions using Connect for SAP® Explorer tool (see Connect for SAP®Explorer User Guide). It saves a lot of time and avoids many mistakes. Listing 1 shows a wrapping code generated byConnect for SAP® Explorer for RFC_READ_TABLE ABAP function.

Listing 1. Early binding.

Example shows a code generated by Connect for SAP® Explorer for wrapping RFC_READ_TABLE ABAP function.

TSAPxRFCRFC_READ_TABLEFuncGS = class(TSAPxRFCFunctionGS)private procedure SetDELIMITER(const AValue: String); function GetDELIMITER: String; function GetDATA: TSAPxRFCTAB512TableGS;public constructor Create; override; property DELIMITER: String read GetDELIMITER write SetDELIMITER; property DATA: TSAPxRFCTAB512TableGS read GetDATA;end; implementation procedure Execute;begin // working with TSAPxRFCRFC_READ_TABLEFuncGS object interface with TSAPxRFCRFC_READ_TABLEFuncGS.Create do try Connection := oMyconn;

1.3 Architecture Connect for SAP ® Early and late function binding

7

1

DELIMITER := '%'; ExecFunction; with DATA do begin { do something with table 'DATA' } end; finally Free; end;end;

Late binding just the contrary allows to developer call an ABAP procedure without any knowledge of its meta data. In thiscase Connect for SAP® automatically gets all necessary meta data at run time and then calls the ABAP function (see Listing2).

Listing 2: Late binding.

Example shows usage of a dynamically prepared function.

procedure Execute;begin // working with TSAPxRFCFunctionGS object interface with TSAPxRFCFunctionGS.Create do try Connection := oMyconn; ObjName := 'RFC_READ_TABLE'; Prepared := True; InParams.ParameterByName('DELIMITER').AsString := '%'; ExecFunction; with Tables.TableByName('DATA') do begin { do something with table 'DATA' } end; finally Free; end;end;

Advantages and disadvantages of early binding are:

• Has better performance, because eliminates need to ask SAP server for meta data.

• Allows to use Delphi compiler features at development time, including find mistakes at compiling, usage of "Code Insight".

• Function modules should be known at development time.

Advantages and disadvantages of late binding are:

• Allows to use any function module at runtime, not just known at development time.

• Lower performance, because it is required to ask SAP server for meta data.

1.3.5 Client application architecture

Components and objects

To build client application the developer can use both objects and components encapsulating the objects. The naming styleof component and object classes is very simple and clear. For example, TSAPxRFCvFunctionGS ( see page 449)component class encapsulates TSAPxRFCFunctionGS ( see page 299) object, TSAPxRFCvClientConnectionGS ( seepage 424) component class encapsulates TSAPxRFCClientConnectionGS ( see page 97) object. The following pictureillustrates an interaction of Connect for SAP® components with each other. The schema of working with Connect for SAP®objects is the same, except an ability to use data aware controls.

1.3 Architecture Connect for SAP ® Client application architecture

8

1

Interaction of Connect for SAP® client components in an application

The main Connect for SAP® client component is TSAPxRFCvClientConnectionGS. It handles communication of clientapplication with the SAP server. TSAPxRFCvFunctionGS component allows to call ABAP/4 function modules. It usesTSAPxRFCvClientConnectionGS component to communicate with SAP server. TSAPxRFCvParamsGS andTSAPxRFCvTableGS components are used together with TSAPxRFCvFunctionGS component. They implements datasetlike interface to function parameters and tables. Because TSAPxRFCvParamsGS, TSAPxRFCvTableGS, andTSAPxRFCvServerTableGS are inherited from TDataSet, they can be linked with any data aware controls.

Using connection aliases

Before TSAPxRFCvClientConnectionGS will establish a communication with a SAP system, a set of parameters (Params (see page 431)) must be defined according to the SAP RFC documentation. The set of parameters may be named andstored in an external storage. This set is called Connect for SAP® connection alias. The developer may assign an aliasname to the TSAPxRFCvClientConnectionGS.AliasName ( see page 430) property instead of specifying parameters. Usethe Connect for SAP® Explorer tool (see a topic of Connect for SAP® - Getting Started) to maintain a Connect for SAP®alias storage.

Features of transactional calls

Connect for SAP® supports transactional function calls. A function may be called as a transactional one if the followingrequirements are complied:

• the client connection has an active transaction. It means that

• TSAPxRFCvFunctionGS.CallType property must be set to ftTransactionalGS.

• TSAPxRFCvFunctionGS must have no import (output) parameters.

• Only single function can be called within a single transaction.

1.3 Architecture Connect for SAP ® Server application architecture

9

1

1.3.6 Server application architecture

Components and objects

The server application as well as client ones can be built on both components and objects. There are two Connect for SAP®server components: TSAPxRFCvServerConnectionGS ( see page 500) and TSAPxRFCvServerFunctionGS ( see page507), which encapsulate TSAPxRFCServerConnectionGS ( see page 141) and TSAPxRFCServerFunctionGS ( see page155) objects accordingly. The main server component is TSAPxRFCvServerConnectionGS ( see page 500) (Figure 1). Itprovides a non-SAP server with registration on gateway and communication of TSAPxRFCvServerFunctionGS ( see page507) components with a SAP system through the RFC library. Picture below illustrates interaction of Connect for SAP®server components in an application.

The server connection parameters are specified by CommandLine property (see "Using command line"). A developer uses aTSAPxRFCvServerFunctionGS component to implement server functions.

Using command line

A set of server connection parameters can be specified in a command line when the server application is starting. In thiscase command line parameters are automatically assigned to CommandLine ( see page 504) property ofTSAPxRFCvServerConnectionGS ( see page 500) component. Table 1 shows command line's switches and theirmeanings. When server starting it's possible to specify either PROGRAM_ID, GWHOST, GWSERV and RFC_TRACEparameters or DESTINATION one only.

Command line switch Meaning

-a<PROGRAM_ID> Identifier of server connection registered on SAP gateway

-g<GWHOST> Host name of SAP gateway

-x<GWSERV> Service name on SAP gateway


10

1

-t<RFC_TRACE> Indicator of tracing

-D<DESTINATION> Destination name in saprfc.ini file

In the second case you have to define the entry with name DESTINATION in the saprfc.ini file that specifies all connectionparameters (see example in Listing 3). This way for specifying server connection parameters is more flexible than the firstone. Using command line it's important to remember that you can't specify more than one set of server connectionparameters. So, for server applications with multiple connections a developer should explicitly specify CommandLine ( seepage 150) property of TSAPxRFCvServerConnectionGS ( see page 500) component.

Listing 1: Destinations list in saprfc.ini file

; -----------------------------------------------------------------------; Connect for SAP® server destinations; -----------------------------------------------------------------------DEST=S1TYPE=RPROGID=SAPXRFCTEST_PROGID1GWHOST=myserver.mydomain.comGWSERV=sapgw00

Transaction management

Connect for SAP® supports transactional server functions. SAP R/3, the RFC library and Connect for SAP® serverconnection communicate with each other in two phases:

• The first phase (F1) - Function transfer

• The second phase (F2) - Confirmation

Function transfer phase is initiated from ABAP program and divided into three parts:

• T1 - OnCheckTID event handler has to check TID status, update it and return appropriate check result

• T2 - OnExecute event handler should contain the required RFC server function implementation

• T3 (T3') - OnCommit (OnRollback) event handler updates TID status and commits (rolls back) database (non-SAP database) transaction(s)


11

1

Confirmation phase starts as soon as the RFC library informs the SAP system about successful T3 (not T3').TSAPxRFCvServerConnectionGS ( see page 500) component immediately receives confirmation of the currenttransaction. In OnConfirm ( see page 504) event handler a developer should update TID status (delete). After this phase,the current transaction is successfully completed on both sides. Simple example of transaction management is shown inListing 2.

Listing 2: Transactional management

procedure TxServer.HandleCheckTID(Sender: TObject; const ATID: String; var AResult: TSAPxRFCCheckTIDResultGS);begin if CheckStatus(ATID) then // whether the transaction has not started UpdateStatus(ATID, tsCreated) // updating the transaction's status else AResult := crCancelGS; // rejecting the transactionend; {-----------------------------------------------------------------------------}procedure TxServer.HandleCommit(Sender: TObject; const ATID: String);begin UpdateStatus(ATID, tsExecuted); CommitDB(ATID); // committing non-SAP database transactionend; {-----------------------------------------------------------------------------}procedure TxServer.HandleConfirm(Sender: TObject; const ATID: String);begin UpdateStatus(ATID, tsDeleted);end; {-----------------------------------------------------------------------------}procedure TxServer.HandleRollback(Sender: TObject; const ATID: String);begin RollbackDB(ATID); // rolling non-SAP database transaction backend;

1.4 Units Connect for SAP ®

12

1

1.4 Units Units

gsfSAPxRFCLogin ( see page 13)

gsSAPxRFCBase ( see page 14)

gsSAPxRFCClient ( see page 86)

gsSAPxRFCDataMove ( see page 121)

gsSAPxRFCServer ( see page 128)

gsSAPxRFCStdFunc ( see page 172)

gsSAPxRFCStdObj ( see page 215)

gsSAPxRFCUtil ( see page 405)

gsSAPxRFCvClient ( see page 422)

gsSAPxRFCvServer ( see page 500)

gsSAPxRFCvStdObj ( see page 514)

1.4.1 Unit gsfSAPxRFCLogin

Classes

TfrmSAPxRFCLoginGS ( see page 13)

Group

Units ( see page 13)

Variables

frmSAPxRFCLoginGS ( see page 14)

Description

Unit gsSAPxRFCLogin contains a class of login form that is used by default during user logging.

1.4.1.1 Classes

1.4.1.1.1 Class TfrmSAPxRFCLoginGS Unit

Unit gsfSAPxRFCLogin ( see page 13)

File

gsfSAPxRFCLogin

Syntax

public TfrmSAPxRFCLoginGS = class(TForm);

1.4.1.2 Variables

1.4 Units Connect for SAP ® Unit gsfSAPxRFCLogin

13

1

1.4.1.2.1 Variable frmSAPxRFCLoginGS Unit

Unit gsfSAPxRFCLogin ( see page 13)

File

gsfSAPxRFCLogin

Syntax

frmSAPxRFCLoginGS: TfrmSAPxRFCLoginGS;

1.4.2 Unit gsSAPxRFCBase

Classes

ESAPxRFCExceptionGS ( see page 21)

Constants

__RFCTYPE_max_value_v4 ( see page 68)

__RFCTYPE_max_value_v6 ( see page 69)

_RFCTYPE_differ_from_abap ( see page 69)

_RFCTYPE_illegal_wchar ( see page 69)

_RFCTYPE_the_last_line_without_colon ( see page 69)

C_RFC_ERROR_APPLICATION_EXCEPTION ( see page 70)

C_RFC_ERROR_BUSY ( see page 70)

C_RFC_ERROR_CANCELLED ( see page 70)

C_RFC_ERROR_COMMUNICATION ( see page 70)

C_RFC_ERROR_INTERNAL ( see page 70)

C_RFC_ERROR_LOGON_FAILURE ( see page 71)

C_RFC_ERROR_PROGRAM ( see page 71)

C_RFC_ERROR_PROTOCOL ( see page 71)

C_RFC_ERROR_RESOURCE ( see page 71)

C_RFC_ERROR_SYSTEM_FAILURE ( see page 71)

C_SAPxRFC_V46 ( see page 72)








1.4 Units Connect for SAP ® Unit gsSAPxRFCBase

14

1

C_TRFC_CANCEL ( see page 74)

C_TRFC_INTERNAL_ERROR ( see page 74)

C_TRFC_OK ( see page 74)

ITAB_NULL ( see page 74)

RFC_CANCEL_CLOSE ( see page 74)

RFC_CANCEL_HARD ( see page 75)

RFC_CANCEL_SOFT ( see page 75)

RFC_CONV_ID_LN ( see page 75)

RFC_FUNCTIONNAME_LN ( see page 75)

RFC_HANDLE_NULL ( see page 76)

RFC_ROLE_Client ( see page 76)

RFC_ROLE_SERVER ( see page 76)

RFC_SERVER_EXT ( see page 76)

RFC_SERVER_EXT_REG ( see page 76)

RFC_SERVER_R2 ( see page 77)

RFC_SERVER_R3 ( see page 77)

RFC_STRING_MAX_LEN ( see page 77)

RFC_TID_LN ( see page 77)

RFC_TRACE_OFF ( see page 77)

RFC_TRACE_ON ( see page 78)

RFCTYPE_ABAP4OBJECT ( see page 78)

RFCTYPE_BCD ( see page 78)

RFCTYPE_BLOB ( see page 78)

RFCTYPE_BYTE ( see page 79)

RFCTYPE_CHAR ( see page 79)

RFCTYPE_CORBA_OBJECT ( see page 79)

RFCTYPE_DATE ( see page 79)

RFCTYPE_DATE_1 ( see page 80)

RFCTYPE_DATE_2 ( see page 80)

RFCTYPE_FLOAT ( see page 80)

RFCTYPE_INT ( see page 80)

RFCTYPE_INT1 ( see page 81)

RFCTYPE_INT2 ( see page 81)

RFCTYPE_ITAB ( see page 81)

RFCTYPE_IUNKNOWN ( see page 81)

RFCTYPE_NULL ( see page 82)

RFCTYPE_NUM ( see page 82)

RFCTYPE_PADDING ( see page 82)

RFCTYPE_SAPAUTOMATION ( see page 82)

RFCTYPE_STRING ( see page 83)

RFCTYPE_STRUCTURE ( see page 83)

RFCTYPE_STUB ( see page 83)

RFCTYPE_TIME ( see page 83)

RFCTYPE_UNICODE ( see page 84)

RFCTYPE_WCHAR ( see page 84)

RFCTYPE_WIDE_2 ( see page 84)

RFCTYPE_WIDE_4 ( see page 84)

RFCTYPE_WIRE_OBJECT ( see page 85)


15

1

RFCTYPE_WSTRING ( see page 85)

RFCTYPE_XMLDATA ( see page 85)

RFCTYPE_XSTRING ( see page 85)

Functions

SAPxRFCLoadLib ( see page 21)

SAPxRFCUnLoadLib ( see page 21)

Group


Legend

Record

Enumeration

Records, Enums

RFC_ATTRIBUTES ( see page 22)

RFC_ENV ( see page 24)

RFC_ERROR_INFO_EX ( see page 24)

RFC_ITMODE ( see page 24)

RFC_PARAMETER ( see page 25)

RFC_RC ( see page 26)

RFC_TABLE ( see page 28)

RFC_TYPE_ELEMENT ( see page 29)

RFC_UNICODE_TYPE_ELEMENT ( see page 29)

RFC_XSTRING ( see page 29)

SAP_RFC_STATISTIC ( see page 30)

Types

ITAB_H ( see page 31)

PBoolean ( see page 31)

ppRfc_char_t ( see page 32)

pRFC_ATTRIBUTES ( see page 32)

pRFC_BCD ( see page 32)

pRFC_BYTE ( see page 32)

pRFC_CHAR ( see page 32)

pRfc_char_t ( see page 33)

pRFC_DATE ( see page 33)

pRFC_ENV ( see page 33)

pRFC_ERROR_INFO_EX ( see page 33)

pRFC_FLOAT ( see page 33)

pRFC_INT ( see page 34)

pRFC_INT1 ( see page 34)

pRFC_INT2 ( see page 34)

pRFC_IUNKNOWN ( see page 34)

pRFC_NUM ( see page 34)


16

1

pRFC_PARAMETER ( see page 35)

pRFC_STRING ( see page 35)

pRFC_STRUCT_TYPE_ID ( see page 35)

pRFC_TABLE ( see page 35)

pRFC_TIME ( see page 35)

pRFC_TYPE_ELEMENT ( see page 36)

pRFC_UNICODE ( see page 36)

pRFC_UNICODE_TYPE_ELEMENT ( see page 36)

pRFC_WCHAR ( see page 36)

pRFC_WSTRING ( see page 36)

pRFC_XMLDATA ( see page 37)

pRFC_XSTRING ( see page 37)

pSAP_RFC_STATISTIC ( see page 37)

RFC_ALLOCATE ( see page 37)

RFC_BCD ( see page 37)

RFC_BYTE ( see page 38)

rfc_byte_t ( see page 38)

RFC_CANCEL_TYPE ( see page 38)

RFC_CHAR ( see page 38)

rfc_char_t ( see page 39)

RFC_DATE ( see page 39)

RFC_ERROR_GROUP ( see page 39)

RFC_ERROR_HANDLER ( see page 39)

RFC_FLOAT ( see page 39)

RFC_FUNCTIONNAME ( see page 40)

RFC_FUNCTIONNAMEArr ( see page 40)

RFC_HANDLE ( see page 40)

RFC_INT ( see page 40)

RFC_INT1 ( see page 41)

RFC_INT2 ( see page 41)

RFC_IUNKNOWN ( see page 41)

RFC_NUM ( see page 41)

RFC_ON_CHECK_TID ( see page 42)

RFC_ON_CHECK_TID_EX ( see page 42)

RFC_ON_COMMIT ( see page 42)

RFC_ON_COMMIT_EX ( see page 42)

RFC_ON_CONFIRM_TID ( see page 42)

RFC_ON_CONFIRM_TID_EX ( see page 43)

RFC_ON_ROLLBACK ( see page 43)


17

1

RFC_ON_ROLLBACK_EX ( see page 43)

RFC_ONCALL ( see page 43)

RFC_STRING ( see page 43)

RFC_STRUCT_TYPE_ID ( see page 44)

RFC_TID ( see page 44)

RFC_TIDArr ( see page 44)

RFC_TIME ( see page 44)

RFC_TYPEHANDLE ( see page 44)

RFC_UNICODE ( see page 45)

rfc_unicode_t ( see page 45)

RFC_WCHAR ( see page 45)

RFC_WSTRING ( see page 45)

RFC_XMLDATA ( see page 46)

RFCTYPE ( see page 46)

SAP_UTF8 ( see page 46)

TSAPxRFCAbortGS ( see page 46)

TSAPxRFCAcceptGS ( see page 46)

TSAPxRFCAllocStringGS ( see page 47)

TSAPxRfcAllowStartProgram ( see page 47)

TSAPxRFCCallGS ( see page 47)

TSAPxRFCCallReceiveGS ( see page 47)

TSAPxRFCCancelGS ( see page 47)

TSAPxRFCCloseGS ( see page 48)

TSAPxRFCConfirmTransIDGS ( see page 48)

TSAPxRFCConvertBCDToCharGS ( see page 48)

TSAPxRFCConvertCharToBCDGS ( see page 48)

TSAPxRFCCreateTransIDGS ( see page 48)

TSAPxRFCDispatchGS ( see page 49)

TSAPxRFCEnumGS ( see page 49)

TSAPxRFCEnvironment_prcGS ( see page 49)

TSAPxRfcExidToRfcTypeGS ( see page 49)

TSAPxRFCFreeStringGS ( see page 49)

TSAPxRFCGetAttributesGS ( see page 50)

TSAPxRFCGetDataGS ( see page 50)

TSAPxRFCGetNameGS ( see page 50)

TSAPxRFCIndirectCallExGS ( see page 50)


18

1

TSAPxRFCInstallFunctionExtGS ( see page 51)

TSAPxRFCInstallFunctionGS ( see page 51)

TSAPxRFCInstallStructureGS ( see page 51)

TSAPxRFCInstallTransactionControl2GS ( see page 51)

TSAPxRFCInstallTransactionControlGS ( see page 51)

TSAPxRFCitAppLineGS ( see page 52)

TSAPxRFCitCpyLineGS ( see page 52)

TSAPxRFCitCreateGS ( see page 52)

TSAPxRFCitDeleteGS ( see page 52)

TSAPxRFCitDelLineGS ( see page 52)

TSAPxRFCitFillGS ( see page 53)

TSAPxRFCitFreeGS ( see page 53)

TSAPxRFCitGetLineGS ( see page 53)

TSAPxRFCitGupLineGS ( see page 53)

TSAPxRFCitInsLineGS ( see page 53)

TSAPxRFCitLengGS ( see page 54)

TSAPxRFCitPutLineGS ( see page 54)

TSAPxRFCLastErrorExGS ( see page 54)

TSAPxRFCListenGS ( see page 54)

TSAPxRFCOpenExGS ( see page 54)

TSAPxRFCRaiseGS ( see page 55)

TSAPxRFCRaiseTablesGS ( see page 55)

TSAPxRFCReceiveGS ( see page 55)

TSAPxRFCResizeXStringGS ( see page 55)

TSAPxRFCSendDataGS ( see page 56)

TSAPxRFCStatisticGS ( see page 56)

TSAPxRFCTraceProcGS ( see page 56)

TSAPxRFCUninstallFunctionGS ( see page 56)

TSAPxRFCWaitForRequestGS ( see page 56)

Variables

_RFCTYPE_max_value ( see page 57)

FSAPxRFCDllFileName ( see page 57)

FSAPxRFCEnableUnload ( see page 57)

FSAPxRFChDll ( see page 57)

FSAPxRFCInitialized ( see page 58)

FSAPxRFCLibVersion ( see page 58)

FSAPxRFCLock ( see page 58)


19

1

FSAPxRFCTraceProc ( see page 58)

itAppLine ( see page 59)

itCpyLine ( see page 59)

itCreate ( see page 59)

itDelete ( see page 59)

itDelLine ( see page 59)

itFill ( see page 60)

itFree ( see page 60)

itGetLine ( see page 60)

itGupLine ( see page 60)

itInsLine ( see page 60)

itLeng ( see page 61)

itPutLine ( see page 61)

RfcAbort ( see page 61)

RfcAccept ( see page 61)

RfcAllocString ( see page 61)

RfcAllowStartProgram ( see page 62)

RfcCall ( see page 62)

RfcCallReceive ( see page 62)

RfcCancel ( see page 62)

RfcClose ( see page 62)

RfcConfirmTransID ( see page 63)

RfcConvertBCDToChar ( see page 63)

RfcConvertCharToBCD ( see page 63)

RfcCreateTransID ( see page 63)

RfcDispatch ( see page 63)

RfcEnvironment ( see page 64)

RfcExidToRfcType ( see page 64)

RfcFreeString ( see page 64)

RfcGetAttributes ( see page 64)

RfcGetData ( see page 64)

RfcGetName ( see page 65)

RfcIndirectCallEx ( see page 65)

RfcInstallFunction ( see page 65)

RfcInstallFunctionExt ( see page 65)

RfcInstallStructure ( see page 65)

RfcInstallTransactionControl ( see page 66)

RfcInstallTransactionControl2 ( see page 66)

RfcLastErrorEx ( see page 66)

RfcListen ( see page 66)

RfcOpenEx ( see page 66)

RfcRaise ( see page 67)

RfcRaiseTables ( see page 67)

RfcReceive ( see page 67)

RfcResizeXString ( see page 67)

RfcSendData ( see page 67)


20

1

RfcStatistic ( see page 68)

RfcUninstallFunction ( see page 68)

RfcWaitForRequest ( see page 68)

Description

Unit gsSAPxRFCBase includes a base data types, constants and functions providing a work with SAP RFC library. Amongcore functions there are SAPxRFCLoadLib ( see page 21) and SAPxRFCUnLoadLib ( see page 21).

1.4.2.1 Classes

1.4.2.1.1 Class ESAPxRFCExceptionGS Unit

Unit gsSAPxRFCBase ( see page 14)

File

gsSAPxRFCBase

Description

ESAPxRFCExceptionGS is the base class for all Connect for SAP® objects' runtime exceptions.

Syntax

public ESAPxRFCExceptionGS = class(Exception);

1.4.2.2 Functions

1.4.2.2.1 Function SAPxRFCLoadLib Unit


File

gsSAPxRFCBase

Description

Loads the RFC API library with name specified by FSAPxRFCDllFileName ( see page 57).

Connect for SAP automatically tracks the number of references to RFC API. When the number of references increases to 1,the library will be loaded into memory.

Syntax

procedure SAPxRFCLoadLib;

1.4.2.2.2 Function SAPxRFCUnLoadLib Unit


File

gsSAPxRFCBase

Description

Unloads the RFC API library if it was previously loaded by SAPxRFCLoadLib ( see page 21).


21

1

Connect for SAP automatically tracks the number of references to RFC API. When the number of references decreases to 0and FSAPxRFCEnableUnload ( see page 57) is True, the library will be unloaded from memory.

Syntax

procedure SAPxRFCUnLoadLib;

1.4.2.3 Records, Enums

1.4.2.3.1 Record RFC_ATTRIBUTES All Members

All Members Description

Dest field RFC destination 'DESTfield RFC destination 'DEST

own_host field Own host Name 'ASHOSTfield Own host Name 'ASHOST

partner_host field Partner host Namefield Partner host Name

systnr field R/3 system number 'SYSNRfield R/3 system number 'SYSNR

sysid field R/3 system Namefield R/3 system Name

Client field Client 'Clientfield Client 'Client

User field User 'USERfield User 'USER

Language field Language 'LANGfield Language 'LANG

Trace field ON/OFF: 'Xfield ON/OFF: 'X'/'

ISO_language field 2-byte ISO-Languagefield 2-byte ISO-Language

own_codepage field Own code pagefield Own code page

partner_codepage field Partner code pagefield Partner code page

rfc_role field C/S: RFC Client / RFC Serverfield C/S: RFC Client / RFC Server

own_type field 2/3/E/R: R/2,R/3,Ext,Reg.Ext 'TYPE

own_rel field My system releasefield My system release

partner_type field 2/3/E/R: R/2,R/3,Ext,Reg.Ext

partner_rel field Partner system releasefield Partner system release

kernel_rel field Partner kernel releasefield Partner kernel release

CPIC_convid field CPI-C Conversation IDfield CPI-C Conversation ID

password_state field state from the password see RFC_PASS


22

1

own_codepage_pcs Own codepage in partners point of view. Differs from own_codepage field only if UNICODE and pcs flag are used (see ). Elsewhere this field is identically with own_codepage field.

pcs @field Partners Char Size (valid only in Unicode systems) 1/2: Non Unicode/Unicode This information is only valid after successful call to the target system.

real_partner_codepage @field Partner real code page. This information is valid only after successful call

progname field Name of the calling program

reserved @field reserve 'PASSWD'field reserve

Unit


File

gsSAPxRFCBase

Description

Is returned by RfcGetAttributes ( see page 272) describing some information about this RFC connection.

• dest[64+1] - RFC destination

• own_host[100+1] - Own host name

• partner_host[100+1] - Partner host name

• systnr[2+1] - R/3 system number

• sysid[8+1] - R/3 system name

• client[3+1] - Client

• user[12+1] - User

• language[1+1] - Language

• reserved[256] - Reserved

Syntax

public RFC_ATTRIBUTES = record Dest: array [0..64+1-1] of rfc_char_t; own_host: array [0..100+1-1] of rfc_char_t; partner_host: array [0..100+1-1] of rfc_char_t; systnr: array [0..2+1-1] of rfc_char_t; sysid: array [0..8+1-1] of rfc_char_t; Client: array [0..3+1-1] of rfc_char_t; User: array [0..12+1] of rfc_char_t; Language: array [0..1+1-1] of rfc_char_t; Trace: rfc_char_t; ISO_language: array [0..2+1-1] of rfc_char_t; own_codepage: array [0..4+1-1] of rfc_char_t; partner_codepage: array [0..4+1-1] of rfc_char_t; rfc_role: rfc_char_t; own_type: rfc_char_t; own_rel: array [0..4+1-1] of rfc_char_t; partner_type: rfc_char_t; partner_rel: array [0..4+1-1] of rfc_char_t; kernel_rel: array [0..4+1-1] of rfc_char_t; CPIC_convid: array [0..9-1] of rfc_char_t; password_state: rfc_char_t; own_codepage_pcs: array [0..4+1-1] of rfc_char_t; pcs: array [0..1+1-1] of rfc_char_t; real_partner_codepage: array [0..4+1-1] of rfc_char_t; progname: array [0..40+1-1] of rfc_char_t; reserved: array [0..161-1] of rfc_char_t;


23

1

end;

1.4.2.3.2 Record RFC_ENV Unit


File

gsSAPxRFCBase

Description

Supply your own routines for error handling and memory allocation in RfcEnvironment ( see page 64) call.

Syntax

public RFC_ENV = record errorhandler: RFC_ERROR_HANDLER; allocate: RFC_ALLOCATE;end;

1.4.2.3.3 Record RFC_ERROR_INFO_EX All Members


Group Error group

key Error code to identify the error. The error Group (type integer) and error key (type string) have the same meaning. RFC program can better analyze the error with the error Group instead of error key.

Unit


File

gsSAPxRFCBase

Description

Is returned by RfcLastErrorEx ( see page 275) describing the last RFC error that occurred.

Syntax

public RFC_ERROR_INFO_EX = record Group: RFC_ERROR_GROUP; key: array [0..32] of rfc_char_t;end;

1.4.2.3.4 Enumeration RFC_ITMODE All Members


RFC_ITMODE_BYREFERENCE emem Table is passed by reference (ALLWAYS USE THIS)

RFC_ITMODE_BYVALUE @emem Table is passed by value, changes are not transported back (internal use only !)

RFC_ITMODE_KEEPALIVE @emem Table is passed by reference, but is kept alive after returning, (i.e. after RfcSendData, internal use only)

Unit


File

gsSAPxRFCBase


24

1

Description

Provides a mode how to pass an internal table.

• RFC_ITMODE_BYREFERENCE - table is passed by reference. You must always use RFC_ITMODE_BYREFERENCE.

• RFC_ITMODE_BYVALUE - table is passed by value, changes are not transported back. RFC_ITMODE_BYVALUE is for internal use only.

• RFC_ITMODE_KEEPALIVE - table is passed by reference, but is kept alive after returning (i.e. after RfcSendData). RFC_ITMODE_KEEPALIVE is for internal use only.

Syntax

public RFC_ITMODE = ( RFC_ITMODE_BYREFERENCE, RFC_ITMODE_BYVALUE, RFC_ITMODE_KEEPALIVE);

1.4.2.3.5 Record RFC_PARAMETER All Members


Name @field Name of the field (in the interface definition of the function).@field Name of the field (in the interface definition of the function).

nlen field Length of the Name (should be strlen(Name)).

_type @field Data type of the field. In former versions this field was simply defined as 'unsigned'.@field Data type of the field. In former versions this field was simply defined as 'unsigned'.

leng field Length of the field in Bytes.field Length of the field in Bytes.

addr @field Address of the field to be exported or imported.@field Address of the field to be exported or imported.

Unit


File

gsSAPxRFCBase

Description

Provides RFC parameters. It describes "Exporting" and "Importing" parameters of a function module.

• name - name of the field (in the interface definition of the function)

• nlen - length of the name (should be strlen(name))

• _type - data type of the field

• leng - length of the field in bytes

• addr - address of the field to be exported or imported

See also RFC_CHAR ( see page 38), RFC_NUM ( see page 41), RFC_BYTE ( see page 38), RFC_BCD ( see page37), RFC_INT ( see page 40), RFC_INT1 ( see page 41), RFC_INT2 ( see page 41), RFC_FLOAT ( see page 39),


25

1

RFC_DATE ( see page 39), RFC_TIME ( see page 44), RFCTYPE_STRUCTURE ( see page 83),RFCTYPE_XMLDATA ( see page 85), RFCTYPE_STRING ( see page 83) and RFCTYPE_XSTRING ( see page 85).

Syntax

public RFC_PARAMETER = record Name: IntPtr; nlen: LongWord; _type: RFC_TYPEHANDLE; leng: LongWord; addr: IntPtr;end;

1.4.2.3.6 Enumeration RFC_RC All Members


C_RFC_OK O.K.O.K.

C_RFC_FAILURE Error occurredError occurred

C_RFC_EXCEPTION Exception raisedException raised

C_RFC_SYS_EXCEPTION System exception raised, connection closedSystem exception raised, connection closed

C_RFC_CALL Call receivedCall received

C_RFC_INTERNAL_COM Internal communication, repeat (internal use only)Internal communication, repeat (internal use only)

C_RFC_CLOSED Connection closed by the other sideConnection closed by the other side

C_RFC_RETRY No data yet (RfcListen or RfcWaitForRequest only)

C_RFC_NO_TID No Transaction ID availableNo Transaction ID available

C_RFC_EXECUTED Function already executedFunction already executed

C_RFC_SYNCHRONIZE Synchronous Call in Progress (only for Windows)Synchronous Call in Progress (only for Windows)

C_RFC_MEMORY_INSUFFICIENT Memory insufficientMemory insufficient

C_RFC_VERSION_MISMATCH Version mismatchVersion mismatch

C_RFC_NOT_FOUND Function not found (internal use only)Function not found (internal use only)

C_RFC_CALL_NOT_SUPPORTED This call is not supported on WINDOWSThis call is not supported on WINDOWS

C_RFC_NOT_OWNER Caller does not own the specified HandleCaller does not own the specified Handle

C_RFC_NOT_INITIALIZED RFC not yet initializedRFC not yet initialized

C_RFC_SYSTEM_CALLED A system call such as RFC_PING for connectionA system call such as RFC_PING for connection

C_RFC_INVALID_HANDLE An invalid handle was passed to an API call

C_RFC_INVALID_PARAMETER An invalid parameter was passed to an API call or parameter length mismatch (expected and received) has been detected.


26

1

C_RFC_CANCELED An RFC call has been canceled by user

C_RFC_CONVERSION An error during conversion has been detected

C_RFC_INVALID_PROTOCOL The received data has an unsupported format. e.g.: non Unicode application receives data sent in Unicode format

Unit


File

gsSAPxRFCBase

Description

Enum type provides RFC return codes.

• RFC_OK - ok

• RFC_FAILURE - error occurred

• RFC_EXCEPTION - exception raised

• RFC_SYS_EXCEPTION - system exception raised, connection closed

• RFC_CALL - call received

• RFC_INTERNAL_COM - internal communication, repeat (internal use only)

• RFC_CLOSED - connection closed by the other side

• RFC_RETRY - no data yet (RfcListen only)

• RFC_NO_TID - no transaction-ID available

• RFC_EXECUTED - function already executed

• RFC_SYNCHRONIZE - synchronous call in progress (only for Windows)

• RFC_MEMORY_INSUFFICIENT - memory insufficient

• RFC_VERSION_MISMATCH - version mismatch

• RFC_NOT_FOUND - function not found (internal use only)

• RFC_CALL_NOT_SUPPORTED - call is not supported on Windows

Syntax

public RFC_RC = ( C_RFC_OK, C_RFC_FAILURE, C_RFC_EXCEPTION, C_RFC_SYS_EXCEPTION, C_RFC_CALL, C_RFC_INTERNAL_COM, C_RFC_CLOSED, C_RFC_RETRY, C_RFC_NO_TID, C_RFC_EXECUTED, C_RFC_SYNCHRONIZE, C_RFC_MEMORY_INSUFFICIENT, C_RFC_VERSION_MISMATCH, C_RFC_NOT_FOUND, C_RFC_CALL_NOT_SUPPORTED, C_RFC_NOT_OWNER, C_RFC_NOT_INITIALIZED, C_RFC_SYSTEM_CALLED, C_RFC_INVALID_HANDLE, C_RFC_INVALID_PARAMETER, C_RFC_CANCELED, C_RFC_CONVERSION,


27

1

C_RFC_INVALID_PROTOCOL, C_RFC_TIMEOUT);

1.4.2.3.7 Record RFC_TABLE All Members


Name Name of the table (in the interface definition of the function).

nlen Length of the Name (should be strlen(Name)).

_type Data type of the lines of the table. In former versions this field was simply defined as 'unsigned'.

leng Length of a row in bytes.

ithandle Table Handle , i.e. the address of the control structure of the internal table.

itmode Field describes how this table has to be received : 'call by reference' or 'call by value'. (only for RfcGetData, has no effect in RfcCall).

newitab If the value is not 0 after RfcGetData, the table was created by RfcGetData. Internal use only. This field must not be modified.

Unit


File

gsSAPxRFCBase

Description

Provides RFC tables. It describes tables parameters of the interface of a function module.

• name - name of the table (in the interface of the function)

• nlen - length of the name (should be strlen(name))

• _type - data type of the lines of the table

• leng - length of a row in bytes

• ithandle - table handle ITAB_H ( see page 31), i.e. the address of the control structure of the internal table. This is an input field at RfcCall ( see page 269) and an output field at RfcGetData ( see page 273).

• itmode - mode (RFC_ITMODE ( see page 24)). This table has to be received either by "call by reference" or by "call by value" (only for RfcGetData ( see page 273), has no effect in RfcCall ( see page 269)).

• newitab - If the value after RfcGetData ( see page 273) is not 0, the table was created by RfcGetData ( see page 273). This is for internal use only. This field must not be modified between RfcGetData ( see page 273) and RfcSendData ( see page 277).

Syntax

public RFC_TABLE = record Name: IntPtr; nlen: LongWord; _type: RFC_TYPEHANDLE; leng: LongWord; ithandle: ITAB_H; itmode: RFC_ITMODE; newitab: Integer;end;


28

1

1.4.2.3.8 Record RFC_TYPE_ELEMENT All Members


Name field Name of the field (only used for trace).field Name of the field (only used for trace).

_type field (scalar) data type of the element.field (scalar) data type of the element.

length field length of the field in bytes.field length of the field in bytes.

Decimals field Decimals (only bcd fields, TYPP ).

offset @field byte offset of the field from the beginning of the structure

Unit


File

gsSAPxRFCBase

Description

Describes an element of SAP RFC structure.

Syntax

public RFC_TYPE_ELEMENT = record Name: pRfc_char_t; _type: RFC_TYPEHANDLE; length: LongWord; Decimals: LongWord; offset: LongWord;end;

1.4.2.3.9 Record RFC_UNICODE_TYPE_ELEMENT Unit


File

gsSAPxRFCBase

Syntax

public RFC_UNICODE_TYPE_ELEMENT = record name: pRfc_char_t; _type: RFC_TYPEHANDLE; decimals: LongWord; c1_length: LongWord; c1_offset: Longword; c2_length: LongWord; c2_offset: Longword; c4_length: LongWord; c4_offset: Longword;end;

1.4.2.3.10 Record RFC_XSTRING Unit



29

1

File

gsSAPxRFCBase

Description

Binary string of variable length.

Syntax

public RFC_XSTRING = record length: RFC_INT; content: ^RFC_BYTE;end;

1.4.2.3.11 Record SAP_RFC_STATISTIC All Members


statistic field RFC statistic ON=0:OFF=1, if OFF no warranty for statistic data

data_rcv field present received data

dsum_rcv field number of received data for handle

sum_rcv field number of received data for function

data_snd field present sent data

sum_snd field number of sent data for function

dsum_snd field number of sent data for handle

sum_rexe field execution time at receiver for function

sum_exe field execution time at sender for function

sum_call field calling time for function call

dsum_call field calling time for handle

sum_wtime field overall writing time for function

dsum_wtime field overall writing time for handle

sum_rtime field overall reading time for function

dsum_rtime field overall reading time for handle

calls field number of calls

ip field my ip address

rip field remote ip address

dest field my destination id

rdest field remote destination id

progname field calling program

funcname field called function

userid field user id

rfc_caller field RFC caller (whoami)

rfc_cclient field caller client (sender)

start field start time&date&vers.

rfc_tid field Transaction ID

conversation_id field conversation id

Unit


File

gsSAPxRFCBase


30

1

Description

Returns statistical information from RFCStatistic ( see page 278) call.

Syntax

public SAP_RFC_STATISTIC = record statistic: LongWord; data_rcv: Double; dsum_rcv: Double; sum_rcv: Double; data_snd: Double; sum_snd: Double; dsum_snd: Double; sum_rexe: Double; sum_exe: Double; sum_call: Double; dsum_call: Double; sum_wtime: Double; dsum_wtime: Double; sum_rtime: Double; dsum_rtime: Double; calls: Double; ip: array [0..16-1] of rfc_char_t; rip: array [0..16-1] of rfc_char_t; dest: array [0..33-1] of rfc_char_t; rdest: array [0..33-1] of rfc_char_t; progname: array [0..128-1] of rfc_char_t; funcname: RFC_FUNCTIONNAMEArr; userid: array [0..13-1] of rfc_char_t; rfc_caller: array [0..13-1] of rfc_char_t; rfc_cclient: array [0..13-1] of rfc_char_t; start: array[0..48-1] of rfc_char_t; rfc_tid: RFC_TID; conversation_id: array [0..RFC_CONV_ID_LN-1] of RFC_BYTE;end;

1.4.2.4 Types

1.4.2.4.1 Type ITAB_H Unit


File

gsSAPxRFCBase

Syntax

ITAB_H = IntPtr;

1.4.2.4.2 Type PBoolean Unit


File

gsSAPxRFCBase

Syntax

PBoolean = ^Boolean;


31

1

1.4.2.4.3 Type ppRfc_char_t Unit


File

gsSAPxRFCBase

Syntax

ppRfc_char_t = ^pRfc_char_t;

1.4.2.4.4 Type pRFC_ATTRIBUTES Unit


File

gsSAPxRFCBase

Syntax

pRFC_ATTRIBUTES = ^RFC_ATTRIBUTES;

1.4.2.4.5 Type pRFC_BCD Unit


File

gsSAPxRFCBase

Syntax

pRFC_BCD = ^RFC_BCD;

1.4.2.4.6 Type pRFC_BYTE Unit


File

gsSAPxRFCBase

Syntax

pRFC_BYTE = ^RFC_BYTE;

1.4.2.4.7 Type pRFC_CHAR Unit


File

gsSAPxRFCBase

Syntax

pRFC_CHAR = ^RFC_CHAR;


32

1

1.4.2.4.8 Type pRfc_char_t Unit


File

gsSAPxRFCBase

Syntax

pRfc_char_t = PChar;

1.4.2.4.9 Type pRFC_DATE Unit


File

gsSAPxRFCBase

Syntax

pRFC_DATE = ^RFC_DATE;

1.4.2.4.10 Type pRFC_ENV Unit


File

gsSAPxRFCBase

Syntax

pRFC_ENV = ^RFC_ENV;

1.4.2.4.11 Type pRFC_ERROR_INFO_EX Unit


File

gsSAPxRFCBase

Syntax

pRFC_ERROR_INFO_EX = ^RFC_ERROR_INFO_EX;

1.4.2.4.12 Type pRFC_FLOAT Unit


File

gsSAPxRFCBase

Syntax

pRFC_FLOAT = ^RFC_FLOAT;


33

1

1.4.2.4.13 Type pRFC_INT Unit


File

gsSAPxRFCBase

Syntax

pRFC_INT = ^RFC_INT;

1.4.2.4.14 Type pRFC_INT1 Unit


File

gsSAPxRFCBase

Syntax

pRFC_INT1 = ^RFC_INT1;

1.4.2.4.15 Type pRFC_INT2 Unit


File

gsSAPxRFCBase

Syntax

pRFC_INT2 = ^RFC_INT2;

1.4.2.4.16 Type pRFC_IUNKNOWN Unit


File

gsSAPxRFCBase

Syntax

pRFC_IUNKNOWN = ^RFC_IUNKNOWN;

1.4.2.4.17 Type pRFC_NUM Unit


File

gsSAPxRFCBase

Syntax

pRFC_NUM = ^RFC_NUM;


34

1

1.4.2.4.18 Type pRFC_PARAMETER Unit


File

gsSAPxRFCBase

Syntax

pRFC_PARAMETER = ^RFC_PARAMETER;

1.4.2.4.19 Type pRFC_STRING Unit


File

gsSAPxRFCBase

Syntax

pRFC_STRING = ^RFC_STRING;

1.4.2.4.20 Type pRFC_STRUCT_TYPE_ID Unit


File

gsSAPxRFCBase

Syntax

pRFC_STRUCT_TYPE_ID = IntPtr;

1.4.2.4.21 Type pRFC_TABLE Unit


File

gsSAPxRFCBase

Syntax

pRFC_TABLE = ^RFC_TABLE;

1.4.2.4.22 Type pRFC_TIME Unit


File

gsSAPxRFCBase

Syntax

pRFC_TIME = ^RFC_TIME;


35

1

1.4.2.4.23 Type pRFC_TYPE_ELEMENT Unit


File

gsSAPxRFCBase

Syntax

pRFC_TYPE_ELEMENT = ^RFC_TYPE_ELEMENT;

1.4.2.4.24 Type pRFC_UNICODE Unit


File

gsSAPxRFCBase

Syntax

pRFC_UNICODE = ^RFC_UNICODE;

1.4.2.4.25 Type pRFC_UNICODE_TYPE_ELEMENT Unit


File

gsSAPxRFCBase

Syntax

pRFC_UNICODE_TYPE_ELEMENT = ^RFC_UNICODE_TYPE_ELEMENT;

1.4.2.4.26 Type pRFC_WCHAR Unit


File

gsSAPxRFCBase

Syntax

pRFC_WCHAR = ^RFC_WCHAR;

1.4.2.4.27 Type pRFC_WSTRING Unit


File

gsSAPxRFCBase

Syntax

pRFC_WSTRING = ^RFC_WSTRING;


36

1

1.4.2.4.28 Type pRFC_XMLDATA Unit


File

gsSAPxRFCBase

Syntax

pRFC_XMLDATA = ^RFC_XMLDATA;

1.4.2.4.29 Type pRFC_XSTRING Unit


File

gsSAPxRFCBase

Syntax

pRFC_XSTRING = ^RFC_XSTRING;

1.4.2.4.30 Type pSAP_RFC_STATISTIC Unit


File

gsSAPxRFCBase

Syntax

pSAP_RFC_STATISTIC = ^SAP_RFC_STATISTIC;

1.4.2.4.31 Type RFC_ALLOCATE Unit


File

gsSAPxRFCBase

Syntax

RFC_ALLOCATE = function (old_ptr: IntPtr; size: LongWord): IntPtr;

1.4.2.4.32 Type RFC_BCD Unit


File

gsSAPxRFCBase

Description

ABAP data type P, packed number in BCD (Binary Coded Decimal) format.


37

1

Syntax

RFC_BCD = array [0..31] of rfc_byte_t;

1.4.2.4.33 Type RFC_BYTE Unit


File

gsSAPxRFCBase

Description

ABAP data type X, raw data.

Syntax

RFC_BYTE = rfc_byte_t;

1.4.2.4.34 Type rfc_byte_t Unit


File

gsSAPxRFCBase

Syntax

rfc_byte_t = Byte;

1.4.2.4.35 Type RFC_CANCEL_TYPE Unit


File

gsSAPxRFCBase

Syntax

RFC_CANCEL_TYPE = Integer;

1.4.2.4.36 Type RFC_CHAR Unit


File

gsSAPxRFCBase

Description

ABAP data type C, blank padded character string of fixed length.

Syntax

RFC_CHAR = rfc_char_t;


38

1

1.4.2.4.37 Type rfc_char_t Unit


File

gsSAPxRFCBase

Syntax

rfc_char_t = Char;

1.4.2.4.38 Type RFC_DATE Unit


File

gsSAPxRFCBase

Description

ABAP data type D, eight-byte date (YYYYMMDD).

Syntax

RFC_DATE = array [0..8-1] of RFC_CHAR;

1.4.2.4.39 Type RFC_ERROR_GROUP Unit


File

gsSAPxRFCBase

Syntax

RFC_ERROR_GROUP = TSAPxRFCEnumGS;

1.4.2.4.40 Type RFC_ERROR_HANDLER Unit


File

gsSAPxRFCBase

Syntax

RFC_ERROR_HANDLER = procedure (error_id: pRfc_char_t);

1.4.2.4.41 Type RFC_FLOAT Unit


File

gsSAPxRFCBase


39

1

Description

ABAP data type F, eight-byte IEEE floating point number.

Syntax

RFC_FLOAT = Double;

1.4.2.4.42 Type RFC_FUNCTIONNAME Unit


File

gsSAPxRFCBase

Syntax

RFC_FUNCTIONNAME = pRfc_char_t;

1.4.2.4.43 Type RFC_FUNCTIONNAMEArr Unit


File

gsSAPxRFCBase

Syntax

RFC_FUNCTIONNAMEArr = array [0 .. RFC_FUNCTIONNAME_LN - 1] of rfc_char_t;

1.4.2.4.44 Type RFC_HANDLE Unit


File

gsSAPxRFCBase

Syntax

RFC_HANDLE = LongWord;

1.4.2.4.45 Type RFC_INT Unit


File

gsSAPxRFCBase

Description

ABAP data type I, four-byte signed integer.

Syntax

RFC_INT = Integer;


40

1

1.4.2.4.46 Type RFC_INT1 Unit


File

gsSAPxRFCBase

Description

Data Dictionary data type INT1, one-byte unsigned integer.

Syntax

RFC_INT1 = rfc_byte_t;

1.4.2.4.47 Type RFC_INT2 Unit


File

gsSAPxRFCBase

Description

Data Dictionary data type INT2, two-byte signed integer.

Syntax

RFC_INT2 = SmallInt;

1.4.2.4.48 Type RFC_IUNKNOWN Unit


File

gsSAPxRFCBase

Description

IUnknown, COM object

Syntax

RFC_IUNKNOWN = IUnknown;

1.4.2.4.49 Type RFC_NUM Unit


File

gsSAPxRFCBase

Description

ABAP data type N, character string of fixed length containing only digits.

Syntax

RFC_NUM = RFC_CHAR;


41

1

1.4.2.4.50 Type RFC_ON_CHECK_TID Unit


File

gsSAPxRFCBase

Syntax

RFC_ON_CHECK_TID = function (TID: RFC_TID): Integer;

1.4.2.4.51 Type RFC_ON_CHECK_TID_EX Unit


File

gsSAPxRFCBase

Syntax

RFC_ON_CHECK_TID_EX = function (TID: RFC_TID; Handle: RFC_HANDLE): Integer;

1.4.2.4.52 Type RFC_ON_COMMIT Unit


File

gsSAPxRFCBase

Syntax

RFC_ON_COMMIT = procedure (TID: RFC_TID);

1.4.2.4.53 Type RFC_ON_COMMIT_EX Unit


File

gsSAPxRFCBase

Syntax

RFC_ON_COMMIT_EX = procedure (TID: RFC_TID; Handle: RFC_HANDLE);

1.4.2.4.54 Type RFC_ON_CONFIRM_TID Unit


File

gsSAPxRFCBase

Syntax

RFC_ON_CONFIRM_TID = procedure (TID: RFC_TID);


42

1

1.4.2.4.55 Type RFC_ON_CONFIRM_TID_EX Unit


File

gsSAPxRFCBase

Syntax

RFC_ON_CONFIRM_TID_EX = procedure (TID: RFC_TID; Handle: RFC_HANDLE);

1.4.2.4.56 Type RFC_ON_ROLLBACK Unit


File

gsSAPxRFCBase

Syntax

RFC_ON_ROLLBACK = procedure (TID: RFC_TID);

1.4.2.4.57 Type RFC_ON_ROLLBACK_EX Unit


File

gsSAPxRFCBase

Syntax

RFC_ON_ROLLBACK_EX = procedure (TID: RFC_TID; Handle: RFC_HANDLE);

1.4.2.4.58 Type RFC_ONCALL Unit


File

gsSAPxRFCBase

Syntax

RFC_ONCALL = function (Handle: RFC_HANDLE): RFC_RC;

1.4.2.4.59 Type RFC_STRING Unit


File

gsSAPxRFCBase

Description

zero terminated string in UTF8-Format


43

1

Syntax

RFC_STRING = ^SAP_UTF8;

1.4.2.4.60 Type RFC_STRUCT_TYPE_ID Unit


File

gsSAPxRFCBase

Syntax

RFC_STRUCT_TYPE_ID = array [0 .. 16-1] of Byte;

1.4.2.4.61 Type RFC_TID Unit


File

gsSAPxRFCBase

Syntax

RFC_TID = pRfc_char_t;

1.4.2.4.62 Type RFC_TIDArr Unit


File

gsSAPxRFCBase

Syntax

RFC_TIDArr = array [0..RFC_TID_LN] of rfc_char_t;

1.4.2.4.63 Type RFC_TIME Unit


File

gsSAPxRFCBase

Description

ABAP data type T, six-byte time (HHMMSS).

Syntax

RFC_TIME = array [0..6-1] of RFC_CHAR;

1.4.2.4.64 Type RFC_TYPEHANDLE Unit



44

1

File

gsSAPxRFCBase

Syntax

RFC_TYPEHANDLE = RFC_HANDLE;

1.4.2.4.65 Type RFC_UNICODE Unit


File

gsSAPxRFCBase

Description

characters, TYPC in Unicode environment

Syntax

RFC_UNICODE = rfc_unicode_t;

1.4.2.4.66 Type rfc_unicode_t Unit


File

gsSAPxRFCBase

Syntax

rfc_unicode_t = Word;

1.4.2.4.67 Type RFC_WCHAR Unit


File

gsSAPxRFCBase

Description

wchar_t

Syntax

RFC_WCHAR = WideChar;

1.4.2.4.68 Type RFC_WSTRING Unit


File

gsSAPxRFCBase

Description

wchar_t, zero terminated


45

1

Syntax

RFC_WSTRING = PWideChar;

1.4.2.4.69 Type RFC_XMLDATA Unit


File

gsSAPxRFCBase

Description

ABAP structs encoded as XML Document

Syntax

RFC_XMLDATA = ^SAP_UTF8;

1.4.2.4.70 Type RFCTYPE Unit


File

gsSAPxRFCBase

Syntax

RFCTYPE = TSAPxRFCEnumGS;

1.4.2.4.71 Type SAP_UTF8 Unit


File

gsSAPxRFCBase

Syntax

SAP_UTF8 = Byte;

1.4.2.4.72 Type TSAPxRFCAbortGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCAbortGS = procedure (Handle: RFC_HANDLE; text: pRfc_char_t);

1.4.2.4.73 Type TSAPxRFCAcceptGS Unit



46

1

File

gsSAPxRFCBase

Syntax

TSAPxRFCAcceptGS = function (Argv: ppRfc_char_t): RFC_HANDLE;

1.4.2.4.74 Type TSAPxRFCAllocStringGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCAllocStringGS = function (size: LongWord): RFC_STRING;

1.4.2.4.75 Type TSAPxRfcAllowStartProgram Unit


File

gsSAPxRFCBase

Syntax

TSAPxRfcAllowStartProgram = function (pname_list: pRfc_char_t): RFC_RC;

1.4.2.4.76 Type TSAPxRFCCallGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCCallGS = function (Handle: RFC_HANDLE; _function: pRfc_char_t; Parameters: pRFC_PARAMETER; Tables: pRFC_TABLE): RFC_RC;

1.4.2.4.77 Type TSAPxRFCCallReceiveGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCCallReceiveGS = function (Handle: RFC_HANDLE; _function: pRfc_char_t; exporting, importing: pRFC_PARAMETER; Tables: pRFC_TABLE; var exception: pRfc_char_t): RFC_RC;

1.4.2.4.78 Type TSAPxRFCCancelGS Unit



47

1

File

gsSAPxRFCBase

Syntax

TSAPxRFCCancelGS = function (Handle: RFC_HANDLE; cancel_type: RFC_CANCEL_TYPE): RFC_RC;

1.4.2.4.79 Type TSAPxRFCCloseGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCCloseGS = procedure (Handle: RFC_HANDLE);

1.4.2.4.80 Type TSAPxRFCConfirmTransIDGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCConfirmTransIDGS = function (Handle: RFC_HANDLE; TID: RFC_TID): RFC_RC;

1.4.2.4.81 Type TSAPxRFCConvertBCDToCharGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCConvertBCDToCharGS = function (_in: pRFC_BCD; in_len: Integer; decs: Integer; _out: PChar; out_len: Integer): Integer;

1.4.2.4.82 Type TSAPxRFCConvertCharToBCDGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCConvertCharToBCDGS = function (_in: PChar; in_len: Integer; var pdecs: Integer; var _out: RFC_BCD; out_len: Integer): Integer;

1.4.2.4.83 Type TSAPxRFCCreateTransIDGS Unit



48

1

File

gsSAPxRFCBase

Syntax

TSAPxRFCCreateTransIDGS = function (Handle: RFC_HANDLE; TID: RFC_TID): RFC_RC;

1.4.2.4.84 Type TSAPxRFCDispatchGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCDispatchGS = function (Handle: RFC_HANDLE): RFC_RC;

1.4.2.4.85 Type TSAPxRFCEnumGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCEnumGS = LongWord;

1.4.2.4.86 Type TSAPxRFCEnvironment_prcGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCEnvironment_prcGS = procedure (var new_env: RFC_ENV);

1.4.2.4.87 Type TSAPxRfcExidToRfcTypeGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRfcExidToRfcTypeGS = function (Exid: RFC_CHAR; var pType: RFCTYPE): RFC_RC;

1.4.2.4.88 Type TSAPxRFCFreeStringGS Unit



49

1

File

gsSAPxRFCBase

Syntax

TSAPxRFCFreeStringGS = procedure (_string: RFC_STRING);

1.4.2.4.89 Type TSAPxRFCGetAttributesGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCGetAttributesGS = function (Handle: RFC_HANDLE; var Attributes: RFC_ATTRIBUTES): Integer;

1.4.2.4.90 Type TSAPxRFCGetDataGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCGetDataGS = function (Handle: RFC_HANDLE; Parameters: pRFC_PARAMETER; Tables: pRFC_TABLE): RFC_RC;

1.4.2.4.91 Type TSAPxRFCGetNameGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCGetNameGS = function (Handle: RFC_HANDLE; functionname: RFC_FUNCTIONNAME): RFC_RC;

1.4.2.4.92 Type TSAPxRFCIndirectCallExGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCIndirectCallExGS = function (Handle: RFC_HANDLE; _function: pRfc_char_t; Parameters: pRFC_PARAMETER; Tables: pRFC_TABLE; TID: RFC_TID): RFC_RC;


50

1

1.4.2.4.93 Type TSAPxRFCInstallFunctionExtGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCInstallFunctionExtGS = function (Handle: RFC_HANDLE; functionname: RFC_FUNCTIONNAME; f_ptr: RFC_ONCALL; Docu: pRfc_char_t): RFC_RC;

1.4.2.4.94 Type TSAPxRFCInstallFunctionGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCInstallFunctionGS = function (functionname: RFC_FUNCTIONNAME; f_ptr: RFC_ONCALL; Docu: pRfc_char_t): RFC_RC;

1.4.2.4.95 Type TSAPxRFCInstallStructureGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCInstallStructureGS = function (Name: pRfc_char_t; Elements: pRFC_TYPE_ELEMENT; entries: LongWord; var pTypeHandle: RFC_TYPEHANDLE): RFC_RC;

1.4.2.4.96 Type TSAPxRFCInstallTransactionControl2GS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCInstallTransactionControl2GS = function (f_check_ptr: RFC_ON_CHECK_TID_EX; f_commit_ptr: RFC_ON_COMMIT_EX; f_rollback_ptr: RFC_ON_ROLLBACK_EX; f_confirm_ptr: RFC_ON_CONFIRM_TID_EX): RFC_RC;

1.4.2.4.97 Type TSAPxRFCInstallTransactionControlGS Unit


File

gsSAPxRFCBase


51

1

Syntax

TSAPxRFCInstallTransactionControlGS = function (f_check_ptr: RFC_ON_CHECK_TID; f_commit_ptr: RFC_ON_COMMIT; f_rollback_ptr: RFC_ON_ROLLBACK; f_confirm_ptr: RFC_ON_CONFIRM_TID): RFC_RC;

1.4.2.4.98 Type TSAPxRFCitAppLineGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCitAppLineGS = function (itab: ITAB_H): IntPtr;

1.4.2.4.99 Type TSAPxRFCitCpyLineGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCitCpyLineGS = function (itab: ITAB_H; Line: LongWord; Dest: IntPtr): Integer;

1.4.2.4.100 Type TSAPxRFCitCreateGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCitCreateGS = function (Name: pRfc_char_t; leng: LongWord; occu: LongWord; memo: LongWord): ITAB_H;

1.4.2.4.101 Type TSAPxRFCitDeleteGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCitDeleteGS = function (itab: ITAB_H): Integer;

1.4.2.4.102 Type TSAPxRFCitDelLineGS Unit



52

1

File

gsSAPxRFCBase

Syntax

TSAPxRFCitDelLineGS = function (itab: ITAB_H; Line: LongWord): Integer;

1.4.2.4.103 Type TSAPxRFCitFillGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCitFillGS = function (itab: ITAB_H): LongWord;

1.4.2.4.104 Type TSAPxRFCitFreeGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCitFreeGS = function (itab: ITAB_H): Integer;

1.4.2.4.105 Type TSAPxRFCitGetLineGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCitGetLineGS = function (itab: ITAB_H; Line: LongWord): IntPtr;

1.4.2.4.106 Type TSAPxRFCitGupLineGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCitGupLineGS = function (itab: ITAB_H; Line: LongWord): IntPtr;

1.4.2.4.107 Type TSAPxRFCitInsLineGS Unit



53

1

File

gsSAPxRFCBase

Syntax

TSAPxRFCitInsLineGS = function (itab: ITAB_H; Line: LongWord): IntPtr;

1.4.2.4.108 Type TSAPxRFCitLengGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCitLengGS = function (itab: ITAB_H): LongWord;

1.4.2.4.109 Type TSAPxRFCitPutLineGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCitPutLineGS = function (itab: ITAB_H; Line: LongWord; src: IntPtr): Integer;

1.4.2.4.110 Type TSAPxRFCLastErrorExGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCLastErrorExGS = function (var error_info: RFC_ERROR_INFO_EX): Integer;

1.4.2.4.111 Type TSAPxRFCListenGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCListenGS = function (Handle: RFC_HANDLE): RFC_RC;

1.4.2.4.112 Type TSAPxRFCOpenExGS Unit



54

1

File

gsSAPxRFCBase

Syntax

TSAPxRFCOpenExGS = function (connect_param: pRfc_char_t; var error_info: RFC_ERROR_INFO_EX): RFC_HANDLE;

1.4.2.4.113 Type TSAPxRFCRaiseGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCRaiseGS = function (Handle: RFC_HANDLE; exception: pRfc_char_t): RFC_RC;

1.4.2.4.114 Type TSAPxRFCRaiseTablesGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCRaiseTablesGS = function (Handle: RFC_HANDLE; exception: pRfc_char_t; Tables: pRFC_TABLE): RFC_RC;

1.4.2.4.115 Type TSAPxRFCReceiveGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCReceiveGS = function (Handle: RFC_HANDLE; Parameters: pRFC_PARAMETER; Tables: pRFC_TABLE; var exception: pRfc_char_t): RFC_RC;

1.4.2.4.116 Type TSAPxRFCResizeXStringGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCResizeXStringGS = function (var xstring: RFC_XSTRING; length: RFC_INT): RFC_RC;


55

1

1.4.2.4.117 Type TSAPxRFCSendDataGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCSendDataGS = function (Handle: RFC_HANDLE; Parameters: pRFC_PARAMETER; Tables: pRFC_TABLE): RFC_RC;

1.4.2.4.118 Type TSAPxRFCStatisticGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCStatisticGS = function (Handle: RFC_HANDLE; var statistic: SAP_RFC_STATISTIC): RFC_RC;

1.4.2.4.119 Type TSAPxRFCTraceProcGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCTraceProcGS = procedure (const AClassName, AMsg: String);

1.4.2.4.120 Type TSAPxRFCUninstallFunctionGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCUninstallFunctionGS = function (functionname: RFC_FUNCTIONNAME): RFC_RC;

1.4.2.4.121 Type TSAPxRFCWaitForRequestGS Unit


File

gsSAPxRFCBase

Syntax

TSAPxRFCWaitForRequestGS = function (Handle: RFC_HANDLE; wtime: RFC_INT): RFC_RC;


56

1

1.4.2.5 Variables

1.4.2.5.1 Variable _RFCTYPE_max_value Unit


File

gsSAPxRFCBase

Syntax

_RFCTYPE_max_value: RFC_TYPEHANDLE;

1.4.2.5.2 Variable FSAPxRFCDllFileName Unit


File

gsSAPxRFCBase

Description

FSAPxRFCDllFileName is a global variable which determines file name of SAP RFC API library to be loaded. By default it isequal to librfc32.dll. The library will be found in one of the directories listed by the PATH environment variable.

Syntax

FSAPxRFCDllFileName: String;

1.4.2.5.3 Variable FSAPxRFCEnableUnload Unit


File

gsSAPxRFCBase

Description

FSAPxRFCEnableUnload is a global variable, which enables (True) / disables (False) explicit SAP RFC API libraryunloading by calling SAPxRFCUnLoadLib ( see page 21). By default it is False. This is due to the issue in SAP RFC APIlibrary v 7.2 leading to immediate AV after unloading library.

Syntax

FSAPxRFCEnableUnload: Boolean;

1.4.2.5.4 Variable FSAPxRFChDll Unit


File

gsSAPxRFCBase

Description

FSAPxRFChDll is a global variable which provides access to the handle of the SAP RFC API library.


57

1

Syntax

FSAPxRFChDll: HMODULE;

1.4.2.5.5 Variable FSAPxRFCInitialized Unit


File

gsSAPxRFCBase

Description

FSAPxRFCInitialized is a global variable which indicates whether the SAP RFC API library is loaded by callingSAPxRFCLoadLib ( see page 21).

Syntax

FSAPxRFCInitialized: Boolean;

1.4.2.5.6 Variable FSAPxRFCLibVersion Unit


File

gsSAPxRFCBase

Description

FSAPxRFCLibVersion is a global variable which indicates version of the SAP client library - librfc32u.dll (or librfc32.dll).

You can use one of following constants to detect version:

C_SAPxRFC_V46 ( see page 72), C_SAPxRFC_V60 ( see page 72), C_SAPxRFC_V61 ( see page 72),C_SAPxRFC_V62 ( see page 72), C_SAPxRFC_V64 ( see page 73), C_SAPxRFC_V70 ( see page 73),C_SAPxRFC_V71 ( see page 73) and C_SAPxRFC_V72 ( see page 73).

Syntax

FSAPxRFCLibVersion: Integer;

1.4.2.5.7 Variable FSAPxRFCLock Unit


File

gsSAPxRFCBase

Syntax

FSAPxRFCLock: TRTLCriticalSection;

1.4.2.5.8 Variable FSAPxRFCTraceProc Unit


File

gsSAPxRFCBase


58

1

Syntax

FSAPxRFCTraceProc: TSAPxRFCTraceProcGS;

1.4.2.5.9 Variable itAppLine Unit


File

gsSAPxRFCBase

Syntax

itAppLine: TSAPxRFCitAppLineGS;

1.4.2.5.10 Variable itCpyLine Unit


File

gsSAPxRFCBase

Syntax

itCpyLine: TSAPxRFCitCpyLineGS;

1.4.2.5.11 Variable itCreate Unit


File

gsSAPxRFCBase

Syntax

itCreate: TSAPxRFCitCreateGS;

1.4.2.5.12 Variable itDelete Unit


File

gsSAPxRFCBase

Syntax

itDelete: TSAPxRFCitDeleteGS;

1.4.2.5.13 Variable itDelLine Unit


File

gsSAPxRFCBase


59

1

Syntax

itDelLine: TSAPxRFCitDelLineGS;

1.4.2.5.14 Variable itFill Unit


File

gsSAPxRFCBase

Syntax

itFill: TSAPxRFCitFillGS;

1.4.2.5.15 Variable itFree Unit


File

gsSAPxRFCBase

Syntax

itFree: TSAPxRFCitFreeGS;

1.4.2.5.16 Variable itGetLine Unit


File

gsSAPxRFCBase

Syntax

itGetLine: TSAPxRFCitGetLineGS;

1.4.2.5.17 Variable itGupLine Unit


File

gsSAPxRFCBase

Syntax

itGupLine: TSAPxRFCitGupLineGS;

1.4.2.5.18 Variable itInsLine Unit


File

gsSAPxRFCBase


60

1

Syntax

itInsLine: TSAPxRFCitInsLineGS;

1.4.2.5.19 Variable itLeng Unit


File

gsSAPxRFCBase

Syntax

itLeng: TSAPxRFCitLengGS;

1.4.2.5.20 Variable itPutLine Unit


File

gsSAPxRFCBase

Syntax

itPutLine: TSAPxRFCitPutLineGS;

1.4.2.5.21 Variable RfcAbort Unit


File

gsSAPxRFCBase

Syntax

RfcAbort: TSAPxRFCAbortGS;

1.4.2.5.22 Variable RfcAccept Unit


File

gsSAPxRFCBase

Syntax

RfcAccept: TSAPxRFCAcceptGS;

1.4.2.5.23 Variable RfcAllocString Unit


File

gsSAPxRFCBase


61

1

Syntax

RfcAllocString: TSAPxRFCAllocStringGS;

1.4.2.5.24 Variable RfcAllowStartProgram Unit


File

gsSAPxRFCBase

Syntax

RfcAllowStartProgram: TSAPxRfcAllowStartProgram;

1.4.2.5.25 Variable RfcCall Unit


File

gsSAPxRFCBase

Syntax

RfcCall: TSAPxRFCCallGS;

1.4.2.5.26 Variable RfcCallReceive Unit


File

gsSAPxRFCBase

Syntax

RfcCallReceive: TSAPxRFCCallReceiveGS;

1.4.2.5.27 Variable RfcCancel Unit


File

gsSAPxRFCBase

Syntax

RfcCancel: TSAPxRFCCancelGS;

1.4.2.5.28 Variable RfcClose Unit


File

gsSAPxRFCBase


62

1

Syntax

RfcClose: TSAPxRFCCloseGS;

1.4.2.5.29 Variable RfcConfirmTransID Unit


File

gsSAPxRFCBase

Syntax

RfcConfirmTransID: TSAPxRFCConfirmTransIDGS;

1.4.2.5.30 Variable RfcConvertBCDToChar Unit


File

gsSAPxRFCBase

Syntax

RfcConvertBCDToChar: TSAPxRFCConvertBCDToCharGS;

1.4.2.5.31 Variable RfcConvertCharToBCD Unit


File

gsSAPxRFCBase

Syntax

RfcConvertCharToBCD: TSAPxRFCConvertCharToBCDGS;

1.4.2.5.32 Variable RfcCreateTransID Unit


File

gsSAPxRFCBase

Syntax

RfcCreateTransID: TSAPxRFCCreateTransIDGS;

1.4.2.5.33 Variable RfcDispatch Unit


File

gsSAPxRFCBase


63

1

Syntax

RfcDispatch: TSAPxRFCDispatchGS;

1.4.2.5.34 Variable RfcEnvironment Unit


File

gsSAPxRFCBase

Syntax

RfcEnvironment: TSAPxRFCEnvironment_prcGS;

1.4.2.5.35 Variable RfcExidToRfcType Unit


File

gsSAPxRFCBase

Syntax

RfcExidToRfcType: TSAPxRfcExidToRfcTypeGS;

1.4.2.5.36 Variable RfcFreeString Unit


File

gsSAPxRFCBase

Syntax

RfcFreeString: TSAPxRFCFreeStringGS;

1.4.2.5.37 Variable RfcGetAttributes Unit


File

gsSAPxRFCBase

Syntax

RfcGetAttributes: TSAPxRFCGetAttributesGS;

1.4.2.5.38 Variable RfcGetData Unit


File

gsSAPxRFCBase


64

1

Syntax

RfcGetData: TSAPxRFCGetDataGS;

1.4.2.5.39 Variable RfcGetName Unit


File

gsSAPxRFCBase

Syntax

RfcGetName: TSAPxRFCGetNameGS;

1.4.2.5.40 Variable RfcIndirectCallEx Unit


File

gsSAPxRFCBase

Syntax

RfcIndirectCallEx: TSAPxRFCIndirectCallExGS;

1.4.2.5.41 Variable RfcInstallFunction Unit


File

gsSAPxRFCBase

Syntax

RfcInstallFunction: TSAPxRFCInstallFunctionGS;

1.4.2.5.42 Variable RfcInstallFunctionExt Unit


File

gsSAPxRFCBase

Syntax

RfcInstallFunctionExt: TSAPxRFCInstallFunctionExtGS;

1.4.2.5.43 Variable RfcInstallStructure Unit


File

gsSAPxRFCBase


65

1

Syntax

RfcInstallStructure: TSAPxRFCInstallStructureGS;

1.4.2.5.44 Variable RfcInstallTransactionControl Unit


File

gsSAPxRFCBase

Syntax

RfcInstallTransactionControl: TSAPxRFCInstallTransactionControlGS;

1.4.2.5.45 Variable RfcInstallTransactionControl2 Unit


File

gsSAPxRFCBase

Syntax

RfcInstallTransactionControl2: TSAPxRFCInstallTransactionControl2GS;

1.4.2.5.46 Variable RfcLastErrorEx Unit


File

gsSAPxRFCBase

Syntax

RfcLastErrorEx: TSAPxRFCLastErrorExGS;

1.4.2.5.47 Variable RfcListen Unit


File

gsSAPxRFCBase

Syntax

RfcListen: TSAPxRFCListenGS;

1.4.2.5.48 Variable RfcOpenEx Unit


File

gsSAPxRFCBase


66

1

Syntax

RfcOpenEx: TSAPxRFCOpenExGS;

1.4.2.5.49 Variable RfcRaise Unit


File

gsSAPxRFCBase

Syntax

RfcRaise: TSAPxRFCRaiseGS;

1.4.2.5.50 Variable RfcRaiseTables Unit


File

gsSAPxRFCBase

Syntax

RfcRaiseTables: TSAPxRFCRaiseTablesGS;

1.4.2.5.51 Variable RfcReceive Unit


File

gsSAPxRFCBase

Syntax

RfcReceive: TSAPxRFCReceiveGS;

1.4.2.5.52 Variable RfcResizeXString Unit


File

gsSAPxRFCBase

Syntax

RfcResizeXString: TSAPxRFCResizeXStringGS;

1.4.2.5.53 Variable RfcSendData Unit


File

gsSAPxRFCBase


67

1

Syntax

RfcSendData: TSAPxRFCSendDataGS;

1.4.2.5.54 Variable RfcStatistic Unit


File

gsSAPxRFCBase

Syntax

RfcStatistic: TSAPxRFCStatisticGS;

1.4.2.5.55 Variable RfcUninstallFunction Unit


File

gsSAPxRFCBase

Syntax

RfcUninstallFunction: TSAPxRFCUninstallFunctionGS;

1.4.2.5.56 Variable RfcWaitForRequest Unit


File

gsSAPxRFCBase

Syntax

RfcWaitForRequest: TSAPxRFCWaitForRequestGS;

1.4.2.6 Constants

1.4.2.6.1 Constant __RFCTYPE_max_value_v4 Unit


File

gsSAPxRFCBase

Description

The maximum value of RFCTYPEs for V4.

Syntax

__RFCTYPE_max_value_v4 = RFCTYPE_UNICODE + 1;


68

1

1.4.2.6.2 Constant __RFCTYPE_max_value_v6 Unit


File

gsSAPxRFCBase

Description

The maximum value of RFCTYPEs for V6.

Syntax

__RFCTYPE_max_value_v6 = RFCTYPE_XSTRING + 1;

1.4.2.6.3 Constant _RFCTYPE_differ_from_abap Unit


File

gsSAPxRFCBase

Description

Starting from here ABAP types and RFC types differ.

Syntax

_RFCTYPE_differ_from_abap = RFCTYPE_DATE_2 + 1;

1.4.2.6.4 Constant _RFCTYPE_illegal_wchar Unit


File

gsSAPxRFCBase

Description

Not allowed wide character type.

Syntax

_RFCTYPE_illegal_wchar = RFCTYPE_WIDE_4;

1.4.2.6.5 Constant _RFCTYPE_the_last_line_without_colon Unit


File

gsSAPxRFCBase

Syntax

_RFCTYPE_the_last_line_without_colon = _RFCTYPE_illegal_wchar + 1;


69

1

1.4.2.6.6 Constant C_RFC_ERROR_APPLICATION_EXCEPTION Unit


File

gsSAPxRFCBase

Syntax

C_RFC_ERROR_APPLICATION_EXCEPTION = 105;

1.4.2.6.7 Constant C_RFC_ERROR_BUSY Unit


File

gsSAPxRFCBase

Syntax

C_RFC_ERROR_BUSY = 110;

1.4.2.6.8 Constant C_RFC_ERROR_CANCELLED Unit


File

gsSAPxRFCBase

Syntax

C_RFC_ERROR_CANCELLED = 109;

1.4.2.6.9 Constant C_RFC_ERROR_COMMUNICATION Unit


File

gsSAPxRFCBase

Syntax

C_RFC_ERROR_COMMUNICATION = 102;

1.4.2.6.10 Constant C_RFC_ERROR_INTERNAL Unit


File

gsSAPxRFCBase

Syntax

C_RFC_ERROR_INTERNAL = 108;


70

1

1.4.2.6.11 Constant C_RFC_ERROR_LOGON_FAILURE Unit


File

gsSAPxRFCBase

Syntax

C_RFC_ERROR_LOGON_FAILURE = 103;

1.4.2.6.12 Constant C_RFC_ERROR_PROGRAM Unit


File

gsSAPxRFCBase

Syntax

C_RFC_ERROR_PROGRAM = 101;

1.4.2.6.13 Constant C_RFC_ERROR_PROTOCOL Unit


File

gsSAPxRFCBase

Syntax

C_RFC_ERROR_PROTOCOL = 107;

1.4.2.6.14 Constant C_RFC_ERROR_RESOURCE Unit


File

gsSAPxRFCBase

Syntax

C_RFC_ERROR_RESOURCE = 106;

1.4.2.6.15 Constant C_RFC_ERROR_SYSTEM_FAILURE Unit


File

gsSAPxRFCBase

Syntax

C_RFC_ERROR_SYSTEM_FAILURE = 104;


71

1

1.4.2.6.16 Constant C_SAPxRFC_V46 Unit


File

gsSAPxRFCBase

Description

Identifies SAP R/3 v 4.6 as value of FSAPxRFCLibVersion ( see page 58).

Syntax

C_SAPxRFC_V46 = 46;



File

gsSAPxRFCBase

Description


Syntax

C_SAPxRFC_V60 = 60;



File

gsSAPxRFCBase

Description


Syntax

C_SAPxRFC_V61 = 61;



File

gsSAPxRFCBase

Description


Syntax

C_SAPxRFC_V62 = 62;


72

1



File

gsSAPxRFCBase

Description


Syntax

C_SAPxRFC_V64 = 64;



File

gsSAPxRFCBase

Description


Syntax

C_SAPxRFC_V70 = 70;



File

gsSAPxRFCBase

Description


Syntax

C_SAPxRFC_V71 = 71;



File

gsSAPxRFCBase

Description


Syntax

C_SAPxRFC_V72 = 72;


73

1

1.4.2.6.24 Constant C_TRFC_CANCEL Unit


File

gsSAPxRFCBase

Syntax

C_TRFC_CANCEL = 1;

1.4.2.6.25 Constant C_TRFC_INTERNAL_ERROR Unit


File

gsSAPxRFCBase

Syntax

C_TRFC_INTERNAL_ERROR = -1;

1.4.2.6.26 Constant C_TRFC_OK Unit


File

gsSAPxRFCBase

Syntax

C_TRFC_OK = 0;

1.4.2.6.27 Constant ITAB_NULL Unit


File

gsSAPxRFCBase

Syntax

ITAB_NULL = nil;

1.4.2.6.28 Constant RFC_CANCEL_CLOSE Unit


File

gsSAPxRFCBase

Description

Break the already running RFC function on ABAP-Side, destroy user context on the ABAP-Side and close the RFCconnection.


74

1

Syntax

RFC_CANCEL_CLOSE = 2;

1.4.2.6.29 Constant RFC_CANCEL_HARD Unit


File

gsSAPxRFCBase

Description

Break the already running RFC function on ABAP-Side, destroy user context and keep RFCconnection open.

Syntax

RFC_CANCEL_HARD = 0;

1.4.2.6.30 Constant RFC_CANCEL_SOFT Unit


File

gsSAPxRFCBase

Description

Break the already running RFC function on ABAP-Side, try to hold user context on the ABAP-Side and keep RFC connectionopen.

Syntax

RFC_CANCEL_SOFT = 1;

1.4.2.6.31 Constant RFC_CONV_ID_LN Unit


File

gsSAPxRFCBase

Syntax

RFC_CONV_ID_LN = 8;

1.4.2.6.32 Constant RFC_FUNCTIONNAME_LN Unit


File

gsSAPxRFCBase

Syntax

RFC_FUNCTIONNAME_LN = 31;


75

1

1.4.2.6.33 Constant RFC_HANDLE_NULL Unit


File

gsSAPxRFCBase

Syntax

RFC_HANDLE_NULL = 0;

1.4.2.6.34 Constant RFC_ROLE_Client Unit


File

gsSAPxRFCBase

Syntax

RFC_ROLE_Client = 'C';

1.4.2.6.35 Constant RFC_ROLE_SERVER Unit


File

gsSAPxRFCBase

Syntax

RFC_ROLE_SERVER = 'S';

1.4.2.6.36 Constant RFC_SERVER_EXT Unit


File

gsSAPxRFCBase

Syntax

RFC_SERVER_EXT = 'E';

1.4.2.6.37 Constant RFC_SERVER_EXT_REG Unit


File

gsSAPxRFCBase

Syntax

RFC_SERVER_EXT_REG = 'R';


76

1

1.4.2.6.38 Constant RFC_SERVER_R2 Unit


File

gsSAPxRFCBase

Syntax

RFC_SERVER_R2 = '2';

1.4.2.6.39 Constant RFC_SERVER_R3 Unit


File

gsSAPxRFCBase

Syntax

RFC_SERVER_R3 = '3';

1.4.2.6.40 Constant RFC_STRING_MAX_LEN Unit


File

gsSAPxRFCBase

Syntax

RFC_STRING_MAX_LEN = 65535;

1.4.2.6.41 Constant RFC_TID_LN Unit


File

gsSAPxRFCBase

Syntax

RFC_TID_LN = 24;

1.4.2.6.42 Constant RFC_TRACE_OFF Unit


File

gsSAPxRFCBase

Syntax

RFC_TRACE_OFF = ' ';


77

1

1.4.2.6.43 Constant RFC_TRACE_ON Unit


File

gsSAPxRFCBase

Syntax

RFC_TRACE_ON = 'X';

1.4.2.6.44 Constant RFCTYPE_ABAP4OBJECT Unit


File

gsSAPxRFCBase

Description

Specifies an ABAP/4 object (internal use).

Syntax

RFCTYPE_ABAP4OBJECT = RFCTYPE_STRUCTURE + 1;

1.4.2.6.45 Constant RFCTYPE_BCD Unit


File

gsSAPxRFCBase

Description

Specifies BCD number, any length between 1 and 16 bytes.

Syntax

RFCTYPE_BCD = 2;

1.4.2.6.46 Constant RFCTYPE_BLOB Unit


File

gsSAPxRFCBase

Description

Specifies a binary large object, address must point to a structure.

Syntax

RFCTYPE_BLOB = RFCTYPE_WIRE_OBJECT + 1;


78

1

1.4.2.6.47 Constant RFCTYPE_BYTE Unit


File

gsSAPxRFCBase

Description

Specifies raw data, binary, fixed length, zero padded.

Syntax

RFCTYPE_BYTE = 4;

1.4.2.6.48 Constant RFCTYPE_CHAR Unit


File

gsSAPxRFCBase

Description

Specifies 1-byte or multi byte character, fixed sized, blank padded.

Syntax

RFCTYPE_CHAR = 0;

1.4.2.6.49 Constant RFCTYPE_CORBA_OBJECT Unit


File

gsSAPxRFCBase

Description

Specifies a Corba object (internal use).

Syntax

RFCTYPE_CORBA_OBJECT = RFCTYPE_BLOB + 1;

1.4.2.6.50 Constant RFCTYPE_DATE Unit


File

gsSAPxRFCBase

Description

Specifies RFC data type DATE with format YYYYMMDD.

Syntax

RFCTYPE_DATE = 1;


79

1

1.4.2.6.51 Constant RFCTYPE_DATE_1 Unit


File

gsSAPxRFCBase

Description

Specifies old fashioned date, obsolete and not directly supported by ABAP/4.

Syntax

RFCTYPE_DATE_1 = 12;

1.4.2.6.52 Constant RFCTYPE_DATE_2 Unit


File

gsSAPxRFCBase

Description

Specifies old fashioned date, obsolete and not directly supported by ABAP/4.

Syntax

RFCTYPE_DATE_2 = 13;

1.4.2.6.53 Constant RFCTYPE_FLOAT Unit


File

gsSAPxRFCBase

Description

Specifies floating point with double precision and binary representation.

Syntax

RFCTYPE_FLOAT = 7;

1.4.2.6.54 Constant RFCTYPE_INT Unit


File

gsSAPxRFCBase

Description

Specifies 4-byte binary integer.

Syntax

RFCTYPE_INT = 8;


80

1

1.4.2.6.55 Constant RFCTYPE_INT1 Unit


File

gsSAPxRFCBase

Description

Specifies 2-byte binary integer, obsolete and not directly supported by ABAP/4.

Syntax

RFCTYPE_INT1 = 10;

1.4.2.6.56 Constant RFCTYPE_INT2 Unit


File

gsSAPxRFCBase

Description

Specifies 2-byte integer, obsolete and not directly supported by ABAP/4.

Syntax

RFCTYPE_INT2 = 9;

1.4.2.6.57 Constant RFCTYPE_ITAB Unit


File

gsSAPxRFCBase

Description

Specifies internal tables handle.

Syntax

RFCTYPE_ITAB = 5;

1.4.2.6.58 Constant RFCTYPE_IUNKNOWN Unit


File

gsSAPxRFCBase

Description

Specifies an IUnknown object that can only be used in a COM/OLE environment.

Syntax

RFCTYPE_IUNKNOWN = RFCTYPE_ABAP4OBJECT + 1;


81

1

1.4.2.6.59 Constant RFCTYPE_NULL Unit


File

gsSAPxRFCBase

Description

Specifies not supported or undefined data type.

Syntax

RFCTYPE_NULL = _RFCTYPE_differ_from_abap;

1.4.2.6.60 Constant RFCTYPE_NUM Unit


File

gsSAPxRFCBase

Description

Specifies RFC data type as a set of digits with fixed size, '0' padded, in textual form.

Syntax

RFCTYPE_NUM = 6;

1.4.2.6.61 Constant RFCTYPE_PADDING Unit


File

gsSAPxRFCBase

Description

Specifies object that is used in dummy fields to ensure proper alignment of structure with sub structures.

Syntax

RFCTYPE_PADDING = RFCTYPE_CORBA_OBJECT + 1;

1.4.2.6.62 Constant RFCTYPE_SAPAUTOMATION Unit


File

gsSAPxRFCBase

Description

Specifies a SAP automation object (SAPGUI, internal use only).

Syntax

RFCTYPE_SAPAUTOMATION = RFCTYPE_WSTRING + 1;


82

1

1.4.2.6.63 Constant RFCTYPE_STRING Unit


File

gsSAPxRFCBase

Description

Specifies zero terminated string. Supported from SAP v 6.0.

Syntax

RFCTYPE_STRING = RFCTYPE_XMLDATA + 1;

1.4.2.6.64 Constant RFCTYPE_STRUCTURE Unit


File

gsSAPxRFCBase

Description

Specifies a structure (internal use).

Syntax

RFCTYPE_STRUCTURE = RFCTYPE_WIDE_4 + 1;

1.4.2.6.65 Constant RFCTYPE_STUB Unit


File

gsSAPxRFCBase

Description

Specifies a remote object's stub (internal use).

Syntax

RFCTYPE_STUB = RFCTYPE_SAPAUTOMATION + 1;

1.4.2.6.66 Constant RFCTYPE_TIME Unit


File

gsSAPxRFCBase

Description

Specifies RFC data type DATE with format HHMMSS.

Syntax

RFCTYPE_TIME = 3;


83

1

1.4.2.6.67 Constant RFCTYPE_UNICODE Unit


File

gsSAPxRFCBase

Description

Specifies a 2-bytes characters for strings in Unicode environment. Blank padded fixed size (e. g. UTF16).

Syntax

RFCTYPE_UNICODE = RFCTYPE_PADDING + 1;

1.4.2.6.68 Constant RFCTYPE_WCHAR Unit


File

gsSAPxRFCBase

Description

Specifies a wide character string, blank padded.

Syntax

RFCTYPE_WCHAR = RFCTYPE_WIDE_2;

1.4.2.6.69 Constant RFCTYPE_WIDE_2 Unit


File

gsSAPxRFCBase

Description

Specifies wide 2-byte character (internal use).

Syntax

RFCTYPE_WIDE_2 = RFCTYPE_NULL + 1;

1.4.2.6.70 Constant RFCTYPE_WIDE_4 Unit


File

gsSAPxRFCBase

Description

Specifies wide 4-byte character (internal use).

Syntax

RFCTYPE_WIDE_4 = RFCTYPE_WIDE_2 + 1;


84

1

1.4.2.6.71 Constant RFCTYPE_WIRE_OBJECT Unit


File

gsSAPxRFCBase

Description

Specifies an object on the wire (internal use).

Syntax

RFCTYPE_WIRE_OBJECT = RFCTYPE_STUB + 1;

1.4.2.6.72 Constant RFCTYPE_WSTRING Unit


File

gsSAPxRFCBase

Description

Specifies a wide character string zero terminated, if given size is big enough.

Syntax

RFCTYPE_WSTRING = RFCTYPE_IUNKNOWN + 1;

1.4.2.6.73 Constant RFCTYPE_XMLDATA Unit


File

gsSAPxRFCBase

Description

Specifies zero terminated string describing ABAP data types/structure as XML. Supported from SAP v 6.0.

Syntax

RFCTYPE_XMLDATA = RFCTYPE_UNICODE + 1;

1.4.2.6.74 Constant RFCTYPE_XSTRING Unit


File

gsSAPxRFCBase

Description

Specifies raw string with length field in bytes. Supported from SAP v 6.0.

Syntax

RFCTYPE_XSTRING = RFCTYPE_STRING + 1;

1.4 Units Connect for SAP ® Unit gsSAPxRFCClient

85

1

1.4.3 Unit gsSAPxRFCClient

Classes

TSAPxRFCAliasGS ( see page 87)

TSAPxRFCClientConnectionGS ( see page 97)

TSAPxRFCCustomAliasListGS ( see page 109)

TSAPxRFCFileAliasListGS ( see page 114)

TSAPxRFCRegistryAliasListGS ( see page 116)

Group


Legend

Enumeration

Records, Enums

TSAPxRFCAliasPasswordModeGS ( see page 119)

TSAPxRFCSapTypeGS ( see page 119)

TSAPxRFCSncQopGS ( see page 119)

TSAPxRFCUseSapGUIGS ( see page 120)

Types

TSAPxRFCConnectionLoginEventGS ( see page 120)

TSAPxRFCCustomAliasListClassGS ( see page 120)

Description

Unit gsSAPxRFCClient contains classes and types to build a client part of an application working with a SAP R/3 system.

The TSAPxRFCAliasGS ( see page 87) class allows storing a set of client connection parameters as a named object (analias). These objects are organized by alias list objects having TSAPxRFCRegistryAliasListGS ( see page 116) orTSAPxRFCFileAliasListGS ( see page 114) class. Mentioned alias list classes inherit from common ancestor theTSAPxRFCCustomAliasListGS ( see page 109) class. All described classes are used for alias management.

TSAPxRFCClientConnectionGS ( see page 97) uses the aliases to specify parameters for establishing a connection to aSAP system.

1.4.3.1 Classes


86

1

1.4.3.1.1 Class TSAPxRFCAliasGS Events

OnChanged ( see page 96)

OnChanging ( see page 96)

Unit

Unit gsSAPxRFCClient ( see page 86)

Legend

Constructor

All Members

Methods

Assign ( see page 89)

Clear ( see page 89)

Create ( see page 89)

Destroy ( see page 90)

OverrideBy ( see page 90)

ReadFrom ( see page 90)

WriteTo ( see page 90)

Properties

ABAP_DEBUG ( see page 91)

ASHOST ( see page 91)

CLIENT ( see page 91)

CODEPAGE ( see page 91)

ConnectionString ( see page 91)

DataFormat ( see page 92)

DEST ( see page 92)

GROUP ( see page 92)

GWHOST ( see page 92)

GWSERV ( see page 92)

LANG ( see page 93)

MSHOST ( see page 93)

Name ( see page 93)

OriginalName ( see page 93)

PASSWD ( see page 93)

PasswordMode ( see page 93)

R3NAME ( see page 94)

RFC_TRACE ( see page 94)

SAPTYPE ( see page 94)

SNC_LIB ( see page 94)

SNC_MODE ( see page 94)

SNC_MYNAME ( see page 95)

SNC_PARTNERNAME ( see page 95)

SNC_QOP ( see page 95)

SYSNR ( see page 95)


87

1

TPHOST ( see page 95)

TPNAME ( see page 95)

USE_SAPGUI ( see page 96)

USER ( see page 96)

WAN_CONN ( see page 96)

Events



Methods






ReadFrom ( see page 90)

WriteTo ( see page 90)

Properties

ABAP_DEBUG ( see page 91)

ASHOST ( see page 91)

CLIENT ( see page 91)

CODEPAGE ( see page 91)

ConnectionString ( see page 91)


DEST ( see page 92)

GROUP ( see page 92)



LANG ( see page 93)

MSHOST ( see page 93)

Name ( see page 93)

OriginalName ( see page 93)

PASSWD ( see page 93)

PasswordMode ( see page 93)

R3NAME ( see page 94)


SAPTYPE ( see page 94)


SNC_MODE ( see page 94)


SNC_PARTNERNAME ( see page 95)

SNC_QOP ( see page 95)

SYSNR ( see page 95)

TPHOST ( see page 95)

TPNAME ( see page 95)

USE_SAPGUI ( see page 96)

USER ( see page 96)

WAN_CONN ( see page 96)


88

1

File

gsSAPxRFCClient

Description

TSAPxRFCAliasGS encapsulates all client connection (see TSAPxRFCClientConnectionGS ( see page 97)) parameters.They are represented by the same named properties - SAPTYPE ( see page 94), CLIENT ( see page 91), ASHOST (see page 91), etc. Alternative way to specify parameters is ConnectionString ( see page 91) usage. The following exampledemonstrates definition of connection parameters and opening a connection.

Example:

procedure OpenConnection(AConnection: TSAPxRFCClientConnectionGS);begin with AConnection.Params do begin SAPTYPE := '3'; CLIENT := '100'; USER := 'UserName'; LANG := 'en'; ASHOST := 'myserver.mydomain.com'; SYSNR := '00'; end; AConnection.Active := True;end;

Syntax

public TSAPxRFCAliasGS = class(TPersistent);

1.4.3.1.1.1 Methods

1.4.3.1.1.1.1 Method TSAPxRFCAliasGS.Assign

Class

Class TSAPxRFCAliasGS ( see page 87)

Description

Copies the contents of another alias to the object where the method is executed.

Source - specifies object from which alias parameters are copied.

Syntax

public procedure Assign(Source: TPersistent); override;

1.4.3.1.1.1.2 Method TSAPxRFCAliasGS.Clear

Class


Description

Deletes the alias contents and restores default data format.

Syntax

public procedure Clear;

1.4.3.1.1.1.3 Constructor TSAPxRFCAliasGS.Create

Class



89

1

Description

Creates and initializes a new TSAPxRFCAliasGS object.

ADataFormatOwner is object - owner of data format object.

Syntax

public constructor Create(ADataFormatOwner: TSAPxRFCObjectGS);

1.4.3.1.1.1.4 Destructor TSAPxRFCAliasGS.Destroy

Class


Description

Destroys an instance of TSAPxRFCAliasGS.

Syntax

public destructor Destroy; override;

1.4.3.1.1.1.5 Method TSAPxRFCAliasGS.OverrideBy

Class


Description

Overrides the object parameters by another alias's ones which have not empty values.

Alias - specifies object containing a set of non-empty alias parameters which override existing ones.

Syntax

public procedure OverrideBy(AAlias: TSAPxRFCAliasGS);

1.4.3.1.1.1.6 Method TSAPxRFCAliasGS.ReadFrom

Class


Description

Reads alias parameter from AReader storage.

AReader - specifies external alias storage object.

Syntax

protected procedure ReadFrom(AReader: TCustomIniFile);

1.4.3.1.1.1.7 Method TSAPxRFCAliasGS.WriteTo

Class


Description

Writes alias parameters to external alias storage AWriter.

AWriter - specifies an external alias storage.


90

1

Syntax

protected procedure WriteTo(AWriter: TCustomIniFile);

1.4.3.1.1.2 Properties

1.4.3.1.1.2.1 Property TSAPxRFCAliasGS.ABAP_DEBUG

Class


Description

RFC with ABAP debugger.

Syntax

published property ABAP_DEBUG: Boolean;

1.4.3.1.1.2.2 Property TSAPxRFCAliasGS.ASHOST

Class


Description

Specifies a host name of a specific R/3 application server.

Syntax

published property ASHOST: String;

1.4.3.1.1.2.3 Property TSAPxRFCAliasGS.CLIENT

Class


Description

Specifies a R/3 client number.

Syntax

published property CLIENT: String;

1.4.3.1.1.2.4 Property TSAPxRFCAliasGS.CODEPAGE

Class


Description

The given codepage is to be used for this connection (Default is either 1100 or set by RfcSetSystemCodepage or is set bySAP_CODEPAGE environment variable). Could be rather useful if the SAPGUI should be started with codepage differs from1100.

Syntax

published property CODEPAGE: String;

1.4.3.1.1.2.5 Property TSAPxRFCAliasGS.ConnectionString

Class


Description

Specifies the SAP R/3 server connection string, assembled from separated parameters.


91

1

Syntax

published property ConnectionString: String;

1.4.3.1.1.2.6 Property TSAPxRFCAliasGS.DataFormat

Class


Description

Specifies a data format. The data format determines how Delphi data types maps to the SAP RFC data types.

Syntax

published property DataFormat: TSAPxRFCDataFormatGS;

1.4.3.1.1.2.7 Property TSAPxRFCAliasGS.DEST

Class


Description

Specifies a destination name. The set of destination values is determined by the saprfc.ini file entries.

Syntax

published property DEST: String;

1.4.3.1.1.2.8 Property TSAPxRFCAliasGS.GROUP

Class


Description

Specifies an application servers group name.

Syntax

published property GROUP: String;

1.4.3.1.1.2.9 Property TSAPxRFCAliasGS.GWHOST

Class


Description

Specifies a gateway host name.

Syntax

published property GWHOST: String;

1.4.3.1.1.2.10 Property TSAPxRFCAliasGS.GWSERV

Class


Description

Specifies a gateway service name.

Syntax

published property GWSERV: String;


92

1

1.4.3.1.1.2.11 Property TSAPxRFCAliasGS.LANG

Class


Description

Specifies an user interface language.

Syntax

published property LANG: String;

1.4.3.1.1.2.12 Property TSAPxRFCAliasGS.MSHOST

Class


Description

Specifies a message server host name.

Syntax

published property MSHOST: String;

1.4.3.1.1.2.13 Property TSAPxRFCAliasGS.Name

Class


Description

Specifies the name of the alias.

Syntax

published property Name: String;

1.4.3.1.1.2.14 Property TSAPxRFCAliasGS.OriginalName

Class


Description

Specifies the original name of the alias, as it was right after reading parameter from alias file. If Name property was changed,OriginalName property value remains unchanged until alias will be stored in alias file.

Syntax

public property OriginalName: String;

1.4.3.1.1.2.15 Property TSAPxRFCAliasGS.PASSWD

Class


Description

Specifies a password.

Syntax

published property PASSWD: String;

1.4.3.1.1.2.16 Property TSAPxRFCAliasGS.PasswordMode

Class



93

1

Description

Indicates the way a PASSWD parameter is saved in alias file.

Syntax

published property PasswordMode: TSAPxRFCAliasPasswordModeGS;

1.4.3.1.1.2.17 Property TSAPxRFCAliasGS.R3NAME

Class


Description

Specifies a R/3 system name.

Syntax

published property R3NAME: String;

1.4.3.1.1.2.18 Property TSAPxRFCAliasGS.RFC_TRACE

Class


Description

RFC tracing.

Syntax

published property RFC_TRACE: Boolean;

1.4.3.1.1.2.19 Property TSAPxRFCAliasGS.SAPTYPE

Class


Description

Specifies a SAP system type.

Syntax

published property SAPTYPE: TSAPxRFCSapTypeGS;

1.4.3.1.1.2.20 Property TSAPxRFCAliasGS.SNC_LIB

Class


Description

Path and name of the SNC-library.

Syntax

published property SNC_LIB: String;

1.4.3.1.1.2.21 Property TSAPxRFCAliasGS.SNC_MODE

Class


Description

Working with SNC.

Syntax

published property SNC_MODE: Boolean;


94

1

1.4.3.1.1.2.22 Property TSAPxRFCAliasGS.SNC_MYNAME

Class


Description

Own SNC name if you don't want to use the default SNC name.

Syntax

published property SNC_MYNAME: String;

1.4.3.1.1.2.23 Property TSAPxRFCAliasGS.SNC_PARTNERNAME

Class


Description

SNC name of the SNC partner (RFC server) or SNC name of the message server (Load Balancing).

Syntax

published property SNC_PARTNERNAME: String;

1.4.3.1.1.2.24 Property TSAPxRFCAliasGS.SNC_QOP

Class


Description

SNC Quality of service.

Syntax

published property SNC_QOP: TSAPxRFCSncQopGS;

1.4.3.1.1.2.25 Property TSAPxRFCAliasGS.SYSNR

Class


Description

Specifies a R/3 system number (0 - 99).

Syntax

published property SYSNR: String;

1.4.3.1.1.2.26 Property TSAPxRFCAliasGS.TPHOST

Class


Description

Specifies a server program host name.

Syntax

published property TPHOST: String;

1.4.3.1.1.2.27 Property TSAPxRFCAliasGS.TPNAME

Class



95

1

Description

Specifies a path and server program name.

Syntax

published property TPNAME: String;

1.4.3.1.1.2.28 Property TSAPxRFCAliasGS.USE_SAPGUI

Class


Description

Specifies a mode of SAPGUI using.

Syntax

published property USE_SAPGUI: TSAPxRFCUseSapGUIGS;

1.4.3.1.1.2.29 Property TSAPxRFCAliasGS.USER

Class


Description

Specifies a user name.

Syntax

published property USER: String;

1.4.3.1.1.2.30 Property TSAPxRFCAliasGS.WAN_CONN

Class


Description

RFC via Wide Area Network, False = LAN, True = WAN (Default: False). If LAN is used, all tables bigger than 8000 Byteswill be compressed before sent. If WAN is used, all tables bigger than 250 Bytes (or value defined by environment variableRFC_WAN_THRESHOLD) will be compressed before sent. The table size will be calculated as follows: table_length *number_of_rows.

Syntax

published property WAN_CONN: Boolean;

1.4.3.1.1.3 Events

1.4.3.1.1.3.1 Event TSAPxRFCAliasGS.OnChanged

Class


Description

Occurs immediately after the list of parameters changes.

Syntax

public property OnChanged: TNotifyEvent;

1.4.3.1.1.3.2 Event TSAPxRFCAliasGS.OnChanging

Class



96

1

Description

Occurs immediately before the list of parameters changes.

Syntax

public property OnChanging: TNotifyEvent;

1.4.3.1.2 Class TSAPxRFCClientConnectionGS Events

Class TSAPxRFCClientConnectionGS

OnLogin ( see page 109)

Fields

Class TSAPxRFCCustomConnectionGS

FActive ( see page 240)

FAttributes ( see page 241)

FDetectedBytesPerChar ( see page 241)

FDetectedFloatType ( see page 241)

FDetectedIntType ( see page 241)

FErrorInfo ( see page 241)

FHandle ( see page 241)

Unit


Legend

Constructor

All Members

Methods

Trace ( see page 370)


TraceEnter ( see page 370)

TraceExit ( see page 370)

Class TSAPxRFCObjectGS

GetDataFormat ( see page 316)

GetErrorHandler ( see page 316)

GetParentDataFormat ( see page 316)


AddObject ( see page 242)

AllowStartProgram ( see page 242)

CheckActive ( see page 242)

CheckInactive ( see page 242)

Close ( see page 242)

ConnectedObjectByName ( see page 243)




97

1

DisconnectObjects ( see page 243)

DoDetectActualDataFormat ( see page 243)

DoEnterBusy ( see page 244)

DoError ( see page 244)

DoExitBusy ( see page 244)

DoIdle ( see page 244)

EnterBusyState ( see page 245)

ExitBusyState ( see page 245)

FindConnectedObject ( see page 245)

ForceDisconnect ( see page 245)

InternalClose ( see page 245)

InternalForceDisconnect ( see page 246)

Open ( see page 246)

PrepareObjects ( see page 246)

RemoveObject ( see page 246)

UnprepareObjects ( see page 246)


BeginCall ( see page 103)

EndCall ( see page 104)

TryBeginCall ( see page 104)

CheckTransActive ( see page 104)

CheckTransInactive ( see page 104)



StartTransaction ( see page 105)

RestoreTransaction ( see page 105)

EndTransaction ( see page 105)


CreateAliasStorage ( see page 106)



GetAliasStorageClass ( see page 106)


GetInfo ( see page 107)



Properties



ParentDataFormat ( see page 316)


98

1


Active ( see page 247)

AfterConnectEvent ( see page 247)

AfterDisconnectEvent ( see page 247)

Attributes ( see page 247)

BeforeConnectEvent ( see page 247)

BeforeDisconnectEvent ( see page 248)

Busy ( see page 248)

DetectedBytesPerChar ( see page 248)

DetectedFloatType ( see page 248)

DetectedIntType ( see page 249)

ErrorInfo ( see page 249)

Handle ( see page 249)

ObjectCount ( see page 249)

Objects ( see page 249)

OnEnterBusyEvent ( see page 249)

OnErrorEvent ( see page 250)

OnExitBusyEvent ( see page 250)

OnIdleEvent ( see page 250)



AliasFileName ( see page 107)

AliasName ( see page 108)

LoginPrompt ( see page 108)

Params ( see page 108)

ResultAlias ( see page 108)

TID ( see page 108)

TransActive ( see page 109)

Fields









Events



Methods




99

1

































BeginCall ( see page 103)

EndCall ( see page 104)

TryBeginCall ( see page 104)

CheckTransActive ( see page 104)

CheckTransInactive ( see page 104)







CreateAliasStorage ( see page 106)


100

1



GetAliasStorageClass ( see page 106)


GetInfo ( see page 107)



Properties





























ResultAlias ( see page 108)

TID ( see page 108)

TransActive ( see page 109)

File

gsSAPxRFCClient


101

1

Description

TSAPxRFCClientConnectionGS provides a connection to SAP R/3 system.

TSAPxRFCClientConnectionGS is used in the client portion of a SAP R/3 aware application to establish and maintain theconnection between the client and remote SAP R/3 application server.

At first you should determine connection parameters. There are two ways to specify a connection parameters. The first isthat when connection parameters are defined by AliasName ( see page 108) in alias storage defined by AliasFileName (see page 107). The second way is to specify connection parameters using Params ( see page 108) property. In this caseall non-empty values of Params override the same parameters values defined in alias storage. And result values ofconnection parameters will be reflected in ResultAlias ( see page 108) property. Then you can open connection with Open( see page 104) method. If you want to substitute login procedure you have to assign your own event handler to OnLogin( see page 109) event. To use a login form LoginPrompt ( see page 108) should be set in True.

Example

var Connection: TSAPxRFCClientConnectionGS; procedure Main;begin ... with Connection do begin AliasFileName := 'C:\AliasList.ini'; AliasName := 'MY_ALIAS'; Open; try { do something } finally Close; end; end; ...end;

Methods of TSAPxRFCClientConnectionGS object are also provided implementation of transactions. Use StartTransaction( see page 105) to initiate a new transaction and get a transaction identifier (TID) from SAP R/3 system. TheEndTransaction ( see page 105) method completes an active transaction. If an error occurs (almost only communicationerrors), the client program has to reconnect to SAP R/3 later and repeat transaction with the specific TID. In this case theRestoreTransaction ( see page 105) method is used for restarting a failed transaction with old TID. This fact ensures that atransactional RFC function will be executed exactly once in the R/3 system.

Note

Only one RFC function (see TSAPxRFCFunctionGS ( see page 299)) may be executed within a transaction.

Example

var


102

1

FTID: String; Connection: TSAPxRFCClientConnectionGS; Function: TSAPxRFCFunctionGS; procedure Main;begin ... with Connection do begin AliasFileName := 'C:\AliasList.ini'; AliasName := 'MY_ALIAS'; Open; if FTID = '' then StartTransaction else RestoreTransaction(FTID); end; ...end; procedure StartTransaction;begin Connection.StartTransaction; try FTID := Connection.RFCConnection.TID; Function.ExecFunction; { some transaction actions }; finally Connection.EndTransaction; FTID := ''; end;end; procedure ReStartTransaction;begin Connection.RestoreTransaction(FTID); try Function.ExecFunction; { some transaction actions }; finally Connection.EndTransaction; FTID := ''; end;end;

Syntax

public TSAPxRFCClientConnectionGS = class(TSAPxRFCCustomConnectionGS);

1.4.3.1.2.1 Methods

1.4.3.1.2.1.1 Method TSAPxRFCClientConnectionGS.BeginCall

Class

Class TSAPxRFCClientConnectionGS ( see page 97)

Description

Initiates serialization of RFC calls within the same client connection.

BeginCall is called to locks the client connection before any RFC calls working with sending/receiving data within theconnection. Then EndCall ( see page 104) must be called. BeginCall is blocking method and returns control as soon asanother thread unlocks serialization. Use TryBeginCall ( see page 104) for non-blocking call.

It's used in TSAPxRFCFunctionGS.ExecFunction ( see page 306).

Syntax

public procedure BeginCall;


103

1

1.4.3.1.2.1.2 Method TSAPxRFCClientConnectionGS.EndCall

Class


Description

Finalizes serialization of RFC calls within the same client connection.

EndCall is called to unlocks the client connection after completion of all RFC calls sending/receiving data within theconnection. Each BeginCall ( see page 103) has to have corresponding EndCall one.

It's used in TSAPxRFCFunctionGS.ExecFunction ( see page 306).

Syntax

public procedure EndCall;

1.4.3.1.2.1.3 Method TSAPxRFCClientConnectionGS.TryBeginCall

Class


Description

Tries to initiate serialization of RFC calls within the same client connection.

The method is similar to BeginCall ( see page 103) except that it's non-blocking. It means that if serialization has beenalready started for the connection (by BeginCall ( see page 103) or TryBeginCall from another thread) the methodimmediately completes and returns False.

Syntax

public function TryBeginCall: Boolean;

1.4.3.1.2.1.4 Method TSAPxRFCClientConnectionGS.CheckTransActive

Class


Description

Checks whether or not the connection has active transaction. If there is no active transaction, ESAPxRFCExceptionGS (see page 21) is raised.

Syntax

protected procedure CheckTransActive;

1.4.3.1.2.1.5 Method TSAPxRFCClientConnectionGS.CheckTransInactive

Class


Description

Checks whether or not the connection has no active transaction. If there is any active transaction, ESAPxRFCExceptionGS( see page 21) is raised.

Syntax

protected procedure CheckTransInactive;

1.4.3.1.2.1.6 Method TSAPxRFCClientConnectionGS.Open

Class



104

1

Description

Opens a connection to SAP R/3 system.

Syntax

public procedure Open; override;

1.4.3.1.2.1.7 Method TSAPxRFCClientConnectionGS.Close

Class


Description

Closes the connection.

Syntax

public procedure Close; override;

1.4.3.1.2.1.8 Method TSAPxRFCClientConnectionGS.StartTransaction

Class


Description

Initiates a new transaction.

Syntax

public procedure StartTransaction;

1.4.3.1.2.1.9 Method TSAPxRFCClientConnectionGS.RestoreTransaction

Class


Description

Restores a transaction with specified TID.

ATID specifies a transaction ID to be restored.

Syntax

public procedure RestoreTransaction(ATID: String);

1.4.3.1.2.1.10 Method TSAPxRFCClientConnectionGS.EndTransaction

Class


Description

Finishes an active transaction.

Syntax

public procedure EndTransaction;

1.4.3.1.2.1.11 Constructor TSAPxRFCClientConnectionGS.Create

Class


Description

Creates and initializes a new TSAPxRFCClientConnectionGS object.


105

1

Syntax

public constructor Create; override;

1.4.3.1.2.1.12 Method TSAPxRFCClientConnectionGS.CreateAliasStorage

Class


Description

Creates and instance of the alias storage class.

Syntax

public function CreateAliasStorage: TSAPxRFCCustomAliasListGS;

1.4.3.1.2.1.13 Destructor TSAPxRFCClientConnectionGS.Destroy

Class


Description

Destroys an instance of TSAPxRFCClientConnectionGS.

Syntax


1.4.3.1.2.1.14 Method TSAPxRFCClientConnectionGS.DoDetectActualDataFormat

Class


Description

Procedure automatically detects server representation of INTEGER, FLOAT and CHAR/STRING data. It uses for thatRFC_SYSTEM_INFO function module.

Syntax

protected procedure DoDetectActualDataFormat; override;

1.4.3.1.2.1.15 Method TSAPxRFCClientConnectionGS.GetAliasStorageClass

Class


Description

Override GetAliasStorageClass method if you need to create your own storage to manage the aliases.

Function returns an alias storage class type.

Syntax

public function GetAliasStorageClass: TSAPxRFCCustomAliasListClassGS; virtual;

1.4.3.1.2.1.16 Method TSAPxRFCClientConnectionGS.GetDataFormat

Class


Description

Gets a dataformat object.


106

1

Returns a reference to object describing a data format.

Syntax

protected function GetDataFormat: TSAPxRFCDataFormatGS; override;

1.4.3.1.2.1.17 Method TSAPxRFCClientConnectionGS.GetInfo

Class


Syntax

public procedure GetInfo(AList: TStrings);

1.4.3.1.2.1.18 Method TSAPxRFCClientConnectionGS.InternalClose

Class


Description

Executes some internal actions to close a connection.

Syntax

protected procedure InternalClose; override;

1.4.3.1.2.1.19 Method TSAPxRFCClientConnectionGS.InternalForceDisconnect

Class


Description

Executes some internal actions to force connection disconnect.

Syntax

protected procedure InternalForceDisconnect; override;


1.4.3.1.2.2.1 Property TSAPxRFCClientConnectionGS.Active

Class


Description

Specifies whether or not a connection with a SAP server is established and ready to use.

Syntax

public property Active: Boolean;

1.4.3.1.2.2.2 Property TSAPxRFCClientConnectionGS.AliasFileName

Class


Description

Specifies the name of the file with a list of stored connection aliases.

Syntax

public property AliasFileName: String;


107

1

1.4.3.1.2.2.3 Property TSAPxRFCClientConnectionGS.AliasName

Class


Description

Specifies the current connection alias name.

Syntax

public property AliasName: String;

1.4.3.1.2.2.4 Property TSAPxRFCClientConnectionGS.LoginPrompt

Class


Description

Determines if login form will be shown before opening a connection.

Syntax

public property LoginPrompt: Boolean;

1.4.3.1.2.2.5 Property TSAPxRFCClientConnectionGS.Params

Class


Description

Specifies an initial set of connection parameters. Values specified by Params have more priority over the same parametersdefined in alias with name specified by AliasName ( see page 108) property.

Syntax

public property Params: TSAPxRFCAliasGS;

1.4.3.1.2.2.6 Property TSAPxRFCClientConnectionGS.ResultAlias

Class


Description

Determines a full set of connection parameters as a combination of parameters defined in alias with name specified byAliasName ( see page 108) property and parameters specified in Params ( see page 108) property.

Syntax

public property ResultAlias: TSAPxRFCAliasGS;

1.4.3.1.2.2.7 Property TSAPxRFCClientConnectionGS.TID

Class


Description

Contains the transaction identifier.

Syntax

public property TID: string;


108

1

1.4.3.1.2.2.8 Property TSAPxRFCClientConnectionGS.TransActive

Class


Description

Indicates whether a transaction is in progress.

Syntax

public property TransActive: Boolean;

1.4.3.1.2.3 Events

1.4.3.1.2.3.1 Event TSAPxRFCClientConnectionGS.OnLogin

Class


Description

Occurs before opening a connection. Use this event to assign your own login procedure.

Syntax

public property OnLogin: TSAPxRFCConnectionLoginEventGS;

1.4.3.1.3 Class TSAPxRFCCustomAliasListGS Unit


Legend

Constructor

All Members

Methods

Add ( see page 110)

AliasByName ( see page 110)

Cancel ( see page 111)



CreateRegIni ( see page 111)

Delete ( see page 112)


FindAlias ( see page 112)

Modify ( see page 112)


Properties


Aliases ( see page 113)

Count ( see page 113)

FileName ( see page 113)

Names ( see page 114)

OriginalNames ( see page 114)


109

1

Methods

Add ( see page 110)











Properties







File

gsSAPxRFCClient

Description

TSAPxRFCCustomAliasListGS is a abstract base class, which introduces properties and methods to handle storage andretrieval of connection alias specific information and settings. Alias list cashes data from alias storage in memory.TSAPxRFCCustomAliasListGS has descendants TSAPxRFCFileAliasListGS ( see page 114) andTSAPxRFCRegistryAliasListGS ( see page 116).

Syntax

public TSAPxRFCCustomAliasListGS = class(TObject);

1.4.3.1.3.1 Methods

1.4.3.1.3.1.1 Method TSAPxRFCCustomAliasListGS.Add

Class

Class TSAPxRFCCustomAliasListGS ( see page 109)

Description

Adds a new, empty unnamed connection alias to the alias list.

Returns created alias.

Syntax

public function Add: TSAPxRFCAliasGS;

1.4.3.1.3.1.2 Method TSAPxRFCCustomAliasListGS.AliasByName

Class



110

1

Description

Finds an alias by its name. If alias was not found, then exception will be raised. See also FindAlias ( see page 112).

AName - alias name.

Returns alias with AName name.

Syntax

public function AliasByName(const AName: String): TSAPxRFCAliasGS;

1.4.3.1.3.1.3 Method TSAPxRFCCustomAliasListGS.Cancel

Class


Description

Cancels modifications to the specified by Alias alias, if those changes are not yet saved.

AAlias - reference to alias.

Syntax

public procedure Cancel(var AAlias: TSAPxRFCAliasGS);

1.4.3.1.3.1.4 Method TSAPxRFCCustomAliasListGS.Close

Class


Description

Closes an alias list. See Active ( see page 113) for details.

Syntax

public procedure Close;

1.4.3.1.3.1.5 Constructor TSAPxRFCCustomAliasListGS.Create

Class


Description

Initializes a new TSAPxRFCCustomAliasListGS object.

Syntax

public constructor Create; virtual;

1.4.3.1.3.1.6 Method TSAPxRFCCustomAliasListGS.CreateRegIni

Class


Description

Introduces an abstract method to create an alias storage. Alias storage must be any descendant class of TCustomIniFileclass. See TSAPxRFCFileAliasListGS.CreateRegIni ( see page 116) or TSAPxRFCRegistryAliasListGS.CreateRegIni (see page 118) for implementation examples.

Returns a reference to storage object.


111

1

Syntax

protected function CreateRegIni: TCustomIniFile; virtual; abstract;

1.4.3.1.3.1.7 Method TSAPxRFCCustomAliasListGS.Delete

Class


Description

Deletes the specified by AAlias alias from the list and alias storage.

AAlias - reference to alias object.

Syntax

public procedure Delete(var AAlias: TSAPxRFCAliasGS);

1.4.3.1.3.1.8 Destructor TSAPxRFCCustomAliasListGS.Destroy

Class


Description

Finalizes an instance of TSAPxRFCCustomAliasListGS.

Syntax


1.4.3.1.3.1.9 Method TSAPxRFCCustomAliasListGS.FindAlias

Class


Description

Finds an alias by its name. If alias was not found, then nil will e returned. See also AliasByName ( see page 110).

AName - alias name.

Returns alias with AName name.

Syntax

public function FindAlias(const AName: String): TSAPxRFCAliasGS;

1.4.3.1.3.1.10 Method TSAPxRFCCustomAliasListGS.Modify

Class


Description

Saves specified by AAlias alias into storage. After that call all changes made to alias become persistent and cant becanceled by Cancel ( see page 111) call. Also alias OriginalName ( see page 93) become equal to Name ( see page93).

AAlias - reference to alias.

Syntax

public procedure Modify(AAlias: TSAPxRFCAliasGS);


112

1

1.4.3.1.3.1.11 Method TSAPxRFCCustomAliasListGS.Open

Class


Description

Opens an alias list. See Active ( see page 113) for details.

Syntax

public procedure Open;


1.4.3.1.3.2.1 Property TSAPxRFCCustomAliasListGS.Active

Class


Description

Specifies whether or not an alias list is open. When list is opened, then aliases are loaded into memory and may beaccessed through class properties and modified.

Syntax


1.4.3.1.3.2.2 Property TSAPxRFCCustomAliasListGS.Aliases

Class


Description

Lists all aliases by its index. To make list accessible set Active ( see page 113) to True.

AIndex - index of alias.

Syntax

public property Aliases [AIndex: Integer]: TSAPxRFCAliasGS;

1.4.3.1.3.2.3 Property TSAPxRFCCustomAliasListGS.Count

Class


Description

Returns the number of aliases in the list. To make list accessible set Active ( see page 113) to True.

Syntax

public property Count: Integer;

1.4.3.1.3.2.4 Property TSAPxRFCCustomAliasListGS.FileName

Class


Description

Contains the name of the aliases storage file.


113

1

Syntax

public property FileName: String;

1.4.3.1.3.2.5 Property TSAPxRFCCustomAliasListGS.Names

Class


Description

Returns a alias name by its index. To make list accessible set Active ( see page 113) to True.


Syntax

public property Names [AIndex: Integer]: String;

1.4.3.1.3.2.6 Property TSAPxRFCCustomAliasListGS.OriginalNames

Class


Description

Returns a alias original name by its index. See TSAPxRFCAliasGS.OriginalName ( see page 93) for details. To make listaccessible set Active ( see page 113) to True.


Syntax

public property OriginalNames [AIndex: Integer]: String;

1.4.3.1.4 Class TSAPxRFCFileAliasListGS Unit


Legend

Constructor

All Members

Methods

Add ( see page 110)












114

1

Class TSAPxRFCFileAliasListGS


Properties







Methods

Add ( see page 110)











Class TSAPxRFCFileAliasListGS


Properties







File

gsSAPxRFCClient

Description

TSAPxRFCFileAliasListGS implements connection alias information storage as a INI-file. Also seeTSAPxRFCRegistryAliasListGS ( see page 116), which implements registry based storage.

To use this storage you should set FileName ( see page 113) to INI-file containing aliases. Then open the file using Open( see page 113) method. After that you can use such methods as Add ( see page 110), FindAlias ( see page 112),Modify ( see page 112) and Delete ( see page 112) to control aliases.

Example

Following code is simlified TSAPxRFCClientConnection.Open code.


115

1

procedure TClientConnection.Open(AAliasName, AAliasFileName: string);var oAliases: TSAPxRFCCustomAliasListGS; sConn, s1, s2, s3, s4: String; oResultAlias: TSAPxRFCAliasGS;begin ... // create alias list, load it oAliases := TSAPxRFCFileAliasListGS.Create; try oAliases.FileName := AAliasFileName; oAliases.Open; // copy alias parameters to oResultAlias, so we can change it oResultAlias.Assign(oAliases.AliasByName(AAliasName)); finally oAliases.Free; end; // if user credentials are not complete then fire OnLogin event if (oResultAlias.USER = '') or (oResultAlias.PASSWD = '') or (oResultAlias.CLIENT = '') or (oResultAlias.LANG = '') then begin if Assigned(FOnLogin) then FOnLogin(Self, oResultAlias) else Abort; end; // this string is used to connection opening sConn := oResultAlias.ConnectionString; ... end;

Syntax

public TSAPxRFCFileAliasListGS = class(TSAPxRFCCustomAliasListGS);

1.4.3.1.4.1 Methods

1.4.3.1.4.1.1 Method TSAPxRFCFileAliasListGS.CreateRegIni

Class

Class TSAPxRFCFileAliasListGS ( see page 114)

Description

Implements abstract method and creates alias storage object of TIniFile class.

Returns a reference to INI-file.

Syntax

protected function CreateRegIni: TCustomIniFile; override;

1.4.3.1.5 Class TSAPxRFCRegistryAliasListGS Unit


Legend

Constructor


116

1

All Members

Methods

Add ( see page 110)











Class TSAPxRFCRegistryAliasListGS


Properties







Methods

Add ( see page 110)











Class TSAPxRFCRegistryAliasListGS


Properties







File

gsSAPxRFCClient


117

1

Description

TSAPxRFCRegistryAliasListGS implements connection alias information storage in the system registry. Also seeTSAPxRFCFileAliasListGS ( see page 114), which implements registry based storage.

To use this storage you should set FileName ( see page 113) to a subkey under the system registry's root key(HKEY_LOCAL_MACHINE) containing aliases. Then open the storage using Open ( see page 113) method. After that youcan use such methods as Add ( see page 110), FindAlias ( see page 112), Modify ( see page 112) and Delete ( seepage 112) to control aliases.

Example

Following code is simplified TSAPxRFCClientConnectionGS.Open code.

procedure TClientConnection.Open(AAliasName, AAliasFileName: string);var oAliases: TSAPxRFCCustomAliasListGS; sConn, s1, s2, s3, s4: String; oResultAlias: TSAPxRFCAliasGS;begin ... // open alias list and assign parameters to oResultAlias oAliases := TSAPxRFCRegistryAliasListGS.Create; try oAliases.FileName := AAliasFileName; oAliases.Open; oResultAlias.Assign(oAliases.AliasByName(AAliasName)); finally oAliases.Free; end; // if user credentials are not completed then fire OnLogin event if (oResultAlias.USER = '') or (oResultAlias.PASSWD = '') or (oResultAlias.CLIENT = '') or (oResultAlias.LANG = '') then begin if Assigned(FOnLogin) then FOnLogin(Self, oResultAlias) else Abort; end; // this string is used to connection opening sConn := oResultAlias.ConnectionString; ...end;

Syntax

public TSAPxRFCRegistryAliasListGS = class(TSAPxRFCCustomAliasListGS);

1.4.3.1.5.1 Methods

1.4.3.1.5.1.1 Method TSAPxRFCRegistryAliasListGS.CreateRegIni

Class

Class TSAPxRFCRegistryAliasListGS ( see page 116)

Description

Implements abstract method and creates alias storage object of TRegistryIniFile class. And sets RootKey toHKEY_LOCAL_MACHINE.


118

1

Returns a reference to INI-file.

Syntax

protected function CreateRegIni: TCustomIniFile; override;


1.4.3.2.1 Enumeration TSAPxRFCAliasPasswordModeGS All Members


pmNotSaveGS The parameter PASSWD is not saved at all.

pmSaveGS The parameter PASSWD is saved as a not encrypted text string.

pmSaveEncryptedGS The parameter PASSWD is saved as an encrypted string.

Unit


File

gsSAPxRFCClient

Description

TSAPxRFCAliasPasswordModeGS values indicate the way a PASSWD ( see page 93) parameter is saved in alias storage.

Syntax

public TSAPxRFCAliasPasswordModeGS = ( pmNotSaveGS, pmSaveGS, pmSaveEncryptedGS);

1.4.3.2.2 Enumeration TSAPxRFCSapTypeGS Unit


File

gsSAPxRFCClient

Syntax

public TSAPxRFCSapTypeGS = ( stNoneGS, stLoadBalancing_BGS, stExplicitAppServer_AGS, stExternalRFCProgram_EGS, stRegisteredRFCServer_RGS, stR2_2GS, stR3_3GS);

1.4.3.2.3 Enumeration TSAPxRFCSncQopGS Unit


File

gsSAPxRFCClient


119

1

Syntax

public TSAPxRFCSncQopGS = ( qopInvalidGS, qopOpenGS, qopIntegrityGS, qopPrivacyGS, qopDefaultGS);

1.4.3.2.4 Enumeration TSAPxRFCUseSapGUIGS Unit


File

gsSAPxRFCClient

Syntax

public TSAPxRFCUseSapGUIGS = ( usgOffGS, usgInvisibleGS, usgOnGS);

1.4.3.3 Types

1.4.3.3.1 Type TSAPxRFCConnectionLoginEventGS Unit


File

gsSAPxRFCClient

Description

Event occurs before opening a connection.

AConnection - Specifies a connection object that is logging.

AParams - Specifies a connection parameters.

Syntax

TSAPxRFCConnectionLoginEventGS = procedure (AConnection: TSAPxRFCCustomConnectionGS; AParams: TSAPxRFCAliasGS) of object;

1.4.3.3.2 Type TSAPxRFCCustomAliasListClassGS Unit


File

gsSAPxRFCClient

Description

Meta class of TSAPxRFCCustomAliasListGS.


120

1

Syntax

TSAPxRFCCustomAliasListClassGS = class of TSAPxRFCCustomAliasListGS;

1.4.4 Unit gsSAPxRFCDataMove

Classes

TSAPxRFCEasyDataMoveGS ( see page 121)

Group


Description

Unit gsSAPxRFCDataMove consist of only TSAPxRFCEasyDataMoveGS ( see page 121) class, which allows to transferSAP table data from SAP server to Connect for SAP® client application.

1.4.4.1 Classes

1.4.4.1.1 Class TSAPxRFCEasyDataMoveGS Fields

Class TSAPxRFCConnectedObjectGS

FPrepared ( see page 225)

Class TSAPxRFCRemoteObjectGS

FDefinitionState ( see page 343)

Unit

Unit gsSAPxRFCDataMove ( see page 121)

Legend

Constructor

All Members

Methods










CheckConnected ( see page 225)

CheckNotPrepared ( see page 225)

1.4 Units Connect for SAP ® Unit gsSAPxRFCDataMove

121

1

CheckPrepared ( see page 225)






InternalPrepare ( see page 227)

InternalUnprepare ( see page 227)

Prepare ( see page 227)

Unprepare ( see page 227)







ObjectDefined ( see page 344)

Class TSAPxRFCEasyDataMoveGS









Properties





AfterPrepareEvent ( see page 227)

AfterUnprepareEvent ( see page 228)

BeforePrepareEvent ( see page 228)

BeforeUnprepareEvent ( see page 228)

Connection ( see page 228)

Name ( see page 228)


Prepared ( see page 229)


AfterCallEvent ( see page 344)

Async ( see page 344)

BeforeCallEvent ( see page 345)



122

1




RowCount ( see page 127)

RowSkips ( see page 127)

Select ( see page 127)

Table ( see page 128)

Where ( see page 128)

Fields





Methods






























123

1










Properties
























Table ( see page 128)


File

gsSAPxRFCDataMove

Description

TSAPxRFCEasyDataMoveGS provides an access to SAP server stored table by executing RFC_READ_TABLE functionmodule.

The Name ( see page 228) property is a SAP server table name. Using of Select ( see page 127) and Where ( seepage 128) properties allows to limit a result dataset. If Select ( see page 127) property is empty then the result dataset willcontain all fields of the specified SAP server table. There is an ability to get a group of records from result data set via a


124

1

manipulation of RowCount ( see page 127) and RowSkips ( see page 127) parameters. The result dataset has only onefield having 512-characters length. Its value contains SAP table one row field values. Each field value occupies fixed widthspace. After defining required properties you can open table using Open ( see page 127) method and access to resultdataset by Table ( see page 128) property.

Example

procedure GetTableData(ARFCEasyDataMove: TSAPxRFCEasyDataMoveGS);begin with ARFCEasyDataMove do begin Name := 'T000'; Select.Add('MANDT'); Select.Add('MTEXT'); Where.Add('MANDT > 0 and '); Where.Add('MTEXT like 'I%'''); Open; with Table do begin { doing something with result dataset} end; end;end;

Syntax

public TSAPxRFCEasyDataMoveGS = class(TSAPxRFCRemoteObjectGS);

1.4.4.1.1.1 Methods

1.4.4.1.1.1.1 Method TSAPxRFCEasyDataMoveGS.CheckActive

Class

Class TSAPxRFCEasyDataMoveGS ( see page 121)

Description

Checks whether or not the result dataset is active. If the dataset is inactive, ESAPxRFCExceptionGS is raised.

Syntax

protected procedure CheckActive;

1.4.4.1.1.1.2 Method TSAPxRFCEasyDataMoveGS.CheckInactive

Class


Description

Checks whether or not the result dataset is inactive. If the dataset is active, ESAPxRFCExceptionGS is raised.

Syntax

protected procedure CheckInactive;

1.4.4.1.1.1.3 Method TSAPxRFCEasyDataMoveGS.Close

Class


Description

Closes the result dataset.

Syntax



125

1

1.4.4.1.1.1.4 Constructor TSAPxRFCEasyDataMoveGS.Create

Class


Description

Creates and initializes a new TSAPxRFCEasyDataMoveGS object.

Syntax


1.4.4.1.1.1.5 Destructor TSAPxRFCEasyDataMoveGS.Destroy

Class


Description

Destroys an instance of TSAPxRFCEasyDataMoveGS.

Syntax


1.4.4.1.1.1.6 Method TSAPxRFCEasyDataMoveGS.InternalPrepare

Class


Description

If Select result dataset does not have any field defined, then InternalPrepare executes actions to prepare datamove forfetching result dataset:

• asks RFC_READ_TABLE to return a list of result dataset field definitions;

• creates fields for Select ( see page 127) result dataset;

• opens Select ( see page 127) result dataset.

Otherwise no actions are performed.

Syntax

protected procedure InternalPrepare; override;

1.4.4.1.1.1.7 Method TSAPxRFCEasyDataMoveGS.InternalUnprepare

Class


Description

Executes actions to unprepare datamove

• unprepare RFC_READ_TABLE function module;

• if Select ( see page 127) result dataset had no fields defined before Prepare ( see page 227) call, then InternalUnprepare removes fields from Select ( see page 127) result dataset.

Syntax

protected procedure InternalUnprepare; override;


126

1

1.4.4.1.1.1.8 Method TSAPxRFCEasyDataMoveGS.Open

Class


Description

Executes the query to SAP server and opens the result dataset.

Syntax



1.4.4.1.1.2.1 Property TSAPxRFCEasyDataMoveGS.Active

Class


Description

Specifies whether or not the result dataset is accessible.

Syntax


1.4.4.1.1.2.2 Property TSAPxRFCEasyDataMoveGS.RowCount

Class


Description

Specified a maximum number of records to be in the result dataset.

Syntax

public property RowCount: Integer;

1.4.4.1.1.2.3 Property TSAPxRFCEasyDataMoveGS.RowSkips

Class


Description

Specified a number of records that have to be skipped in the result dataset before it to be returned.

Syntax

public property RowSkips: Integer;

1.4.4.1.1.2.4 Property TSAPxRFCEasyDataMoveGS.Select

Class


Description

Contains the set of SAP server table fields to be involved in the result dataset. If Select property is empty then the resultdataset will contain all fields of the specified SAP server table.

Syntax

public property Select: TStrings;


127

1

1.4.4.1.1.2.5 Property TSAPxRFCEasyDataMoveGS.Table

Class


Description

Provides an access to result dataset.

Syntax

public property Table: TSAPxRFCTableGS;

1.4.4.1.1.2.6 Property TSAPxRFCEasyDataMoveGS.Where

Class


Description

Contains the set of conditions to limit result dataset. It follows to ANSI SQL WHERE clause syntax, but followingconstructions are not supported:

• functions;

• nested queries.

All non empty lines in TStrings object will be concatenated using AND clause.

Syntax

public property Where: TStrings;

1.4.5 Unit gsSAPxRFCServer

Classes

TSAPxRFCServerApplicationGS ( see page 130)

TSAPxRFCServerCommandLineGS ( see page 137)

TSAPxRFCServerConnectionGS ( see page 141)

TSAPxRFCServerConnectionListGS ( see page 152)

TSAPxRFCServerFunctionGS ( see page 155)

TSAPxRFCSrvConnectionThreadGS ( see page 160)

TSAPxMulticastCheckTIDEventGS ( see page 162)

TSAPxMulticastCommitEventGS ( see page 163)

TSAPxMulticastConfirmEventGS ( see page 164)

TSAPxMulticastRollbackEventGS ( see page 165)

TSAPxMulticastTIDEventGS ( see page 166)

1.4 Units Connect for SAP ® Unit gsSAPxRFCServer

128

1

TSAPxRFCEventCounterGS ( see page 167)

Functions

SAPxRFCServerApplication ( see page 168)

Group


Legend

Enumeration

Records, Enums

TSAPxRFCCheckTIDResultGS ( see page 169)

TSAPxRFCSrvAppActionGS ( see page 169)

TSAPxRFCSrvAppStateGS ( see page 169)

TSAPxRFCSrvConThreadStateGS ( see page 170)

Types

TSAPxRFCServerFunctionExecuteEventGS ( see page 170)

TSAPxRFCSrvAppStatesGS ( see page 171)

TSAPxRFCTxCheckTIDEventGS ( see page 171)

TSAPxRFCTxCommitEventGS ( see page 171)

TSAPxRFCTxConfirmEventGS ( see page 171)

TSAPxRFCTxRollbackEventGS ( see page 172)

TSAPxRFCTxTIDEventGS ( see page 172)

Description

Unit gsSAPxRFCServer contains a set of classes and types to implement a SAP external server.

The TSAPxRFCServerApplicationGS ( see page 130) is the core class, which is basis of non-SAP partner server program.The TSAPxRFCServerApplicationGS ( see page 130) object can include several TSAPxRFCServerConnectionGS ( seepage 141) objects providing an interaction between the server program and a SAP gateway. Each of theTSAPxRFCServerConnectionGS ( see page 141) objects has own thread of TSAPxRFCSrvConnectionThreadGS ( seepage 160) class processing the client requests. The °TSAPxRFCServerFunctionGS ( see page 155) class realizes someportion of the server functionality.

The TSAPxRFCServerCommandLineGS ( see page 137) enables specifying a set of server initial parameters in commandline.

1.4.5.1 Classes


129

1

1.4.5.1.1 Class TSAPxRFCServerApplicationGS Unit

Unit gsSAPxRFCServer ( see page 128)

Legend

Constructor

All Members

Methods









Class TSAPxRFCServerApplicationGS




CanStart ( see page 133)

CanPause ( see page 133)

CanResume ( see page 133)

CanStop ( see page 134)

Start ( see page 134)



Resume ( see page 134)

Pause ( see page 135)

Stop ( see page 135)



Terminated ( see page 135)

Suspended ( see page 136)

Properties





ConnectionCount ( see page 136)

Connections ( see page 136)

TimeOut ( see page 136)

UseTransactionControl ( see page 136)


130

1

Methods













CanStart ( see page 133)

CanPause ( see page 133)

CanResume ( see page 133)

CanStop ( see page 134)




Resume ( see page 134)

Pause ( see page 135)




Terminated ( see page 135)

Suspended ( see page 136)

Properties





ConnectionCount ( see page 136)

Connections ( see page 136)


UseTransactionControl ( see page 136)

File

gsSAPxRFCServer

Description

TSAPxRFCServerApplicationGS encapsulates a set of SAP server programs.

Delphi application may have only single TSAPxRFCServerApplicationGS object, and Connect for SAP® has global functionSAPxRFCServerApplication ( see page 168), returning reference to this object. Connect for SAP® software creates it onprogram startup and destroys at program exit.


131

1

Connect for SAP® programmer should decide how to group server programs into a single Connect for SAP® serverapplication. Here is no limitation from Connect for SAP® side. Each SAP server program has own program-ID and isrepresented by TSAPxRFCServerConnectionGS ( see page 141). Each of them is executed within a dedicated thread(TSAPxRFCSrvConnectionThreadGS ( see page 160)). From technical point of view, TSAPxRFCServerApplicationGS is acontroller for all TSAPxRFCServerConnectionGS ( see page 141)'s in application.

TSAPxRFCServerApplicationGS is controlled by Start ( see page 134), Pause ( see page 135), Resume ( see page134) and Stop ( see page 135) methods. The methods control state of all server connections at once. Although, if onlysome connection should be started or stopped then overloaded Start ( see page 134) and Stop ( see page 135) methodsshould be used.

If you want to check whether an application server is either terminated or suspended, use Terminated ( see page 135) andSuspended ( see page 136) properties. ConnectionCount ( see page 136) and Connections ( see page 136) propertiesgives access to all TSAPxRFCServerConnectionGS ( see page 141) objects in application.

If you want to use tracing, use SAPxRFCSetTracing ( see page 392) global procedure. To check current tracing state useSAPxRFCGetTracing ( see page 390) procedure.

To properly work with tRFC protocol (transactional RFC calls) UseTransactionalControl ( see page 136) propertymust be set to True. Otherwise, the error will be raised.

The following examples shows using TSAPxRFCServerApplicationGS in a service application.

Example

procedure TSAPxRFCServer.ServiceStart(Sender: TService; var Started: Boolean);begin SAPxRFCServerApplication.Tracing := True; SAPxRFCServerApplication.Trace(ClassName, 'ServiceStart: starting ...'); SAPxRFCServerApplication.Start; Started := not SAPxRFCServerApplication.Terminated; if Started then SAPxRFCServerApplication.Trace(ClassName, 'ServiceStart: started ...'); else SAPxRFCServerApplication.Trace(ClassName, 'ServiceStart: could not start');end; procedure TSAPxRFCServer.ServicePause(Sender: TService; var Paused: Boolean);begin SAPxRFCServerApplication.Trace(ClassName, 'ServicePause: pausing ...'); SAPxRFCServerApplication.Pause; SAPxRFCServerApplication.Trace(ClassName, 'ServicePause: paused ...');end; procedure TSAPxRFCServer.ServiceStop(Sender: TService; var Stopped: Boolean);begin SAPxRFCServerApplication.Trace(ClassName, 'ServiceStop: stopping ...'); SAPxRFCServerApplication.Stop; SAPxRFCServerApplication.Trace(ClassName, 'ServiceStop: stopped ...');end;

Syntax

public TSAPxRFCServerApplicationGS = class(TSAPxRFCObjectGS);

1.4.5.1.1.1 Methods


132

1

1.4.5.1.1.1.1 Constructor TSAPxRFCServerApplicationGS.Create

Class

Class TSAPxRFCServerApplicationGS ( see page 130)

Syntax

public constructor Create;

1.4.5.1.1.1.2 Destructor TSAPxRFCServerApplicationGS.Destroy

Class


Description

Destroys an instance of TSAPxRFCApplicationServerGS.

Syntax


1.4.5.1.1.1.3 Method TSAPxRFCServerApplicationGS.GetDataFormat

Class


Description

Gets a reference to a data format object.

Syntax


1.4.5.1.1.1.4 Method TSAPxRFCServerApplicationGS.CanStart

Class


Description

Determines whether at least one application server connection can be started. See also Start ( see page 134) method.

Syntax

public function CanStart: Boolean;

1.4.5.1.1.1.5 Method TSAPxRFCServerApplicationGS.CanPause

Class


Description

Determines whether at least one application server connection can be paused. See also Pause ( see page 135) method.

Syntax

public function CanPause: Boolean;

1.4.5.1.1.1.6 Method TSAPxRFCServerApplicationGS.CanResume

Class


Description

Determines whether at least one application server connection can be resumed. See also Resume ( see page 134) method.


133

1

Syntax

public function CanResume: Boolean;

1.4.5.1.1.1.7 Method TSAPxRFCServerApplicationGS.CanStop

Class


Description

Determines whether at least one application server connection can be stopped. See also Stop ( see page 135) method.

Syntax

public function CanStop: Boolean;

1.4.5.1.1.1.8 Method TSAPxRFCServerApplicationGS.Start ()

Class


Description

Starts all connections in the application server at once. See also CanStart ( see page 133) property.

Syntax

public procedure Start; overload;

1.4.5.1.1.1.9 Method TSAPxRFCServerApplicationGS.Start (TSAPxRFCServerConnectionListGS)

Class


Description

Starts the specified connections.

See also Start ( see page 134) and CanStart ( see page 133).

Syntax

public procedure Start(AConnectionList: TSAPxRFCServerConnectionListGS); overload;

1.4.5.1.1.1.10 Method TSAPxRFCServerApplicationGS.Start (array of TSAPxRFCServerConnectionGS)

Class


Description

Starts the specified connections.

See also Start ( see page 134) and CanStart ( see page 133).

Syntax

public procedure Start(AConnectionList: array of TSAPxRFCServerConnectionGS); overload;

1.4.5.1.1.1.11 Method TSAPxRFCServerApplicationGS.Resume

Class


Description

Resumes all paused application server connections. See also CanResume ( see page 133) property.

Syntax

public procedure Resume;


134

1

1.4.5.1.1.1.12 Method TSAPxRFCServerApplicationGS.Pause

Class


Description

Pauses all started application server connections. When Pause is called idle connection threads are immediatelysuspended. A busy connection will be suspended as soon as a client request processing is finished. See also CanPause (see page 133).

Syntax

public procedure Pause;

1.4.5.1.1.1.13 Method TSAPxRFCServerApplicationGS.Stop ()

Class


Description

Stops all started or paused server connections.

When Stop is called all idle connection threads are immediately terminated. Busy connections will be terminated as soon asa client request processing is finished. See also CanStop ( see page 134).

Syntax

public procedure Stop; overload;

1.4.5.1.1.1.14 Method TSAPxRFCServerApplicationGS.Stop (TSAPxRFCServerConnectionListGS)

Class


Description

Stops specified server connection, which are started or paused.

See Stop ( see page 135) and CanStop ( see page 134).

Syntax

public procedure Stop(AConnectionList: TSAPxRFCServerConnectionListGS); overload;

1.4.5.1.1.1.15 Method TSAPxRFCServerApplicationGS.Stop (array of TSAPxRFCServerConnectionGS)

Class


Description

Stops specified server connection, which are started or paused.

See Stop ( see page 135) and CanStop ( see page 134).

Syntax

public procedure Stop(AConnectionList: array of TSAPxRFCServerConnectionGS); overload;

1.4.5.1.1.1.16 Method TSAPxRFCServerApplicationGS.Terminated

Class


Description

Indicates whether or not all application server connection are terminated.


135

1

Syntax

public function Terminated: Boolean;

1.4.5.1.1.1.17 Method TSAPxRFCServerApplicationGS.Suspended

Class


Description

Indicates whether or not all application server connection are suspended.

Syntax

public function Suspended: Boolean;


1.4.5.1.1.2.1 Property TSAPxRFCServerApplicationGS.ConnectionCount

Class


Description

Returns a number of server connections in application.

Syntax

public property ConnectionCount: Integer;

1.4.5.1.1.2.2 Property TSAPxRFCServerApplicationGS.Connections

Class


Description

Provides an indexed array of all connections in an application server.

Syntax

public property Connections [AIndex: Integer]: TSAPxRFCServerConnectionGS;

1.4.5.1.1.2.3 Property TSAPxRFCServerApplicationGS.TimeOut

Class


Description

Specifies the time, in milliseconds, an application server is waiting for changing a state of the server connection's thread.

Syntax

public property TimeOut: DWORD;

1.4.5.1.1.2.4 Property TSAPxRFCServerApplicationGS.UseTransactionControl

Class


Description

Specifies if the server application should provide transaction control for its connections.

The property has to True when executing the server functions needs to work with tRFC protocol.


136

1

Syntax

public property UseTransactionControl: Boolean;

1.4.5.1.2 Class TSAPxRFCServerCommandLineGS Unit


Legend

Destructor

All Members

Methods


CreateArgv ( see page 138)


FreeArgv ( see page 139)

Properties

Argv ( see page 139)



IniDest ( see page 140)

PROGID ( see page 140)




Methods


CreateArgv ( see page 138)


FreeArgv ( see page 139)

Properties

Argv ( see page 139)



IniDest ( see page 140)

PROGID ( see page 140)




File

gsSAPxRFCServer

Description

TSAPxRFCServerCommandLineGS enables passing the server connection parameters as the command line arguments tothe application. There are two alternate ways to specify the connection parameters. You can specify either combination offollowing parameters - GWHOST ( see page 139), GWSERV ( see page 139), PROGID ( see page 140) andRFC_TRACE ( see page 140) or just IniDest ( see page 140). Usage of IniDest ( see page 140) is more flexible


137

1

approach allowing to use destinations stored in saprfc.ini file.

Note

If there are two or more server connections in an application server, command line must not be used, because theparameters of all connections will be same. In this case you should explicitly specify connection parameters.

Example

The CommandLine is initialized by hard-coded data.

procedure InitConnection(AConnection: TSAPxRFXServerConnectionGS);begin with AConnection do begin OnError := HandleError; with CommandLine do begin PROGID := 'MY_PROG_ID'; GWHOST := 'myhost.com'; GWSERV := 'servgw00'; end; end;end;

The CommandLine is used a destination from saprfc.ini file.

procedure InitConnection(AConnection: TSAPxRFXServerConnectionGS);begin with AConnection do begin OnError := HandleError; CommandLine.IniDest := 'BIN'; end;end;

Syntax

public TSAPxRFCServerCommandLineGS = class(TPersistent);

1.4.5.1.2.1 Methods

1.4.5.1.2.1.1 Method TSAPxRFCServerCommandLineGS.Assign

Class

Class TSAPxRFCServerCommandLineGS ( see page 137)

Description

Copies the contents of another command line.

ASource - Specifies a source command line.

Syntax

public procedure Assign(ASource: TPersistent); override;

1.4.5.1.2.1.2 Method TSAPxRFCServerCommandLineGS.CreateArgv

Class



138

1

Syntax

protected procedure CreateArgv;

1.4.5.1.2.1.3 Destructor TSAPxRFCServerCommandLineGS.Destroy

Class


Description

Destroys an instance of TSAPxRFCServerCommandLineGS.

Syntax


1.4.5.1.2.1.4 Method TSAPxRFCServerCommandLineGS.FreeArgv

Class


Syntax

protected procedure FreeArgv;


1.4.5.1.2.2.1 Property TSAPxRFCServerCommandLineGS.Argv

Class


Description

Specifies the string of connection parameters.

Syntax

public property Argv: ppRfc_char_t;

1.4.5.1.2.2.2 Property TSAPxRFCServerCommandLineGS.GWHOST

Class


Description

Determines a host name of the SAP gateway.

Syntax

published property GWHOST: String;

1.4.5.1.2.2.3 Property TSAPxRFCServerCommandLineGS.GWSERV

Class


Description

Determines a service name of the SAP gateway.

Syntax

published property GWSERV: String;


139

1

1.4.5.1.2.2.4 Property TSAPxRFCServerCommandLineGS.IniDest

Class


Description

Determines a destination name in the INI file. The connection parameters for each destination are specified in theSAPRFC.INI file.

Note

The SAPRFC.INI file must be in the same directory as the RFC client/server program. Otherwise, you have define RFC_INIenvironment variable using a full path and file name.

Example

set RFC_INI=c:\SAPxRFCTest\saprfc.ini

Syntax

published property IniDest: String;

1.4.5.1.2.2.5 Property TSAPxRFCServerCommandLineGS.PROGID

Class


Description

Specifies an identifier of the registered RFC server program.

An RFC server program can be registered under this ID on an SAP gateway and then wait for RFC calls from different SAPsystems.

Syntax

published property PROGID: String;

1.4.5.1.2.2.6 Property TSAPxRFCServerCommandLineGS.RFC_TRACE

Class


Description

Determines whether a tracing is enabled. The tracing is executed by SAP RFC library.

Syntax

published property RFC_TRACE: Boolean;

1.4.5.1.2.2.7 Property TSAPxRFCServerCommandLineGS.SNC_LIB

Class


Syntax

published property SNC_LIB: String;


140

1

1.4.5.1.2.2.8 Property TSAPxRFCServerCommandLineGS.SNC_MYNAME

Class


Syntax

published property SNC_MYNAME: String;

1.4.5.1.3 Class TSAPxRFCServerConnectionGS Fields









Unit


Legend

Constructor

All Members

Methods





















141

1















Class TSAPxRFCServerConnectionGS

Abort ( see page 147)



DoCheckTID ( see page 148)

DoCommit ( see page 148)

DoConfirm ( see page 148)

DoRollback ( see page 148)

FindServerFunction ( see page 149)





ServerFunctionByName ( see page 150)

Properties














142

1












AbortMessage ( see page 150)

CommandLine ( see page 150)


OnCheckTIDEvent ( see page 151)

OnCommitEvent ( see page 151)

OnConfirmEvent ( see page 151)

OnRollbackEvent ( see page 151)

Thread ( see page 152)


Fields









Methods
















143

1





















Abort ( see page 147)







FindServerFunction ( see page 149)





ServerFunctionByName ( see page 150)

Properties










144

1
















AbortMessage ( see page 150)



OnCheckTIDEvent ( see page 151)

OnCommitEvent ( see page 151)

OnConfirmEvent ( see page 151)

OnRollbackEvent ( see page 151)



File

gsSAPxRFCServer

Description

TSAPxRFCServerConnectionGS encapsulates functionality of an external SAP server program.

TSAPxRFCServerApplicationGS completely controls all TSAPxRFCServerConnectionGS's in the server application. Whenthe server application starts with Start ( see page 134) method it open all server connection at once. A specified serverconnection can be open with Start ( see page 134) method and specifying explicitly a list of being opened connections. Onopening a server connection object registers as a SAP server program on a SAP gateway, using parameters fromCommandLine ( see page 150). And installs all functions associated with this connection.

Then server application runs TSAPxRFCSrvConnectionThreadGS ( see page 160) thread for eachTSAPxRFCServerConnectionGS. It dispatches all request's, received from a remote SAP R/3 application server, to aTSAPxRFCServerFunctionGS ( see page 155) function module's associated with this TSAPxRFCServerConnectionGS.The main difference between other application servers and Connect for SAP® application one is only single thread handlesall request's to one TSAPxRFCServerConnectionGS. So, requests from client applications to executeTSAPxRFCServerFunctionGS ( see page 155)'s belonging to the same TSAPxRFCServerConnectionGS will be serialized.

When the server application stops with Stop ( see page 135), it closes all TSAPxRFCServerConnectionGS in theapplication. To stop only specified server connections use overloaded Stop ( see page 135) methods for a list ofconnections.


145

1

TSAPxRFCServerConnectionGS can process call's either as transactional either as non-transactional ones. The four event(OnCheckTID ( see page 151), OnCommit ( see page 151), OnRollback ( see page 151) and OnConfirm ( see page151)) handlers processes a transactional call. When a transaction is about to start, OnCheckTID ( see page 151) eventoccurs. If check result is crOkGS ( see page 169) then the transaction with specified TID is started. Otherwise (check resultis either crErrorGS ( see page 169) or crCancelGS ( see page 169)), the transaction is rejected. If no error was happenedafter starting the transaction the OnConfirm ( see page 151) event occurs. The OnRollback ( see page 151) event comeswhen an error has taken place. OnConfirm ( see page 151) event is used for updating a local transaction managementdata.

A server connection's event handlers are called within a context of the connection's thread. It means that thecode inside the event handlers working with VCL controls must be synchronized with the main thread. Exactway how to solve the task is up to you.

The following example uses a server connection events to control local transaction management.

Example

var FServerConnection: TSAPxRFCServerConnectionGS; FTransList: TStringList; ... procedure Main;begin FTransList := TStringList.Create; try InitializeConnection; FServerConnection.Open; try { do something to process client requests } finally FServerConnection.Close; end; finally FTransList.Free; end;end; procedure InitializeConnection;begin FServerConnection.OnCheckTID := HandleCheckTID; FServerConnection.OnCommit := HandleCommit; FServerConnection.OnRollback := HandleRollback; FServerConnection.OnConfirm := HandleConfirm;end; procedure HandleCheckTID(Sender: TObject; const ATID: String; var AResult: TSAPxRFCCheckTIDResultGS);begin if FTransList.IndexOf(ATID) = -1 then begin FTransList.AddObject(ATID, TObject(tsCreated)); AResult := crOkGS; end else AResult := crCancelGS;end; procedure HandleCommit(Sender: TObject; const ATID: String);var i: Integer;begin i := FTransList.IndexOf(ATID);


146

1

if i <> -1 then begin DBCommit(); // Execute commit of local database transaction FTransList.Objects[i] := TObject(tsExecuted); end;end; procedure HandleConfirm(Sender: TObject; const ATID: String);var i: Integer;begin i := FTransList.IndexOf(ATID); if i <> -1 then FTransList.Delete(i);end; procedure HandleRollback(Sender: TObject; const ATID: String);begin DBRollback(); // Execute roolback of local database transactionend;

Syntax

public TSAPxRFCServerConnectionGS = class(TSAPxRFCCustomConnectionGS);

1.4.5.1.3.1 Methods

1.4.5.1.3.1.1 Method TSAPxRFCServerConnectionGS.Abort

Class

Class TSAPxRFCServerConnectionGS ( see page 141)

Description

Aborts SAP server program, unregistering it from SAP gateway.

AMessage - A message to send to client whose request is processing at moment.

Syntax

public procedure Abort(const AMessage: String);

1.4.5.1.3.1.2 Constructor TSAPxRFCServerConnectionGS.Create

Class


Description

Creates, initializes and adds a new TSAPxRFCServerConnectionGS object to the global TSAPxRFCServerApplicationGS (see page 130) object.

Syntax


1.4.5.1.3.1.3 Destructor TSAPxRFCServerConnectionGS.Destroy

Class


Description

Destroys an instance of TSAPxRFCServerConnectionGS and removes it from connection list of global instance ofTSAPxRFCServerApplicationGS ( see page 130).

Syntax



147

1

1.4.5.1.3.1.4 Method TSAPxRFCServerConnectionGS.DoCheckTID

Class


Description

Procedure is called by Connect for SAP®, when a call to check TID is received from a SAP system. Procedure calls firesOnCheckTIDEvent ( see page 151) event handler.

ATID - Determines TID of checked transaction.

AResult - Indicates a check result.

Syntax

protected procedure DoCheckTID(const ATID: String; var AResult: TSAPxRFCCheckTIDResultGS); virtual;

1.4.5.1.3.1.5 Method TSAPxRFCServerConnectionGS.DoCommit

Class


Description

Procedure is called by Connect for SAP®, when all RFC functions belonging to this transaction are done and the localtransaction can be completed. Procedure fires OnCommitEvent ( see page 151) event handler.

ATID - Determines TID of committed transaction.

Syntax

protected procedure DoCommit(const ATID: String); virtual;

1.4.5.1.3.1.6 Method TSAPxRFCServerConnectionGS.DoConfirm

Class


Description

Procedure is called by Connect for SAP®, when the local transaction is completed. Procedures fires OnConfirmEvent ( seepage 151) event handler.

ATID - Determines TID of confirmed transaction.

Syntax

protected procedure DoConfirm(const ATID: String); virtual;

1.4.5.1.3.1.7 Method TSAPxRFCServerConnectionGS.DoRollback

Class


Description

Procedure is called by Connect for SAP®, instead of the DoCommit ( see page 148) procedure, if there is an erroroccurring in the RFC library while processing the local transaction. Procedure fires OnRollbackEvent ( see page 151) eventhandler.


148

1

ATID - Determines TID of rolled back transaction.

Syntax

protected procedure DoRollback(const ATID: String); virtual;

1.4.5.1.3.1.8 Method TSAPxRFCServerConnectionGS.FindServerFunction

Class


Description

Searches for a specified server function belonging to the server connection. If function will be not found, then functionreturns nil.

AName - Server function name to find.

Returns a reference to found server function or nil.

Syntax

public function FindServerFunction(const AName: String): TSAPxRFCServerFunctionGS;

1.4.5.1.3.1.9 Method TSAPxRFCServerConnectionGS.GetDataFormat

Class


Description

Gets a reference to a data format object.

Syntax


1.4.5.1.3.1.10 Method TSAPxRFCServerConnectionGS.GetParentDataFormat

Class


Description

Gets a reference to a parent data format object.

Syntax

protected function GetParentDataFormat: TSAPxRFCDataFormatGS; override;

1.4.5.1.3.1.11 Method TSAPxRFCServerConnectionGS.InternalForceDisconnect

Class


Description

Executes some internal actions to terminate SAP server program registration at SAP gateway.

Syntax

protected procedure InternalForceDisconnect; override;

1.4.5.1.3.1.12 Method TSAPxRFCServerConnectionGS.Open

Class



149

1

Description

The method registers server connection object as a SAP server program on a SAP gateway, using parameters fromCommandLine ( see page 150). And installs all functions related to this connection.

TSAPxRFCServerApplicationGS ( see page 130) automatically calls this method at Start ( see page 134) call for allTSAPxRFCServerConnectionGS ( see page 141) objects in application.

Syntax

protected procedure Open; override;

1.4.5.1.3.1.13 Method TSAPxRFCServerConnectionGS.ServerFunctionByName

Class


Description

Searches for a specified server function belonging to the server connection. If function will be not found,ESAPxRFCExceptionGS exception will be raised.

AName - Server function name to find.

Returns a reference to found server function.

Syntax

public function ServerFunctionByName(const AName: String): TSAPxRFCServerFunctionGS;


1.4.5.1.3.2.1 Property TSAPxRFCServerConnectionGS.AbortMessage

Class


Description

Contains a text message, which is specified when aborting the connection with Abort ( see page 147) method. Usually itdescribes a reason of aborting.

Syntax

public property AbortMessage: String;

1.4.5.1.3.2.2 Property TSAPxRFCServerConnectionGS.CommandLine

Class


Description

Contains information to connection with a SAP gateway. TSAPxRFCServerConnectionGS ( see page 141) uses theinformation to register itself as a SAP server program with PROGID ( see page 140) program identifier.

Syntax

public property CommandLine: TSAPxRFCServerCommandLineGS;

1.4.5.1.3.2.3 Property TSAPxRFCServerConnectionGS.DataFormat

Class



150

1

Description

Returns a reference to a data format object. The data format object controls how Delphi data types maps to the SAP RFCdata types.

Syntax

public property DataFormat: TSAPxRFCDataFormatGS;

1.4.5.1.3.2.4 Property TSAPxRFCServerConnectionGS.OnCheckTIDEvent

Class


Description

The multicast event handler that notifies its subscribers when a call to check TID is received from a SAP system. It occursbefore starting a transaction with the specified TID.

Use the event to store this TID in a permanent storage. If the same transaction will be called again later with the same TID, ithas to make sure that AResult value is crCancelGS ( see page 169). If the same TID has been already run by anotherprocess but not completed yet, the program has to wait until the transaction finishes or to stop the sever connection withAbort ( see page 147).

Syntax

public property OnCheckTIDEvent: TSAPxMulticastCheckTIDEventGS;

1.4.5.1.3.2.5 Property TSAPxRFCServerConnectionGS.OnCommitEvent

Class


Description

The multicast event handler that notifies its subscribers when all RFC functions belonging to this transaction has been doneand the local transaction can be completed.

Use the event to locally commit the transaction if necessary (e.g. when working with a database).

Syntax

public property OnCommitEvent: TSAPxMulticastCommitEventGS;

1.4.5.1.3.2.6 Property TSAPxRFCServerConnectionGS.OnConfirmEvent

Class


Description

The multicast event handler that notifies its subscribers when the local transaction is completed.

Use this event to delete all information relative to the current transaction.

Syntax

public property OnConfirmEvent: TSAPxMulticastConfirmEventGS;

1.4.5.1.3.2.7 Property TSAPxRFCServerConnectionGS.OnRollbackEvent

Class


Description

The multicast event handler that notifies its subscribers if an error occurs in the RFC library while processing the localtransaction. In such a case the event fires instead of OnCommitEvent ( see page 151).

Use this event to roll back the local transaction (e.g. when working with a database).


151

1

Syntax

public property OnRollbackEvent: TSAPxMulticastRollbackEventGS;

1.4.5.1.3.2.8 Property TSAPxRFCServerConnectionGS.Thread

Class


Description

Returns a reference to the dedicated thread for the server connection. The thread is the instance of theTSAPxRFCSrvConnectionThreadGS ( see page 160) class that is the dedicated thread for the server connection. Eachserver connection in the server application has a dedicated thread that contains a loop in its Execute method for processingserver application requests.

Syntax

public property Thread: TSAPxRFCSrvConnectionThreadGS;

1.4.5.1.3.2.9 Property TSAPxRFCServerConnectionGS.TimeOut

Class


Description

Specifies the time, in milliseconds, for which to wait for opening the server connection. If the time is expired and theconnection do not open, the server aborts connecting.

Syntax

public property TimeOut: DWORD;

1.4.5.1.4 Class TSAPxRFCServerConnectionListGS Unit


Legend

Constructor

All Members

Methods





Class TSAPxRFCServerConnectionListGS

Add ( see page 153)

Add ( see page 153)



GetItemsForAction ( see page 154)

GetItemsForState ( see page 154)

Remove ( see page 154)

Properties


152

1



Items ( see page 154)

Methods






Add ( see page 153)

Add ( see page 153)



GetItemsForAction ( see page 154)

GetItemsForState ( see page 154)


Properties




File

gsSAPxRFCServer

Description

Manages with a list of server connections.

Syntax

public TSAPxRFCServerConnectionListGS = class(TSAPxRFCObjectBaseGS);

1.4.5.1.4.1 Methods

1.4.5.1.4.1.1 Method TSAPxRFCServerConnectionListGS.Add (TSAPxRFCServerConnectionGS)

Class

Class TSAPxRFCServerConnectionListGS ( see page 152)

Syntax

public procedure Add(AConnection: TSAPxRFCServerConnectionGS); overload;

1.4.5.1.4.1.2 Method TSAPxRFCServerConnectionListGS.Add (array of TSAPxRFCServerConnectionGS)

Class


Syntax

public procedure Add(AConnectionList: array of TSAPxRFCServerConnectionGS); overload;

1.4.5.1.4.1.3 Constructor TSAPxRFCServerConnectionListGS.Create

Class



153

1

Syntax


1.4.5.1.4.1.4 Destructor TSAPxRFCServerConnectionListGS.Destroy

Class


Syntax


1.4.5.1.4.1.5 Method TSAPxRFCServerConnectionListGS.GetItemsForAction

Class


Syntax

public function GetItemsForAction(AAction: TSAPxRFCSrvAppActionGS; AList: TSAPxRFCServerConnectionListGS = nil): Integer;

1.4.5.1.4.1.6 Method TSAPxRFCServerConnectionListGS.GetItemsForState

Class


Syntax

public function GetItemsForState(AState: TSAPxRFCSrvAppStateGS; AList: TSAPxRFCServerConnectionListGS = nil): Integer;

1.4.5.1.4.1.7 Method TSAPxRFCServerConnectionListGS.Remove

Class


Syntax

public procedure Remove(AConnection: TSAPxRFCServerConnectionGS);


1.4.5.1.4.2.1 Property TSAPxRFCServerConnectionListGS.Count

Class


Syntax


1.4.5.1.4.2.2 Property TSAPxRFCServerConnectionListGS.Items

Class


Syntax

public property Items [AIndex: Integer]: TSAPxRFCServerConnectionGS;


154

1

1.4.5.1.5 Class TSAPxRFCServerFunctionGS Events

Class TSAPxRFCServerFunctionGS

OnExecute ( see page 160)

Fields



Unit


Legend

Constructor

All Members

Methods























CheckDefinition ( see page 158)



DoExecute ( see page 158)




155

1

Properties















Docu ( see page 159)

InParameters ( see page 159)

OutParameters ( see page 160)

Tables ( see page 160)

Fields



Events



Methods


















156

1













Properties



















File

gsSAPxRFCServer

Description

TSAPxRFCServerFunctionGS encapsulates a server function belonging to a SAP server program. The last one isrepresented by TSAPxRFCServerConnectionGS ( see page 141).

The Connection ( see page 228) property links a function to a server program. The Name ( see page 228) identifies aserver function name for ABAP/4. You need to assign OnExecute ( see page 160) event handler and implement thefunction inside the handler. The InParameters ( see page 159) allows you to access input parameters during the functionexecution. Output parameters are placed in the OutParameters ( see page 160) list. The Tables ( see page 160) propertyallows operating the function's tables.


157

1

Example

procedure TInfoServer.OnExecuteHandler(AFunction: TSAPxRFCServerFunctionGS);var s: String; oTable: TSAPxRFCTableGS;begin s := AFunction.InParameters.ParameterByName('INPUT').AsString; oTable := AFunction.Tables.TableByName('DATA'); oTable.First; while not oTable.EOF do begin { do something with table data } oTable.Next; end; AFunction.OutParameters.ParameterByName('SUM').AsDouble := Calculate(s);end;

Syntax

public TSAPxRFCServerFunctionGS = class(TSAPxRFCConnectedObjectGS);

1.4.5.1.5.1 Methods

1.4.5.1.5.1.1 Method TSAPxRFCServerFunctionGS.CheckDefinition

Class

Class TSAPxRFCServerFunctionGS ( see page 155)

Syntax

protected procedure CheckDefinition;

1.4.5.1.5.1.2 Constructor TSAPxRFCServerFunctionGS.Create

Class


Description

Creates a new TSAPxRFCServerFunctionGS object.

Syntax


1.4.5.1.5.1.3 Destructor TSAPxRFCServerFunctionGS.Destroy

Class


Description

Destroys an instance of TSAPxRFCServerFunctionGS.

Syntax


1.4.5.1.5.1.4 Method TSAPxRFCServerFunctionGS.DoExecute

Class


Description

Procedure is called by Connect for SAP®, when program receives request to execute this function. Procedure callsOnExecute ( see page 160) event handler, if it is assigned.


158

1

Syntax

protected procedure DoExecute; virtual;

1.4.5.1.5.1.5 Method TSAPxRFCServerFunctionGS.InternalPrepare

Class


Description

Install function as part of SAP server program.

Syntax


1.4.5.1.5.1.6 Method TSAPxRFCServerFunctionGS.InternalUnprepare

Class


Description

Uninstall function as part of SAP server program.

Syntax



1.4.5.1.5.2.1 Property TSAPxRFCServerFunctionGS.Connection

Class


Syntax

public property Connection: TSAPxRFCServerConnectionGS;

1.4.5.1.5.2.2 Property TSAPxRFCServerFunctionGS.Docu

Class


Description

Contents the short description of function parameters and abilities.

Syntax

public property Docu: TStrings;

1.4.5.1.5.2.3 Property TSAPxRFCServerFunctionGS.InParameters

Class


Description

Stores the input parameters for the server function.

Syntax

public property InParameters: TSAPxRFCParametersListGS;


159

1

1.4.5.1.5.2.4 Property TSAPxRFCServerFunctionGS.OutParameters

Class


Description

Stores the output parameters for the server function.

Syntax

public property OutParameters: TSAPxRFCParametersListGS;

1.4.5.1.5.2.5 Property TSAPxRFCServerFunctionGS.Tables

Class


Description

Stores the server function's table list.

Syntax

public property Tables: TSAPxRFCTablesListGS;

1.4.5.1.5.3 Events

1.4.5.1.5.3.1 Event TSAPxRFCServerFunctionGS.OnExecute

Class


Description

Event occurs when the server function is called from a SAP system. It should read InParameters ( see page 159) andTables ( see page 160). Then perform business actions and send values back in OutParameters ( see page 160) andTables ( see page 160). Example of event handler see there ( see page 155).

Syntax

public property OnExecute: TSAPxRFCServerFunctionExecuteEventGS;

1.4.5.1.6 Class TSAPxRFCSrvConnectionThreadGS Unit


Legend

Constructor

All Members

Methods



Execute ( see page 161)

IsSuspended ( see page 162)

IsTerminated ( see page 162)


160

1

Methods



Execute ( see page 161)

IsSuspended ( see page 162)

IsTerminated ( see page 162)

File

gsSAPxRFCServer

Description

TSAPxRFCSrvConnectionThreadGS represents the thread associated with a specific server connection(TSAPxRFCServerConnectionGS ( see page 141) object).

TSAPxRFCSrvConnectionThreadGS is the dedicated thread for the server connection. It has Execute ( see page 161)method that contains a loop processing server application requests. Thread objects are completely maintained byTSAPxRFCServerApplicationGS ( see page 130). Programmer will not create / destroy them by hands.

Syntax

public TSAPxRFCSrvConnectionThreadGS = class(TThread);

1.4.5.1.6.1 Methods

1.4.5.1.6.1.1 Constructor TSAPxRFCSrvConnectionThreadGS.Create

Class

Class TSAPxRFCSrvConnectionThreadGS ( see page 160)

Description

Creates and initializes a new TSAPxRFCSrvConnectionThreadGS object and suspends it.

Syntax

public constructor Create(AConnection: TSAPxRFCServerConnectionGS);

1.4.5.1.6.1.2 Destructor TSAPxRFCSrvConnectionThreadGS.Destroy

Class


Description

Destroys an instance of TSAPxRFCSrvConnectionThreadGS.

Syntax


1.4.5.1.6.1.3 Method TSAPxRFCSrvConnectionThreadGS.Execute

Class


Description

Implements a loop to process the client requests.

Syntax

protected procedure Execute; override;


161

1

1.4.5.1.6.1.4 Method TSAPxRFCSrvConnectionThreadGS.IsSuspended

Class


Description

Returns True, if thread is suspended.

Syntax

public function IsSuspended: Boolean;

1.4.5.1.6.1.5 Method TSAPxRFCSrvConnectionThreadGS.IsTerminated

Class


Description

Returns True, if thread is terminated.

Syntax

public function IsTerminated: Boolean;

1.4.5.1.7 Class TSAPxMulticastCheckTIDEventGS Unit


All Members

Methods

Add ( see page 407)

IndexOf ( see page 407)

IsEmpty ( see page 407)


Class TSAPxMulticastCheckTIDEventGS

Add ( see page 163)

Call ( see page 163)


Properties


Methods ( see page 408)

Methods

Add ( see page 407)




Class TSAPxMulticastCheckTIDEventGS

Add ( see page 163)




162

1

Properties



File

gsSAPxRFCServer

Syntax

public TSAPxMulticastCheckTIDEventGS = class(TSAPxMulticastEventBaseGS);

1.4.5.1.7.1 Methods

1.4.5.1.7.1.1 Method TSAPxMulticastCheckTIDEventGS.Add

Class

Class TSAPxMulticastCheckTIDEventGS ( see page 162)

Syntax

public procedure Add(AHandler: TSAPxRFCTxCheckTIDEventGS);

1.4.5.1.7.1.2 Method TSAPxMulticastCheckTIDEventGS.Call

Class


Syntax

public procedure Call(Sender: TObject; const ATID: String; var AResult: TSAPxRFCCheckTIDResultGS);

1.4.5.1.7.1.3 Method TSAPxMulticastCheckTIDEventGS.Remove

Class


Syntax

public procedure Remove(AHandler: TSAPxRFCTxCheckTIDEventGS);

1.4.5.1.8 Class TSAPxMulticastCommitEventGS Unit


All Members

Methods

Add ( see page 407)




Class TSAPxMulticastTIDEventGS

Add ( see page 166)




163

1

Properties



Methods

Add ( see page 407)





Add ( see page 166)



Properties



File

gsSAPxRFCServer

Syntax

public TSAPxMulticastCommitEventGS = class(TSAPxMulticastTIDEventGS);

1.4.5.1.9 Class TSAPxMulticastConfirmEventGS Unit


All Members

Methods

Add ( see page 407)





Add ( see page 166)



Properties



Methods

Add ( see page 407)





164

1


Add ( see page 166)



Properties



File

gsSAPxRFCServer

Syntax

public TSAPxMulticastConfirmEventGS = class(TSAPxMulticastTIDEventGS);

1.4.5.1.10 Class TSAPxMulticastRollbackEventGS Unit


All Members

Methods

Add ( see page 407)





Add ( see page 166)



Properties



Methods

Add ( see page 407)





Add ( see page 166)



Properties



File

gsSAPxRFCServer


165

1

Syntax

public TSAPxMulticastRollbackEventGS = class(TSAPxMulticastTIDEventGS);

1.4.5.1.11 Class TSAPxMulticastTIDEventGS Unit


All Members

Methods

Add ( see page 407)





Add ( see page 166)



Properties



Methods

Add ( see page 407)





Add ( see page 166)



Properties



File

gsSAPxRFCServer

Syntax

public TSAPxMulticastTIDEventGS = class(TSAPxMulticastEventBaseGS);

1.4.5.1.11.1 Methods

1.4.5.1.11.1.1 Method TSAPxMulticastTIDEventGS.Add

Class

Class TSAPxMulticastTIDEventGS ( see page 166)

Syntax

public procedure Add(AHandler: TSAPxRFCTxTIDEventGS);


166

1

1.4.5.1.11.1.2 Method TSAPxMulticastTIDEventGS.Call

Class


Syntax

public procedure Call(Sender: TObject; const ATID: String);

1.4.5.1.11.1.3 Method TSAPxMulticastTIDEventGS.Remove

Class


Syntax

public procedure Remove(AHandler: TSAPxRFCTxTIDEventGS);

1.4.5.1.12 Class TSAPxRFCEventCounterGS Unit


Legend

Constructor

All Members

Methods

BeginEvent ( see page 167)



EndEvent ( see page 168)

Wait ( see page 168)

Methods

BeginEvent ( see page 167)



EndEvent ( see page 168)

Wait ( see page 168)

File

gsSAPxRFCServer

Syntax

public TSAPxRFCEventCounterGS = class(TObject);

1.4.5.1.12.1 Methods

1.4.5.1.12.1.1 Method TSAPxRFCEventCounterGS.BeginEvent

Class

Class TSAPxRFCEventCounterGS ( see page 167)

Syntax

public procedure BeginEvent;


167

1

1.4.5.1.12.1.2 Constructor TSAPxRFCEventCounterGS.Create

Class


Syntax


1.4.5.1.12.1.3 Destructor TSAPxRFCEventCounterGS.Destroy

Class


Syntax


1.4.5.1.12.1.4 Method TSAPxRFCEventCounterGS.EndEvent

Class


Syntax

public procedure EndEvent;

1.4.5.1.12.1.5 Method TSAPxRFCEventCounterGS.Wait

Class


Syntax

public procedure Wait(ATimeOut: DWORD);

1.4.5.2 Functions

1.4.5.2.1 Function SAPxRFCServerApplication Unit


File

gsSAPxRFCServer

Description

Returns a global instance of TSAPxRFCServerApplicationGS ( see page 130) class to manage interaction with the externalSAP server.

Syntax

function SAPxRFCServerApplication: TSAPxRFCServerApplicationGS;



168

1

1.4.5.3.1 Enumeration TSAPxRFCCheckTIDResultGS All Members


crOkGS A new transaction may start.

crCancelGS A new transaction must be canceled because a transaction with the same TID has been called.

crErrorGS A new transaction must be canceled because an internal error occurred.

Unit


File

gsSAPxRFCServer

Description

TSAPxRFCCheckTIDResultGS determines a respond when there is an attempt to start a transaction with a TID. Thisrespond affects a transaction behavior.

Syntax

public TSAPxRFCCheckTIDResultGS = ( crOkGS, crCancelGS, crErrorGS);

1.4.5.3.2 Enumeration TSAPxRFCSrvAppActionGS Unit


File

gsSAPxRFCServer

Syntax

public TSAPxRFCSrvAppActionGS = ( saStartGS, saPauseGS, saResumeGS, saStopGS);

1.4.5.3.3 Enumeration TSAPxRFCSrvAppStateGS All Members


ssInactiveGS An application server is inactive.

ssActiveGS An application server is started.

ssPausedGS An application server is paused.

Unit


File

gsSAPxRFCServer


169

1

Description

Determines the operating mode of an application server.

Syntax

public TSAPxRFCSrvAppStateGS = ( ssInactiveGS, ssActiveGS, ssPausedGS);

1.4.5.3.4 Enumeration TSAPxRFCSrvConThreadStateGS All Members


tsExecuteGS The thread receives client requests.

tsSuspendGS The thread is suspended.

tsTerminateGS The thread is terminated.

Unit


File

gsSAPxRFCServer

Description

TSAPxRFCSrvConThreadStateGS values indicate the state of TSAPxRFCSrvConnectionThreadGS ( see page 160) object.

Syntax

public TSAPxRFCSrvConThreadStateGS = ( tsExecuteGS, tsSuspendGS, tsTerminateGS);

1.4.5.4 Types

1.4.5.4.1 Type TSAPxRFCServerFunctionExecuteEventGS Unit


File

gsSAPxRFCServer

Description

Event of TSAPxRFCServerFunctionExecuteEventGS type occurs when a registered server function is called from a SAPsystem.

AFunction - Specifies a server function object to be executed.

Syntax

TSAPxRFCServerFunctionExecuteEventGS = procedure (AFunction: TSAPxRFCServerFunctionGS) of object;


170

1

1.4.5.4.2 Type TSAPxRFCSrvAppStatesGS Unit


File

gsSAPxRFCServer

Description

A set of TSAPxRFCSrvAppStateGS ( see page 169) values.

Syntax

TSAPxRFCSrvAppStatesGS = set of TSAPxRFCSrvAppStateGS;

1.4.5.4.3 Type TSAPxRFCTxCheckTIDEventGS Unit


File

gsSAPxRFCServer

Description

Event occurs when a call checking TID is received from a SAP system.

ATID - Specifies a ID of transaction is about to be started.

AResult - Determines a check result.

Syntax

TSAPxRFCTxCheckTIDEventGS = procedure (Sender: TObject; const ATID: String; var AResult: TSAPxRFCCheckTIDResultGS) of object;

1.4.5.4.4 Type TSAPxRFCTxCommitEventGS Unit


File

gsSAPxRFCServer

Description

Event occurs when all RFC functions belonging to this transaction are done and the local transaction can be completed.


Syntax

TSAPxRFCTxCommitEventGS = TSAPxRFCTxTIDEventGS;

1.4.5.4.5 Type TSAPxRFCTxConfirmEventGS Unit



171

1

File

gsSAPxRFCServer

Description

Event occurs when the local transaction is completed.


Syntax

TSAPxRFCTxConfirmEventGS = TSAPxRFCTxTIDEventGS;

1.4.5.4.6 Type TSAPxRFCTxRollbackEventGS Unit


File

gsSAPxRFCServer

Description

Event occurs instead of the OnCommit event if there is an error occurring in the RFC library while processing the localtransaction.


Syntax

TSAPxRFCTxRollbackEventGS = TSAPxRFCTxTIDEventGS;

1.4.5.4.7 Type TSAPxRFCTxTIDEventGS Unit


File

gsSAPxRFCServer

Syntax

TSAPxRFCTxTIDEventGS = procedure (Sender: TObject; const ATID: String) of object;

1.4.6 Unit gsSAPxRFCStdFunc

Classes

TSAPxRFCFunctionFactoryGS ( see page 173)

TSAPxRFCFunctionSearchGS ( see page 174)

TSAPxRFCGetFunctionInterfaceGS ( see page 178)

TSAPxRFCGetFunctionInterfaceUSGS ( see page 182)

TSAPxRFCGetStructureDefinitionGS ( see page 187)

1.4 Units Connect for SAP ® Unit gsSAPxRFCStdFunc

172

1

TSAPxRFCGetUnicodeStructureGS ( see page 191)

TSAPxRFCGroupSearchGS ( see page 195)

TSAPxRFCReadTableGS ( see page 200)

TSAPxRFCSIStrGS ( see page 205)

TSAPxRFCSystemInfoGS ( see page 209)

Constants

CSAPXRFCReadTabWASize ( see page 214)

Group


Description

Unit gsSAPxRFCStdFunc keeps a set of classes, each of them realize wrapper for SAP function modules used by Connectfor SAP®.

1.4.6.1 Classes

1.4.6.1.1 Class TSAPxRFCFunctionFactoryGS Unit

Unit gsSAPxRFCStdFunc ( see page 172)

All Members

Methods

CreateGetStructureFunction ( see page 173)

Methods

CreateGetStructureFunction ( see page 173)

File

gsSAPxRFCStdFunc

Syntax

public TSAPxRFCFunctionFactoryGS = class(TObject);

1.4.6.1.1.1 Methods

1.4.6.1.1.1.1 Method TSAPxRFCFunctionFactoryGS.CreateGetStructureFunction

Class

Class TSAPxRFCFunctionFactoryGS ( see page 173)

Syntax

public class function CreateGetStructureFunction(AConnection): TSAPxRFCFunctionGS;


173

1

1.4.6.1.2 Class TSAPxRFCFunctionSearchGS Fields





Unit


Legend

Constructor

All Members

Methods

OnError ( see page 389)

Class TSAPxRFCTracingObjectGS





























174

1


Class TSAPxRFCFunctionGS

_AddRef ( see page 305)

_Release ( see page 305)



DefineParam ( see page 306)

DefineTable ( see page 306)


ExecFunction ( see page 306)

FindInParameter ( see page 307)

FindOutParameter ( see page 307)

FindTable ( see page 307)


InParameterByName ( see page 308)




OutParameterByName ( see page 308)

QueryInterface ( see page 308)

TableByName ( see page 309)

Class TSAPxRFCFunctionSearchGS


Properties




















175

1


CallType ( see page 309)

InParams ( see page 309)

OutParams ( see page 309)


Fields





Methods
































176

1





















Class TSAPxRFCFunctionSearchGS


Properties























177

1



File

gsSAPxRFCStdFunc

Syntax

public TSAPxRFCFunctionSearchGS = class(TSAPxRFCFunctionGS);

1.4.6.1.2.1 Methods

1.4.6.1.2.1.1 Constructor TSAPxRFCFunctionSearchGS.Create

Class

Class TSAPxRFCFunctionSearchGS ( see page 174)

Syntax


1.4.6.1.3 Class TSAPxRFCGetFunctionInterfaceGS Fields





Unit


Legend

Constructor

All Members

Methods
















178

1





































Class TSAPxRFCGetFunctionInterfaceGS


Properties





179

1





















Fields





Methods



















180

1


































Class TSAPxRFCGetFunctionInterfaceGS


Properties









181

1

















File

gsSAPxRFCStdFunc

Syntax

public TSAPxRFCGetFunctionInterfaceGS = class(TSAPxRFCFunctionGS);

1.4.6.1.3.1 Methods

1.4.6.1.3.1.1 Constructor TSAPxRFCGetFunctionInterfaceGS.Create

Class

Class TSAPxRFCGetFunctionInterfaceGS ( see page 178)

Syntax


1.4.6.1.4 Class TSAPxRFCGetFunctionInterfaceUSGS Fields





Unit


Legend

Constructor


182

1

All Members

Methods













































183

1








Class TSAPxRFCGetFunctionInterfaceUSGS


Properties
























Fields





Methods



184

1















































185

1





Class TSAPxRFCGetFunctionInterfaceUSGS


Properties
























File

gsSAPxRFCStdFunc

Syntax

public TSAPxRFCGetFunctionInterfaceUSGS = class(TSAPxRFCFunctionGS);

1.4.6.1.4.1 Methods

1.4.6.1.4.1.1 Constructor TSAPxRFCGetFunctionInterfaceUSGS.Create

Class

Class TSAPxRFCGetFunctionInterfaceUSGS ( see page 182)

Syntax



186

1

1.4.6.1.5 Class TSAPxRFCGetStructureDefinitionGS Fields





Unit


Legend

Constructor

All Members

Methods































187

1






















Class TSAPxRFCGetStructureDefinitionGS


Properties




















188

1






Fields





Methods
































189

1





















Class TSAPxRFCGetStructureDefinitionGS


Properties























190

1



File

gsSAPxRFCStdFunc

Syntax

public TSAPxRFCGetStructureDefinitionGS = class(TSAPxRFCFunctionGS);

1.4.6.1.5.1 Methods

1.4.6.1.5.1.1 Constructor TSAPxRFCGetStructureDefinitionGS.Create

Class

Class TSAPxRFCGetStructureDefinitionGS ( see page 187)

Syntax


1.4.6.1.6 Class TSAPxRFCGetUnicodeStructureGS Fields





Unit


Legend

Constructor

All Members

Methods
















191

1





































Class TSAPxRFCGetUnicodeStructureGS


Properties





192

1





















Fields





Methods



















193

1


































Class TSAPxRFCGetUnicodeStructureGS


Properties









194

1

















File

gsSAPxRFCStdFunc

Syntax

public TSAPxRFCGetUnicodeStructureGS = class(TSAPxRFCFunctionGS);

1.4.6.1.6.1 Methods

1.4.6.1.6.1.1 Constructor TSAPxRFCGetUnicodeStructureGS.Create

Class

Class TSAPxRFCGetUnicodeStructureGS ( see page 191)

Syntax


1.4.6.1.7 Class TSAPxRFCGroupSearchGS Fields





Unit


Legend

Constructor


195

1

All Members

Methods













































196

1








Class TSAPxRFCGroupSearchGS


Properties
























Fields





Methods



197

1















































198

1





Class TSAPxRFCGroupSearchGS


Properties
























File

gsSAPxRFCStdFunc

Syntax

public TSAPxRFCGroupSearchGS = class(TSAPxRFCFunctionGS);

1.4.6.1.7.1 Methods

1.4.6.1.7.1.1 Constructor TSAPxRFCGroupSearchGS.Create

Class

Class TSAPxRFCGroupSearchGS ( see page 195)

Syntax



199

1

1.4.6.1.8 Class TSAPxRFCReadTableGS Fields





Unit


Legend

Constructor

All Members

Methods































200

1






















Class TSAPxRFCReadTableGS


Properties




















201

1






Fields





Methods
































202

1





















Class TSAPxRFCReadTableGS


Properties























203

1



File

gsSAPxRFCStdFunc

Syntax

public TSAPxRFCReadTableGS = class(TSAPxRFCFunctionGS);

1.4.6.1.8.1 Methods

1.4.6.1.8.1.1 Constructor TSAPxRFCReadTableGS.Create

Class

Class TSAPxRFCReadTableGS ( see page 200)

Syntax


1.4.6.1.9 Class TSAPxRFCSIStrGS Unit


Legend

Constructor

All Members

Methods









Class TSAPxRFCDataObjectGS



GetRfcData ( see page 259)

GetRfcDataSize ( see page 259)

ReadFromBuffer ( see page 259)

WriteToBuffer ( see page 260)

Class TSAPxRFCListObjectGS




GetName ( see page 312)


204

1


ObjectDataChanged ( see page 313)

ObjectDataChanging ( see page 313)

SetName ( see page 313)

Class TSAPxRFCParameterGS





Erase ( see page 329)






Class TSAPxRFCSIStrGS


Properties





RfcData ( see page 260)


Description ( see page 313)

List ( see page 314)



AsBCD ( see page 330)

AsByte ( see page 330)

AsBytes ( see page 331)

AsDate ( see page 331)

AsDouble ( see page 331)

AsInteger ( see page 331)

AsNumber ( see page 331)

AsString ( see page 332)

AsStruct ( see page 332)

AsTime ( see page 332)

AsVarBytes ( see page 332)

AsVariant ( see page 332)

AsVarString ( see page 333)

AsWord ( see page 333)

AsXMLString ( see page 333)

CharacterSize ( see page 333)


205

1

DataLength ( see page 333)

DataPtr ( see page 334)

DataSize ( see page 334)

DataType ( see page 334)

Decimals ( see page 334)

IsNull ( see page 334)

ParameterType ( see page 334)

StructName ( see page 335)

SubFields ( see page 335)

TypeHandle ( see page 335)

Methods




































206

1


Class TSAPxRFCSIStrGS


Properties





































File

gsSAPxRFCStdFunc

Syntax

public TSAPxRFCSIStrGS = class(TSAPxRFCParameterGS);


207

1

1.4.6.1.9.1 Methods

1.4.6.1.9.1.1 Constructor TSAPxRFCSIStrGS.Create

Class

Class TSAPxRFCSIStrGS ( see page 205)

Syntax


1.4.6.1.10 Class TSAPxRFCSystemInfoGS Fields





Unit


Legend

Constructor

All Members

Methods























208

1






























Class TSAPxRFCSystemInfoGS


Properties














209

1












Fields





Methods




























210

1

























Class TSAPxRFCSystemInfoGS


Properties



















211

1







File

gsSAPxRFCStdFunc

Syntax

public TSAPxRFCSystemInfoGS = class(TSAPxRFCFunctionGS);

1.4.6.1.10.1 Methods

1.4.6.1.10.1.1 Constructor TSAPxRFCSystemInfoGS.Create

Class

Class TSAPxRFCSystemInfoGS ( see page 209)

Syntax


1.4.6.2 Constants

1.4.6.2.1 Constant CSAPXRFCReadTabWASize Unit


File

gsSAPxRFCStdFunc

Syntax

CSAPXRFCReadTabWASize = 512 * SizeOf(Char);

1.4.7 Unit gsSAPxRFCStdObj

Classes

ESAPxRFCCustomExceptionGS ( see page 218)

ESAPxRFCNativeExceptionGS ( see page 220)

TSAPxMulticastErrorEventGS ( see page 221)

TSAPxRFCConnectedObjectGS ( see page 222)

TSAPxRFCConnectionAttributesGS ( see page 229)

TSAPxRFCCustomConnectionGS ( see page 236)

1.4 Units Connect for SAP ® Unit gsSAPxRFCStdObj

212

1

TSAPxRFCDataFormatGS ( see page 250)

TSAPxRFCDataObjectGS ( see page 257)

TSAPxRFCEnvironmentGS ( see page 260)

TSAPxRFCErrorInfoGS ( see page 280)

TSAPxRFCFieldGS ( see page 281)

TSAPxRFCFieldsListGS ( see page 293)

TSAPxRFCFunctionGS ( see page 299)

TSAPxRFCListObjectGS ( see page 310)

TSAPxRFCObjectBaseGS ( see page 314)

TSAPxRFCObjectGS ( see page 314)

TSAPxRFCObjectsListGS ( see page 316)

TSAPxRFCParameterGS ( see page 324)

TSAPxRFCParametersListGS ( see page 335)

TSAPxRFCRemoteObjectGS ( see page 340)

TSAPxRFCStructureCacheGS ( see page 345)

TSAPxRFCStructureCacheItemGS ( see page 349)

TSAPxRFCTableGS ( see page 351)

TSAPxRFCTablesListGS ( see page 366)

TSAPxRFCTracingObjectGS ( see page 369)

TSAPxRFCTypeElementGS ( see page 370)

TSAPxRFCTypeElementsListGS ( see page 377)

TSAPxRFCValueAdapterGS ( see page 380)

Constants

CSAPxRFCMaxNonFlatSize ( see page 403)

SSAPxRFCCfgKeyName ( see page 403)

SSAPxRFCCfgValName ( see page 404)

SSAPxRFCDefCfgFileName ( see page 404)

SSAPxRFCDefCfgKeyName ( see page 404)

SSAPxRFCDefRootKey ( see page 404)


213

1

SSAPxRFCDefRootKeyOld ( see page 405)

Functions

SAPxRFCDataType2Str ( see page 389)

SAPxRFCFinalize ( see page 389)

SAPxRFCGetSAPRFCINIFileName ( see page 390)

SAPxRFCGetTracing ( see page 390)

SAPxRFCInitialize ( see page 390)

SAPxRFCIsStructType ( see page 390)

SAPxRFCParameterType2Str ( see page 391)

SAPxRFCRaiseCustomException ( see page 391)

SAPxRFCRaiseException ( see page 391)

SAPxRFCRaiseNativeException ( see page 391)

SAPxRFCSetTracing ( see page 391)

SAPxRFCSetTracing ( see page 392)

Group


Interfaces

ISAPxRFCErrorHandlerGS ( see page 388)

Legend

Interface

Enumeration

Records, Enums

TSAPxRFCBytesPerCharGS ( see page 392)

TSAPxRFCDataFormatValueGS ( see page 392)

TSAPxRFCDataTypeGS ( see page 393)

TSAPxRFCErrorActionGS ( see page 394)

TSAPxRFCFloatTypeGS ( see page 394)

TSAPxRFCFunctionCallTypeGS ( see page 395)

TSAPxRFCIntTypeGS ( see page 395)

TSAPxRFCMapBCDToTypeGS ( see page 396)

TSAPxRFCParameterTypeGS ( see page 396)


214

1

TSAPxRFCReadTableFormatGS ( see page 396)

TSAPxRFCRemoteObjectDefinitionStateGS ( see page 397)

TSAPxRFCTableStateGS ( see page 397)

TSAPxRFCTreeStateGS ( see page 398)

TSAPxRFCValueFormatGS ( see page 398)

Types

ISAPxInterfaceBaseGS ( see page 398)

TSAPxRFCConnectedObjectClassGS ( see page 398)

TSAPxRFCCustomConnectionClassGS ( see page 399)

TSAPxRFCDataFormatValuesGS ( see page 399)

TSAPxRFCErrorEventGS ( see page 399)

TSAPxRFCFieldClassGS ( see page 400)

TSAPxRFCListObjectClassGS ( see page 400)

TSAPxRFCLoginCallBackGS ( see page 400)

TSAPxRFCParameterClassGS ( see page 400)

TSAPxRFCRemoteObjectClassGS ( see page 401)

TSAPxRFCTableClassGS ( see page 401)

TSAPxRFCValueAdapterGetDataFormatEventGS ( see page 401)

TSAPxRFCValueAdapterGetEventGS ( see page 402)

TSAPxRFCValueAdapterSetEventGS ( see page 402)

TSAPxRFCWaitEventGS ( see page 402)

Variables

FSAPxRFCEnvironment ( see page 403)

FSAPxRFCLoginCallBack ( see page 403)

Description

Unit gsSAPxRFCStdObj includes the objects which are used by server part as well as by client part.

The TSAPxRFCParameterGS ( see page 324) and TSAPxRFCTableGS ( see page 351) classes allow accessing tooutput, input parameters and tables of a function (both server function and client one). An object of theTSAPxRFCFunctionGS ( see page 299) class provides executing any SAP RFC function module. To arrange parametersand tables the TSAPxRFCParametersListGS ( see page 335) and TSAPxRFCTablesListGS ( see page 366) classes areused.


215

1

1.4.7.1 Classes

1.4.7.1.1 Class ESAPxRFCCustomExceptionGS Unit

Unit gsSAPxRFCStdObj ( see page 215)

Legend

Constructor

All Members

Methods

Class ESAPxRFCNativeExceptionGS

CreateWithCode ( see page 220)

Class ESAPxRFCCustomExceptionGS

CreateWithID ( see page 219)

Properties


RFCCode ( see page 221)


ID ( see page 219)

Methods




CreateWithID ( see page 219)

Properties




ID ( see page 219)

File

gsSAPxRFCStdObj

Description

ESAPxRFCCustomExceptionGS is the custom exception class.

It is used when raising an exception generated by function module ABAP code. ID ( see page 219) property contains ABAPexception identifier.

Syntax

public ESAPxRFCCustomExceptionGS = class(ESAPxRFCNativeExceptionGS);


216

1

1.4.7.1.1.1 Methods

1.4.7.1.1.1.1 Constructor ESAPxRFCCustomExceptionGS.CreateWithID

Class

Class ESAPxRFCCustomExceptionGS ( see page 218)

Description

Creates an instance of an exception.

AID - ABAP exception identifier.

ADummy - Dummy parameter, required for C++Builder compatibility.

Syntax

public constructor CreateWithID(const AID: String; ADummy: Boolean = False);


1.4.7.1.1.2.1 Property ESAPxRFCCustomExceptionGS.ID

Class

Class ESAPxRFCCustomExceptionGS ( see page 218)

Description

Returns an ABAP exception identifier.

Syntax

public property ID: String;

1.4.7.1.2 Class ESAPxRFCNativeExceptionGS Unit


Legend

Constructor

All Members

Methods



Properties



Methods




217

1

Properties



File

gsSAPxRFCStdObj

Description

ESAPxRFCNativeExceptionGS is the class of exceptions which occur when a SAP RFC API function is failed.

Syntax

public ESAPxRFCNativeExceptionGS = class(ESAPxRFCExceptionGS);

1.4.7.1.2.1 Methods

1.4.7.1.2.1.1 Constructor ESAPxRFCNativeExceptionGS.CreateWithCode

Class

Class ESAPxRFCNativeExceptionGS ( see page 220)

Description

Creates an instance of an exception with a message string and an error's result code.

AMsg - Error message text.

ARFCCode - Error code.

Syntax

public constructor CreateWithCode(const AMsg: String; ARFCCode: RFC_RC);


1.4.7.1.2.2.1 Property ESAPxRFCNativeExceptionGS.RFCCode

Class

Class ESAPxRFCNativeExceptionGS ( see page 220)

Description

Returns an error's result code.

Syntax

public property RFCCode: RFC_RC;

1.4.7.1.3 Class TSAPxMulticastErrorEventGS Unit


All Members

Methods

Add ( see page 407)





218

1

Class TSAPxMulticastErrorEventGS

Add ( see page 222)



Properties



Methods

Add ( see page 407)




Class TSAPxMulticastErrorEventGS

Add ( see page 222)



Properties



File

gsSAPxRFCStdObj

Syntax

public TSAPxMulticastErrorEventGS = class(TSAPxMulticastEventBaseGS);

1.4.7.1.3.1 Methods

1.4.7.1.3.1.1 Method TSAPxMulticastErrorEventGS.Add

Class

Class TSAPxMulticastErrorEventGS ( see page 221)

Syntax

public procedure Add(AHandler: TSAPxRFCErrorEventGS);

1.4.7.1.3.1.2 Method TSAPxMulticastErrorEventGS.Call

Class


Syntax

public procedure Call(ASender: TObject; E: Exception; var AErrAction: TSAPxRFCErrorActionGS);

1.4.7.1.3.1.3 Method TSAPxMulticastErrorEventGS.Remove

Class


Syntax

public procedure Remove(AHandler: TSAPxRFCErrorEventGS);


219

1

1.4.7.1.4 Class TSAPxRFCConnectedObjectGS Fields



Unit


Legend

Constructor

All Members

Methods






















Properties










220

1





Fields



Methods






















Properties














221

1

File

gsSAPxRFCStdObj

Description

TSAPxRFCConnectedObjectGS is a base abstract class for all Connect for SAP® objects using connection object to workwith a SAP system. Direct descendants of the class are TSAPxRFCServerFunctionGS ( see page 155) andTSAPxRFCRemoteObjectGS ( see page 340).

Syntax

public TSAPxRFCConnectedObjectGS = class(TSAPxRFCObjectGS);

1.4.7.1.4.1 Fields

1.4.7.1.4.1.1 Field TSAPxRFCConnectedObjectGS.FPrepared

Class

Class TSAPxRFCConnectedObjectGS ( see page 222)

Description

Specifies whether or not a connected object is prepared. To prepare an object assign Prepared to True.

Syntax

protected FPrepared: Boolean;

1.4.7.1.4.2 Methods

1.4.7.1.4.2.1 Method TSAPxRFCConnectedObjectGS.CheckConnected

Class


Description

Checks if object has active connection. If there is no active connection, ESAPxRFCExceptionGS exception is raised.

Syntax

protected procedure CheckConnected;

1.4.7.1.4.2.2 Method TSAPxRFCConnectedObjectGS.CheckNotPrepared

Class


Description

Checks Prepare property. If object is prepared, ESAPxRFCExceptionGS exception is raised.

Syntax

protected procedure CheckNotPrepared;

1.4.7.1.4.2.3 Method TSAPxRFCConnectedObjectGS.CheckPrepared

Class


Description

Checks Prepare property. If object is not prepared, ESAPxRFCExceptionGS exception is raised.

Syntax

protected procedure CheckPrepared;


222

1

1.4.7.1.4.2.4 Constructor TSAPxRFCConnectedObjectGS.Create

Class


Description

Introduces a virtual method for creating a new connected object.

Syntax


1.4.7.1.4.2.5 Destructor TSAPxRFCConnectedObjectGS.Destroy

Class


Description

Destroys the TSAPxRFCConnectedObjectGS instance.

Syntax


1.4.7.1.4.2.6 Method TSAPxRFCConnectedObjectGS.DoError

Class


Description

Connect for SAP® calls this procedure, if during an action, initiated by object, an error is happened. For example,TSAPxRFCFunctionGS.ExecFunction ( see page 306) is called and function module returns an error, then DoErrorprocedure will be called with appropriate exception object as a value of E parameter. DoError procedure fires OnErrorEvent( see page 250) event handler if it is assigned.

E - exception object.

AErrAction - action to be executed after return from procedure.

Syntax

protected procedure DoError(E: Exception; var AErrAction: TSAPxRFCErrorActionGS); virtual;

1.4.7.1.4.2.7 Method TSAPxRFCConnectedObjectGS.GetDataFormat

Class


Description

Returns reference to data format object.

Syntax


1.4.7.1.4.2.8 Method TSAPxRFCConnectedObjectGS.GetParentDataFormat

Class


Description

Returns a reference to parent data format object.


223

1

Syntax


1.4.7.1.4.2.9 Method TSAPxRFCConnectedObjectGS.InternalPrepare

Class


Description

Performs some internal actions required to prepare object. For example, TSAPxRFCFunctionGS.InternalPrepare ( seepage 308) retrieves meta data from SAP system.

Syntax

protected procedure InternalPrepare; virtual; abstract;

1.4.7.1.4.2.10 Method TSAPxRFCConnectedObjectGS.InternalUnprepare

Class


Description

Performs some internal actions required to unprepare object. For example, TSAPxRFCFunctionGS.InternalUnprepare (see page 308) deletes cached function module meta data.

Syntax

protected procedure InternalUnprepare; virtual; abstract;

1.4.7.1.4.2.11 Method TSAPxRFCConnectedObjectGS.Prepare

Class


Description

Prepares a connected object for its using. See also InternalPrepare ( see page 227).

Syntax

public procedure Prepare;

1.4.7.1.4.2.12 Method TSAPxRFCConnectedObjectGS.Unprepare

Class


Description

Frees the resources allocated for a previously prepared connected object. See also InternalUnprepare ( see page 227).

Syntax

public procedure Unprepare;


1.4.7.1.4.3.1 Property TSAPxRFCConnectedObjectGS.AfterPrepareEvent

Class


Description

The multicast event handler that notifies its subscribers after the connected object has been prepared.


224

1

Syntax

public property AfterPrepareEvent: TSAPxMulticastNotifyEventGS;

1.4.7.1.4.3.2 Property TSAPxRFCConnectedObjectGS.AfterUnprepareEvent

Class


Description

The multicast event handler that notifies its subscribers after the connected object has been unprepared.

Syntax

public property AfterUnprepareEvent: TSAPxMulticastNotifyEventGS;

1.4.7.1.4.3.3 Property TSAPxRFCConnectedObjectGS.BeforePrepareEvent

Class


Description

The multicast event handler that notifies its subscribers before preparing the connected object.

Syntax

public property BeforePrepareEvent: TSAPxMulticastNotifyEventGS;

1.4.7.1.4.3.4 Property TSAPxRFCConnectedObjectGS.BeforeUnprepareEvent

Class


Description

The multicast event handler that notifies its subscribers before unpreparing the connected object.

Syntax

public property BeforeUnprepareEvent: TSAPxMulticastNotifyEventGS;

1.4.7.1.4.3.5 Property TSAPxRFCConnectedObjectGS.Connection

Class


Description

Refers to connection object to be used for interaction with a SAP system.

Syntax

public property Connection: TSAPxRFCCustomConnectionGS;

1.4.7.1.4.3.6 Property TSAPxRFCConnectedObjectGS.Name

Class


Description

Specifies a SAP RFC object name.

Syntax

public property Name: String;


225

1

1.4.7.1.4.3.7 Property TSAPxRFCConnectedObjectGS.OnErrorEvent

Class


Description

The multicast event handler that notifies its subscribers if an error happens during an action, initiated by object, . Forexample, TSAPxRFCFunctionGS.ExecFunction ( see page 306) is called and function module returns an error, then thehandler will notify all subscribers with an appropriate exception object as a parameter.

Syntax

public property OnErrorEvent: TSAPxMulticastErrorEventGS;

1.4.7.1.4.3.8 Property TSAPxRFCConnectedObjectGS.Prepared

Class


Description

Specifies whether or not a connected object is prepared. To prepare an object assign Prepared to True.

Syntax

public property Prepared: Boolean;

1.4.7.1.5 Class TSAPxRFCConnectionAttributesGS Unit


Legend

Constructor

All Members

Methods


Initialize ( see page 231)

Properties

Client ( see page 231)

CPICConvID ( see page 231)

Destination ( see page 232)

ISOLanguage ( see page 232)

IsPartnerOlder46D ( see page 232)

KernelRel ( see page 232)

Language ( see page 232)

OwnCodePage ( see page 232)

OwnCodepagePCS ( see page 233)

OwnHost ( see page 233)

OwnRel ( see page 233)

OwnType ( see page 233)

PartnerCodepage ( see page 233)

PartnerHost ( see page 234)

PartnerRel ( see page 234)


226

1

PartnerType ( see page 234)

PasswordState ( see page 234)

PCS ( see page 235)

ProgName ( see page 235)

RealPartnerCodepage ( see page 235)

RfcRole ( see page 235)

SystemID ( see page 235)

SystemNumber ( see page 236)


User ( see page 236)

Methods


Initialize ( see page 231)

Properties

Client ( see page 231)

CPICConvID ( see page 231)

Destination ( see page 232)

ISOLanguage ( see page 232)

IsPartnerOlder46D ( see page 232)

KernelRel ( see page 232)

Language ( see page 232)

OwnCodePage ( see page 232)

OwnCodepagePCS ( see page 233)

OwnHost ( see page 233)

OwnRel ( see page 233)

OwnType ( see page 233)

PartnerCodepage ( see page 233)

PartnerHost ( see page 234)

PartnerRel ( see page 234)

PartnerType ( see page 234)

PasswordState ( see page 234)

PCS ( see page 235)

ProgName ( see page 235)

RealPartnerCodepage ( see page 235)

RfcRole ( see page 235)

SystemID ( see page 235)

SystemNumber ( see page 236)


User ( see page 236)

File

gsSAPxRFCStdObj

Description

TSAPxRFCConnectionAttributesGS class has a set of properties describing a RFC connection. This information is filled bySAP RFC after connection has been established. TSAPxRFCCustomConnectionGS ( see page 236) has a propertyAttributes ( see page 247) of TSAPxRFCConnectionAttributesGS class.


227

1

Syntax

public TSAPxRFCConnectionAttributesGS = class(TObject);

1.4.7.1.5.1 Methods

1.4.7.1.5.1.1 Constructor TSAPxRFCConnectionAttributesGS.Create

Class

Class TSAPxRFCConnectionAttributesGS ( see page 229)

Syntax


1.4.7.1.5.1.2 Method TSAPxRFCConnectionAttributesGS.Initialize

Class


Syntax

public procedure Initialize(AAttributes: RFC_ATTRIBUTES);


1.4.7.1.5.2.1 Property TSAPxRFCConnectionAttributesGS.Client

Class


Description

Specifies a SAP system client number.

Syntax

public property Client: string;

1.4.7.1.5.2.2 Property TSAPxRFCConnectionAttributesGS.CPICConvID

Class


Description

Specifies CPI-C Conversation ID.

Syntax

public property CPICConvID: string;

1.4.7.1.5.2.3 Property TSAPxRFCConnectionAttributesGS.Destination

Class


Description

Specifies an RFC destination.

Syntax

public property Destination: string;


228

1

1.4.7.1.5.2.4 Property TSAPxRFCConnectionAttributesGS.ISOLanguage

Class


Description

Specifies a SAP system ISO-language.

Syntax

public property ISOLanguage: string;

1.4.7.1.5.2.5 Property TSAPxRFCConnectionAttributesGS.IsPartnerOlder46D

Class


Syntax

public property IsPartnerOlder46D: Boolean;

1.4.7.1.5.2.6 Property TSAPxRFCConnectionAttributesGS.KernelRel

Class


Description

Specifies partner kernel release.

Syntax

public property KernelRel: string;

1.4.7.1.5.2.7 Property TSAPxRFCConnectionAttributesGS.Language

Class


Description

Specifies a SAP system language.

Syntax

public property Language: string;

1.4.7.1.5.2.8 Property TSAPxRFCConnectionAttributesGS.OwnCodePage

Class


Description

Specifies an own code page.

Syntax

public property OwnCodePage: string;

1.4.7.1.5.2.9 Property TSAPxRFCConnectionAttributesGS.OwnCodepagePCS

Class


Description

Specifies an own code page.


229

1

Syntax

public property OwnCodepagePCS: string;

1.4.7.1.5.2.10 Property TSAPxRFCConnectionAttributesGS.OwnHost

Class


Description

Specifies an own host name.

Syntax

public property OwnHost: string;

1.4.7.1.5.2.11 Property TSAPxRFCConnectionAttributesGS.OwnRel

Class


Description

Indicates own system release.

Syntax

public property OwnRel: string;

1.4.7.1.5.2.12 Property TSAPxRFCConnectionAttributesGS.OwnType

Class


Description

Specifies a type of own system. There are the following the type values:

2 - Destination refers to an R/2 system.


E - Destination refers to an external program that is started by a SAP gateway.

R - Destination refers to an external program that is registered and waits for RFC calls from R/3 and R/2 systems.

Syntax

public property OwnType: string;

1.4.7.1.5.2.13 Property TSAPxRFCConnectionAttributesGS.PartnerCodepage

Class


Description

Specifies a partner code page.

Syntax

public property PartnerCodepage: string;

1.4.7.1.5.2.14 Property TSAPxRFCConnectionAttributesGS.PartnerHost

Class



230

1

Description

Specifies a partner host name.

Syntax

public property PartnerHost: string;

1.4.7.1.5.2.15 Property TSAPxRFCConnectionAttributesGS.PartnerRel

Class


Description

Indicates partner system release.

Syntax

public property PartnerRel: string;

1.4.7.1.5.2.16 Property TSAPxRFCConnectionAttributesGS.PartnerType

Class


Description

Specifies a type of partner system. There are the following the type values:



E - Destination refers to an external program that is started by a SAP gateway.

R - Destination refers to an external program that is registered and waits for RFC calls from R/3 and R/2 systems.

Syntax

public property PartnerType: string;

1.4.7.1.5.2.17 Property TSAPxRFCConnectionAttributesGS.PasswordState

Class


Description

State of the password:

' ' (space) - unknown (RFC server, or SAPsystem older than 46C or no roundtrip yet)

'O' - OK

'M' - expired must be changed

'N' - cannot be changed: on this SAP system, password can only be changed once a day

Syntax

public property PasswordState: string;

1.4.7.1.5.2.18 Property TSAPxRFCConnectionAttributesGS.PCS

Class



231

1

Description

Partners Char Size (valid only in Unicode systems):

1 - Non Unicode

2 - Unicode

This information is only valid after succesfull call to the target system.

Syntax

public property PCS: string;

1.4.7.1.5.2.19 Property TSAPxRFCConnectionAttributesGS.ProgName

Class


Description

Name of the calling program.

Syntax

public property ProgName: String;

1.4.7.1.5.2.20 Property TSAPxRFCConnectionAttributesGS.RealPartnerCodepage

Class


Description

Partner real code page. This information is valid only after succesfulll call.

Syntax

public property RealPartnerCodepage: String;

1.4.7.1.5.2.21 Property TSAPxRFCConnectionAttributesGS.RfcRole

Class


Description

Indicates whether a connection belongs to an RFC Server or an RFC Client.

Syntax

public property RfcRole: string;

1.4.7.1.5.2.22 Property TSAPxRFCConnectionAttributesGS.SystemID

Class


Description

Specifies a SAP system name.

Syntax

public property SystemID: string;

1.4.7.1.5.2.23 Property TSAPxRFCConnectionAttributesGS.SystemNumber

Class



232

1

Description

Specifies a SAP system number.

Syntax

public property SystemNumber: string;

1.4.7.1.5.2.24 Property TSAPxRFCConnectionAttributesGS.Trace

Class


Description

Indicates whether a trace is turned on or off.

Syntax

public property Trace: string;

1.4.7.1.5.2.25 Property TSAPxRFCConnectionAttributesGS.User

Class


Description

Specifies a SAP system user name.

Syntax

public property User: string;

1.4.7.1.6 Class TSAPxRFCCustomConnectionGS Fields









Unit


Legend

Constructor

All Members

Methods






233

1






























Properties













234

1












Fields









Methods
























235

1












Properties























File

gsSAPxRFCStdObj

Description

TSAPxRFCCustomConnectionGS is a base class for both client and server connections. TSAPxRFCCustomConnectionGSintroduces base methods and properties to establish and maintain the connection between the external program and remoteSAP R/3 application server.

Syntax

public TSAPxRFCCustomConnectionGS = class(TSAPxRFCObjectGS);

1.4.7.1.6.1 Fields


236

1

1.4.7.1.6.1.1 Field TSAPxRFCCustomConnectionGS.FActive

Class

Class TSAPxRFCCustomConnectionGS ( see page 236)

Description

Member variable stores a sign whether or not a connection is open.

Syntax

protected FActive: Boolean;

1.4.7.1.6.1.2 Field TSAPxRFCCustomConnectionGS.FAttributes

Class


Syntax

protected FAttributes: TSAPxRFCConnectionAttributesGS;

1.4.7.1.6.1.3 Field TSAPxRFCCustomConnectionGS.FDetectedBytesPerChar

Class


Syntax

protected FDetectedBytesPerChar: TSAPxRFCBytesPerCharGS;

1.4.7.1.6.1.4 Field TSAPxRFCCustomConnectionGS.FDetectedFloatType

Class


Description

Member variable stores a detected SAP server representation of FLOAT data. After the connection is established, variablewill have one of following values: ftIEEE, ftIBM370.

Syntax

protected FDetectedFloatType: TSAPxRFCFloatTypeGS;

1.4.7.1.6.1.5 Field TSAPxRFCCustomConnectionGS.FDetectedIntType

Class


Description

Member variable stores a detected SAP server representation of INTEGER data. After the connection is established,variable will have one of following values: itLittleEndian, itBigEndian.

Syntax

protected FDetectedIntType: TSAPxRFCIntTypeGS;

1.4.7.1.6.1.6 Field TSAPxRFCCustomConnectionGS.FErrorInfo

Class


Syntax

protected FErrorInfo: TSAPxRFCErrorInfoGS;


237

1

1.4.7.1.6.1.7 Field TSAPxRFCCustomConnectionGS.FHandle

Class


Description

Member variable stores a handle of established SAP RFC connection.

Syntax

protected FHandle: RFC_HANDLE;

1.4.7.1.6.2 Methods

1.4.7.1.6.2.1 Method TSAPxRFCCustomConnectionGS.AddObject

Class


Description

Adds object linked with this connection.

AObj - object to remove.

Syntax

protected procedure AddObject(AObj: TSAPxRFCConnectedObjectGS);

1.4.7.1.6.2.2 Method TSAPxRFCCustomConnectionGS.AllowStartProgram

Class


Syntax

public procedure AllowStartProgram(const APrograms: array of String);

1.4.7.1.6.2.3 Method TSAPxRFCCustomConnectionGS.CheckActive

Class


Description

Checks whether connection is open. If connection is closed, ESAPxRFCExceptionGS exception is raised.

Syntax

protected procedure CheckActive;

1.4.7.1.6.2.4 Method TSAPxRFCCustomConnectionGS.CheckInactive

Class


Description

Checks whether connection is closed. If connection is open, ESAPxRFCExceptionGS exception is raised.

Syntax

protected procedure CheckInactive;


238

1

1.4.7.1.6.2.5 Method TSAPxRFCCustomConnectionGS.Close

Class


Description

Unprepare all connected objects, closes RFC connection and sets Active ( see page 247) to False.

Syntax

protected procedure Close; virtual;

1.4.7.1.6.2.6 Method TSAPxRFCCustomConnectionGS.ConnectedObjectByName

Class


Description

Finds a connected object by its name. If no connected object is found, ESAPxRFCExceptionGS exception is raised.

AName - name of searched object.

AClass - class of searched object.

Returns a reference to found object.

Syntax

public function ConnectedObjectByName(const AName: String; AClass: TSAPxRFCConnectedObjectClassGS): TSAPxRFCConnectedObjectGS;

1.4.7.1.6.2.7 Constructor TSAPxRFCCustomConnectionGS.Create

Class


Description

Creates a new connection object.

Syntax


1.4.7.1.6.2.8 Destructor TSAPxRFCCustomConnectionGS.Destroy

Class


Description

Destroys the connection object.

Syntax


1.4.7.1.6.2.9 Method TSAPxRFCCustomConnectionGS.DisconnectObjects

Class


Description

Disconnects from this connection object all objects belonging to the connection.


239

1

Syntax

protected procedure DisconnectObjects(AForce: Boolean);

1.4.7.1.6.2.10 Method TSAPxRFCCustomConnectionGS.DoDetectActualDataFormat

Class


Description

Procedure detects SAP server representation of INTEGER, FLOAT and CHAR/STRING data. It is overrided bydescendants. See DetectedFloatType ( see page 248), DetectedIntType ( see page 249) and DetectedBytesPerChar (see page 248) properties for additional information.

Syntax

protected procedure DoDetectActualDataFormat; virtual;

1.4.7.1.6.2.11 Method TSAPxRFCCustomConnectionGS.DoEnterBusy

Class


Description

Method is called when connection enters into busy state. The method fires OnEnterBusyEvent ( see page 249) eventhandler if it is assigned.

See Busy ( see page 248) for additional info.

Syntax

protected procedure DoEnterBusy; virtual;

1.4.7.1.6.2.12 Method TSAPxRFCCustomConnectionGS.DoError

Class


Description

Method is called, if during an action, initiated by any object linked with this connection, an error is happened. For example,TSAPxRFCFunctionGS.ExecFunction ( see page 306) is called and function module returns an error, then DoError methodwill be called with appropriate exception object as a value of E parameter. DoError method calls OnErrorEvent ( see page250) event handler, if it is assigned.

Syntax

protected procedure DoError(E: Exception; var AErrAction: TSAPxRFCErrorActionGS); virtual;

1.4.7.1.6.2.13 Method TSAPxRFCCustomConnectionGS.DoExitBusy

Class


Description

Method is called when connection exits from busy state. The method calls OnExitBusy event handler if it is assigned. SeeBusy ( see page 248) for additional info.

Syntax

protected procedure DoExitBusy; virtual;

1.4.7.1.6.2.14 Method TSAPxRFCCustomConnectionGS.DoIdle

Class



240

1

Description

Method is called when connection is in idle state. Method fires OnIdleEvent ( see page 250) event handler, if it is assigned.See it description for details.

Syntax

protected procedure DoIdle; virtual;

1.4.7.1.6.2.15 Method TSAPxRFCCustomConnectionGS.EnterBusyState

Class


Description

Marks a connection as busy. See Busy ( see page 248) for additional information.

Syntax

protected procedure EnterBusyState;

1.4.7.1.6.2.16 Method TSAPxRFCCustomConnectionGS.ExitBusyState

Class


Description

Marks a connection as idling. See Busy ( see page 248) for additional information.

Syntax

protected procedure ExitBusyState;

1.4.7.1.6.2.17 Method TSAPxRFCCustomConnectionGS.FindConnectedObject

Class


Description

Finds a connected object by its name. If no connected object is found, function returns nil.

AName - name of searched object.

AClass - class of searched object.

Returns a reference to found object.

Syntax

public function FindConnectedObject(const AName: String; AClass: TSAPxRFCConnectedObjectClassGS): TSAPxRFCConnectedObjectGS;

1.4.7.1.6.2.18 Method TSAPxRFCCustomConnectionGS.ForceDisconnect

Class


Description

Marks a connection inactive if it was closed by SAP RFC system.

Syntax

protected procedure ForceDisconnect;


241

1

1.4.7.1.6.2.19 Method TSAPxRFCCustomConnectionGS.InternalClose

Class


Description

Executes some internal actions required to close connection. See Close ( see page 242) for additional information.

Syntax

protected procedure InternalClose; virtual;

1.4.7.1.6.2.20 Method TSAPxRFCCustomConnectionGS.InternalForceDisconnect

Class


Description

Executes some internal actions required to mark a connection as closed. See ForceDisconnect ( see page 245) for details.

Syntax

protected procedure InternalForceDisconnect; virtual;

1.4.7.1.6.2.21 Method TSAPxRFCCustomConnectionGS.Open

Class


Description

Introduces abstract method for opening a connection.

Syntax

protected procedure Open; virtual; abstract;

1.4.7.1.6.2.22 Method TSAPxRFCCustomConnectionGS.PrepareObjects

Class


Description

Prepares all objects belonging to this connection.

Syntax

protected procedure PrepareObjects;

1.4.7.1.6.2.23 Method TSAPxRFCCustomConnectionGS.RemoveObject

Class


Description

Removes object linked with this connection.

AObj - object to remove.

Syntax

protected procedure RemoveObject(AObj: TSAPxRFCConnectedObjectGS);


242

1

1.4.7.1.6.2.24 Method TSAPxRFCCustomConnectionGS.UnprepareObjects

Class


Description

Unprepare all objects belonging to the connection.

Syntax

protected procedure UnprepareObjects(AForce: Boolean);


1.4.7.1.6.3.1 Property TSAPxRFCCustomConnectionGS.Active

Class


Description

Specifies whether or not a connection is established.

Syntax


1.4.7.1.6.3.2 Property TSAPxRFCCustomConnectionGS.AfterConnectEvent

Class


Description

The multicast event handler that notifies its subscribers after the connection is established.

Syntax

public property AfterConnectEvent: TSAPxMulticastNotifyEventGS;

1.4.7.1.6.3.3 Property TSAPxRFCCustomConnectionGS.AfterDisconnectEvent

Class


Description

The multicast event handler that notifies its subscribers after the connection has been closed.

Syntax

public property AfterDisconnectEvent: TSAPxMulticastNotifyEventGS;

1.4.7.1.6.3.4 Property TSAPxRFCCustomConnectionGS.Attributes

Class


Description

Holds an information describing an RFC connection attributes. The information is accessible after the connection has beenestablished.

Syntax

public property Attributes: TSAPxRFCConnectionAttributesGS;


243

1

1.4.7.1.6.3.5 Property TSAPxRFCCustomConnectionGS.BeforeConnectEvent

Class


Description

The multicast event handler that notifies its subscribers before establishing a connection.

Syntax

public property BeforeConnectEvent: TSAPxMulticastNotifyEventGS;

1.4.7.1.6.3.6 Property TSAPxRFCCustomConnectionGS.BeforeDisconnectEvent

Class


Description

The multicast event handler that notifies its subscribers before closing the connection.

Syntax

public property BeforeDisconnectEvent: TSAPxMulticastNotifyEventGS;

1.4.7.1.6.3.7 Property TSAPxRFCCustomConnectionGS.Busy

Class


Description

Indicates whether or not the connection is in busy state. The following operations make the connection busy:

• establishing the connection;

• closing the connection;

• executing a SAP function module within the client connection;

• handling a request within the server connection;

• other cases when EnterBusyState ( see page 245) is called.

See also OnEnterBusyEvent ( see page 249), OnExitBusyEvent ( see page 250) and OnIdleEvent ( see page 250)event handlers.

Syntax

public property Busy: Boolean;

1.4.7.1.6.3.8 Property TSAPxRFCCustomConnectionGS.DetectedBytesPerChar

Class


Description

Property returns detected SAP server representation of CHAR data. After the connection is established, variable will haveone of following values: bcOne, bcTwo, bcFour.

Syntax

public property DetectedBytesPerChar: TSAPxRFCBytesPerCharGS;


244

1

1.4.7.1.6.3.9 Property TSAPxRFCCustomConnectionGS.DetectedFloatType

Class


Description

Property returns detected SAP server representation of FLOAT data. After the connection is established, variable will haveone of following values: ftIEEE, ftIBM370.

Syntax

public property DetectedFloatType: TSAPxRFCFloatTypeGS;

1.4.7.1.6.3.10 Property TSAPxRFCCustomConnectionGS.DetectedIntType

Class


Description

Property returns detected SAP server representation of INTEGER data. After the connection is established, variable willhave one of following values: itLittleEndian, itBigEndian.

Syntax

public property DetectedIntType: TSAPxRFCIntTypeGS;

1.4.7.1.6.3.11 Property TSAPxRFCCustomConnectionGS.ErrorInfo

Class


Description

Property returns an information about the last RFC error.

Syntax

public property ErrorInfo: TSAPxRFCErrorInfoGS;

1.4.7.1.6.3.12 Property TSAPxRFCCustomConnectionGS.Handle

Class


Description

Property returns a handle of RFC connection.

Syntax

public property Handle: RFC_HANDLE;

1.4.7.1.6.3.13 Property TSAPxRFCCustomConnectionGS.ObjectCount

Class


Description

Property returns a number of objects using this connection.

Syntax

public property ObjectCount: Integer;


245

1

1.4.7.1.6.3.14 Property TSAPxRFCCustomConnectionGS.Objects

Class


Description

Property returns object by index, which use this connection.

Syntax

public property Objects [AIndex: Integer]: TSAPxRFCConnectedObjectGS;

1.4.7.1.6.3.15 Property TSAPxRFCCustomConnectionGS.OnEnterBusyEvent

Class


Description

The multicast event handler that notifies its subscribers before the connection enters busy state.

Syntax

public property OnEnterBusyEvent: TSAPxMulticastNotifyEventGS;

1.4.7.1.6.3.16 Property TSAPxRFCCustomConnectionGS.OnErrorEvent

Class


Description

The multicast event handler that notifies its subscribers if an error happens during an action, initiated by any object linkedwith the connection. For example, TSAPxRFCFunctionGS.ExecFunction ( see page 306) is called and the function modulereturns an error. The handler will notify its subscribers with an appropriate exception object as a parameter.

Syntax

public property OnErrorEvent: TSAPxMulticastErrorEventGS;

1.4.7.1.6.3.17 Property TSAPxRFCCustomConnectionGS.OnExitBusyEvent

Class


Description

The multicast event handler that notifies its subscribers after the connection has leaved busy state.

Syntax

public property OnExitBusyEvent: TSAPxMulticastNotifyEventGS;

1.4.7.1.6.3.18 Property TSAPxRFCCustomConnectionGS.OnIdleEvent

Class


Description

The multicast event handler that periodically notifies its subscribers while the connection is in idle state. This happens in oneof the following cases:

• while a non-transactional function module is being executed in asynchronous mode (TSAPxRFCFunctionGS.Async ( see page 344) is True and TSAPxRFCFunctionGS.CallType ( see page 309) is ftNonTransactionalGS;

• while the server application is waiting for an incoming request.


246

1

Syntax

public property OnIdleEvent: TSAPxMulticastNotifyEventGS;

1.4.7.1.7 Class TSAPxRFCDataFormatGS Events



Unit


Legend

Constructor

All Members

Methods

AdjustIntLength ( see page 252)



DoChanged ( see page 253)

DoChanging ( see page 253)

IsValueOwn ( see page 253)

MapBCD ( see page 254)


RestoreDefaults ( see page 254)

Properties

ActualBytesPerChar ( see page 254)

ActualFloatType ( see page 254)

ActualIntType ( see page 255)

ActualReadTable ( see page 255)

AssignedValues ( see page 255)

BytesPerChar ( see page 255)

FloatType ( see page 255)

IntType ( see page 256)

MapBCDToType ( see page 256)

ParentFormat ( see page 256)

ReadTable ( see page 256)

Events



Methods

AdjustIntLength ( see page 252)



DoChanged ( see page 253)

DoChanging ( see page 253)


247

1

IsValueOwn ( see page 253)

MapBCD ( see page 254)


RestoreDefaults ( see page 254)

Properties

ActualBytesPerChar ( see page 254)

ActualFloatType ( see page 254)

ActualIntType ( see page 255)

ActualReadTable ( see page 255)

AssignedValues ( see page 255)

BytesPerChar ( see page 255)

FloatType ( see page 255)

IntType ( see page 256)

MapBCDToType ( see page 256)

ParentFormat ( see page 256)

ReadTable ( see page 256)

File

gsSAPxRFCStdObj

Description

TSAPxRFCDataFormatGS determines:

• how Delphi data types are mapped to SAP RFC data types;

• how to handle FLOAT and INT SAP data types;

• how to handle TSAPxRFCvServerTableGS ( see page 474) data.

Syntax

public TSAPxRFCDataFormatGS = class(TPersistent);

1.4.7.1.7.1 Methods

1.4.7.1.7.1.1 Method TSAPxRFCDataFormatGS.AdjustIntLength

Class

Class TSAPxRFCDataFormatGS ( see page 250)

Syntax

public function AdjustIntLength(AIntLength: Integer; ADataType: TSAPxRFCDataTypeGS): Integer;

1.4.7.1.7.1.2 Method TSAPxRFCDataFormatGS.Assign

Class


Description

Assigns to current data format object explicitly assigned properties of AFormat data format object.

AFormat - reference to data format object.


248

1

Syntax

public procedure Assign(ASource: TPersistent); override;

1.4.7.1.7.1.3 Constructor TSAPxRFCDataFormatGS.Create

Class


Description

Creates a new TSAPxRFCDataFormatGS object.

AOwner - object which will be owner of data format object.

Syntax

public constructor Create(AOwner: TSAPxRFCObjectGS);

1.4.7.1.7.1.4 Method TSAPxRFCDataFormatGS.DoChanged

Class


Description

Method is called after any of data format object property values is changed. Method calls OnChanged event handler if it isassigned.

Syntax

protected procedure DoChanged;

1.4.7.1.7.1.5 Method TSAPxRFCDataFormatGS.DoChanging

Class


Description

Method is called before any of data format object property values is changed. Method calls OnChanging event handler if it isassigned.

Syntax

protected procedure DoChanging;

1.4.7.1.7.1.6 Method TSAPxRFCDataFormatGS.IsValueOwn

Class


Description

Indicates whether AValue property is defined by this data format object and not inherited from parent data format object.

AValue - specifies a data format object property to check.

Syntax

public function IsValueOwn(AValue: TSAPxRFCDataFormatValueGS): Boolean;

1.4.7.1.7.1.7 Method TSAPxRFCDataFormatGS.MapBCD

Class



249

1

Description

Provides mapping of BCD RFC data type to the most suitable Delphi data type when MapBCDToType ( see page 256)property is bmDefault. Otherwise returns Delphi data type as it was specified by MapBCDToType ( see page 256) property.

Syntax

public function MapBCD(ADataSize: Integer; ADecimals: Integer): TSAPxRFCMapBCDToTypeGS;

1.4.7.1.7.1.8 Method TSAPxRFCDataFormatGS.OverrideBy

Class


Description

Equivalent of Assign ( see page 252) method.

Syntax

public procedure OverrideBy(AFormat: TSAPxRFCDataFormatGS);

1.4.7.1.7.1.9 Method TSAPxRFCDataFormatGS.RestoreDefaults

Class


Description

Clears and restores default object property values.

Syntax

public procedure RestoreDefaults;


1.4.7.1.7.2.1 Property TSAPxRFCDataFormatGS.ActualBytesPerChar

Class


Description

Returns expected server side representation of character (dtFloatGS) data. If BytesPerChar ( see page 255) isbcAutoDetect ( see page 392), ActualBytesPerChar will be as it was detected by Connect for SAP®, otherwise as statedby BytesPerChar ( see page 255).

Syntax

public property ActualBytesPerChar: TSAPxRFCBytesPerCharGS;

1.4.7.1.7.2.2 Property TSAPxRFCDataFormatGS.ActualFloatType

Class


Description

Returns expected server side representation of float (dtFloatGS) data. If FloatType ( see page 255) is ftAutoDetect ( seepage 394), ActualFloatType will be as it was detected by Connect for SAP®, otherwise as stated by FloatType ( see page255).

Syntax

public property ActualFloatType: TSAPxRFCFloatTypeGS;


250

1

1.4.7.1.7.2.3 Property TSAPxRFCDataFormatGS.ActualIntType

Class


Description

Returns expected server side representation of integer (dtIntGS, dtInt1GS, dtInt2GS) data. If IntType ( see page 256) isitAutoDetect ( see page 395), ActualIntType will be as it was detected by Connect for SAP®, otherwise as stated byIntType ( see page 256).

Syntax

public property ActualIntType: TSAPxRFCIntTypeGS;

1.4.7.1.7.2.4 Property TSAPxRFCDataFormatGS.ActualReadTable

Class


Syntax

public property ActualReadTable: TSAPxRFCReadTableFormatGS;

1.4.7.1.7.2.5 Property TSAPxRFCDataFormatGS.AssignedValues

Class


Description

Specifies a set of properties explicitly assigned by programmer.

Syntax

public property AssignedValues: TSAPxRFCDataFormatValuesGS;

1.4.7.1.7.2.6 Property TSAPxRFCDataFormatGS.BytesPerChar

Class


Description

Defines expected server side representation of character (dtCharGS) data. By default it is bcAutoDetect ( see page 392),so after connection will be established Connect for SAP® will automatically detect representation. For details seeTSAPxRFCFloatTypeGS ( see page 392).

Syntax

published property BytesPerChar: TSAPxRFCBytesPerCharGS;

1.4.7.1.7.2.7 Property TSAPxRFCDataFormatGS.FloatType

Class


Description

Defines expected server side representation of float (dtFloatGS) data. By default it is ftAutoDetect ( see page 394), so afterconnection will be established Connect for SAP® will automatically detect representation. For details seeTSAPxRFCFloatTypeGS ( see page 394).

Syntax

published property FloatType: TSAPxRFCFloatTypeGS;


251

1

1.4.7.1.7.2.8 Property TSAPxRFCDataFormatGS.IntType

Class


Description

Defines expected server side representation of integer (dtIntGS, dtInt1GS, dtInt2GS) data. By default it is itAutoDetect (see page 395), so after connection will be established Connect for SAP® will automatically detect representation. For detailssee TSAPxRFCIntTypeGS ( see page 395).

Syntax

published property IntType: TSAPxRFCIntTypeGS;

1.4.7.1.7.2.9 Property TSAPxRFCDataFormatGS.MapBCDToType

Class


Description

Determines Delphi data type to which RFC BCD data format is converted.

Syntax

published property MapBCDToType: TSAPxRFCMapBCDToTypeGS;

1.4.7.1.7.2.10 Property TSAPxRFCDataFormatGS.ParentFormat

Class


Description

Specifies parent data format object.

Syntax

protected property ParentFormat: TSAPxRFCDataFormatGS;

1.4.7.1.7.2.11 Property TSAPxRFCDataFormatGS.ReadTable

Class


Description

Defines expected server side representation of the data returned by RFC_READ_TABLE RFC function module, which isused to implement TSAPxRFCvServerTableGS ( see page 474). Set it to rtText when data is returned as flat text buffers.This is correct value for modern SAP RFC library versions. Otherwise to rtBinary.

Syntax

published property ReadTable: TSAPxRFCReadTableFormatGS;

1.4.7.1.7.3 Events

1.4.7.1.7.3.1 Event TSAPxRFCDataFormatGS.OnChanged

Class


Description

Event occurs after any of data format object property values is changed.


252

1

Syntax

public property OnChanged: TNotifyEvent;

1.4.7.1.7.3.2 Event TSAPxRFCDataFormatGS.OnChanging

Class


Description

Event occurs before any of data format object property values is changed.

Syntax

public property OnChanging: TNotifyEvent;

1.4.7.1.8 Class TSAPxRFCDataObjectGS Unit


Legend

Constructor

All Members

Methods
















Properties






Methods




253

1














Properties






File

gsSAPxRFCStdObj

Description

TSAPxRFCDataObjectGS is an abstract base class for Connect for SAP® objects that encapsulates SAP RFC APIstructured buffer.

Syntax

public TSAPxRFCDataObjectGS = class(TSAPxRFCObjectGS);

1.4.7.1.8.1 Methods

1.4.7.1.8.1.1 Method TSAPxRFCDataObjectGS.Assign

Class

Class TSAPxRFCDataObjectGS ( see page 257)

Description

Introduce a virtual method to assign one object properties to another.

Syntax

public procedure Assign(AObj: TSAPxRFCDataObjectGS); virtual;

1.4.7.1.8.1.2 Constructor TSAPxRFCDataObjectGS.Create

Class


Description

Introduces an abstract constructor.


254

1

Syntax


1.4.7.1.8.1.3 Method TSAPxRFCDataObjectGS.GetRfcData

Class


Description

Introduces virtual method returning a pointer to encapsulated SAP RFC API structured buffer. This is a get method forproperty RfcData ( see page 260).

Syntax

protected function GetRfcData: IntPtr; virtual; abstract;

1.4.7.1.8.1.4 Method TSAPxRFCDataObjectGS.GetRfcDataSize

Class


Description

Introduces virtual class method returning a size of encapsulated SAP RFC API structured buffer. Actual buffer pointer isreturned by RfcData ( see page 260) property.

Syntax

protected class function GetRfcDataSize: LongWord; virtual;

1.4.7.1.8.1.5 Method TSAPxRFCDataObjectGS.ReadFromBuffer

Class


Description

Reads GetRfcDataSize bytes from ABuf to RfcData.

ABuf - pointer to buffer from which to read a data.

Syntax

public procedure ReadFromBuffer(ABuf: IntPtr); virtual;

1.4.7.1.8.1.6 Method TSAPxRFCDataObjectGS.WriteToBuffer

Class


Description

Writes GetRfcDataSize bytes from RfcData to ABuf.

ABuf - pointer to buffer from which to write data.

Syntax

public procedure WriteToBuffer(ABuf: IntPtr); virtual;



255

1

1.4.7.1.8.2.1 Property TSAPxRFCDataObjectGS.RfcData

Class


Description

Points to encapsulated SAP RFC API structured buffer.

Syntax

public property RfcData: IntPtr;

1.4.7.1.9 Class TSAPxRFCEnvironmentGS Unit


Legend

Constructor

All Members

Methods


DecObjects ( see page 264)


ExID2TypeHandle ( see page 265)

IncObjects ( see page 265)










ReadCfgFileName ( see page 268)














256

1


RfcDispatchExt ( see page 272)










RfcInstallTransactionControlEx ( see page 275)













TypeHandle2ExID ( see page 279)

WriteCfgFileName ( see page 279)

Properties

StructureCache ( see page 279)

Tracer ( see page 280)

Methods


DecObjects ( see page 264)


ExID2TypeHandle ( see page 265)

IncObjects ( see page 265)










ReadCfgFileName ( see page 268)



257

1













RfcDispatchExt ( see page 272)










RfcInstallTransactionControlEx ( see page 275)













TypeHandle2ExID ( see page 279)

WriteCfgFileName ( see page 279)

Properties

StructureCache ( see page 279)

Tracer ( see page 280)

File

gsSAPxRFCStdObj

Description

TSAPxRFCEnvironmentGS is a object wrapper for SAP RFC library.


258

1

Each Connect for SAP® application has single instance of TSAPxRFCEnvironmentGS referenced by global variableFSAPxRFCEnvironment ( see page 403). This instance live cycle is based on reference counting. Global variable keeps acount of FSAPxRFCEnvironment ( see page 403) "clients". Here are two global procedures - SAPxRFCInitialize ( seepage 390) and SAPxRFCFinalize ( see page 389). Call first, when you need environment initialized, and call second, whenyou not need environment anymore. Connect for SAP® objects automatically call these routines. But in some rare cases youcan call them yourself.

All methods, in general, may be splitted into following groups:

• Reference counting - IncObjects ( see page 265) and DecObjects ( see page 264);

• SAP RFC EXID to TSAPxRFCDataTypeGS translation and backward - ExID2TypeHandle ( see page 265) and TypeHandle2ExID ( see page 279);

• SAP RFC internal table API wrapping methods - itCreate ( see page 266), itDelete ( see page 266), etc;

• SAP RFC general API wrapping methods - RfcCall ( see page 269), RfcOpenEx ( see page 276), etc;

• Connect for SAP® alias storage pointing - ReadCfgFileName ( see page 268) and WriteCfgFileName ( see page 279);

• Connect for SAP® tracing - Trace ( see page 278).

For details about internal table API and general API see SAP RFC original documentation.

Syntax

public TSAPxRFCEnvironmentGS = class(TObject);

1.4.7.1.9.1 Methods

1.4.7.1.9.1.1 Constructor TSAPxRFCEnvironmentGS.Create

Class

Class TSAPxRFCEnvironmentGS ( see page 260)

Description

Creates a new instance of TSAPxRFCEnvironmentGS class.

Syntax


1.4.7.1.9.1.2 Method TSAPxRFCEnvironmentGS.DecObjects

Class


Description

Decrements the number of objects that use global TSAPxRFCEnvironmentGS object, referenced byFSAPxRFCEnvironment ( see page 403) variable. When the number gets a zero, global object is freed. And whenFSAPxRFCEnableUnload ( see page 57) is True, then LIBRFC32.DLL library is unloaded, using SAPxRFCUnLoadLib (see page 21) procedure. After that SAP RFC API cannot be used and any of Connect for SAP® objects cannot be created,until IncObjects ( see page 265) will be called.

Syntax

public class procedure DecObjects;

1.4.7.1.9.1.3 Destructor TSAPxRFCEnvironmentGS.Destroy

Class


Description

Destroys the TSAPxRFCEnvironmentGS instance.


259

1

Syntax


1.4.7.1.9.1.4 Method TSAPxRFCEnvironmentGS.ExID2TypeHandle

Class


Description

Converts a EXID - string identifier of RFC data type - to Connect for SAP® data type - TSAPxRFCDataTypeGS.

AEXID - EXID type.

AConnection - reference to connection object. Connect for SAP® will use client version info to decide what EXID types aresupported.

ARaise - if True and AEXID contains unknown type, then exception will be raised.

Returns Connect for SAP® data type.

Syntax

public class function ExID2TypeHandle(AEXID: String; AConnection: TSAPxRFCCustomConnectionGS = nil; ARaise: Boolean = True): TSAPxRFCDataTypeGS;

1.4.7.1.9.1.5 Method TSAPxRFCEnvironmentGS.IncObjects

Class


Description

Increments the number of objects that use global TSAPxRFCEnvironmentGS object, referenced by FSAPxRFCEnvironment( see page 403) variable. When the number gets a one, global object is allocated and LIBRFC32.DLL library is loaded,using SAPxRFCLoadLib ( see page 21) procedure. After that SAP RFC API may be used and Connect for SAP® objectsmay be created.

Syntax

public class procedure IncObjects;

1.4.7.1.9.1.6 Method TSAPxRFCEnvironmentGS.itAppLine

Class


Description

Encapsulates an RFC call of ItAppLine function and raises an ESAPxRFCNativeExceptionGS ( see page 220) exceptionon failing.

itab - handle of an internal table.

Returns pointer to the appended table row, if successful. NULL otherwise (no space available).

Syntax

public class function itAppLine(itab: ITAB_H): IntPtr;

1.4.7.1.9.1.7 Method TSAPxRFCEnvironmentGS.itCpyLine

Class



260

1

Description

Encapsulates an RFC call of ItCpyLine function and raises an ESAPxRFCNativeExceptionGS exception on failing.

itab - handle of an internal table.

Line - number of the desired row (row numbers start with 1).

Dest - pointer to destination

Syntax

public class procedure itCpyLine(itab: ITAB_H; Line: LongWord; Dest: IntPtr);

1.4.7.1.9.1.8 Method TSAPxRFCEnvironmentGS.itCreate

Class


Description

Encapsulates an RFC call of ItCreate function and raises an ESAPxRFCNativeExceptionGS exception on failing.

Name - name of the internal table (null-terminated string) which is used to identify the table when tracing.

leng - line length for the internal table.

occu - occurs-value for internal table (amount of lines being allocated when first appending a line to the table).

memo - only use heap memory for allocating table lines. This field is for internal use only. Set the parameter to 0.

Returns handle to a table control structure, if successful. Otherwise, ITAB_NULL if there is not enough memory available.

Syntax

public class function itCreate(Name: PChar; leng: LongWord; occu: LongWord; memo: LongWord): ITAB_H;

1.4.7.1.9.1.9 Method TSAPxRFCEnvironmentGS.itDelete

Class


Description

Encapsulates an RFC call of ItDelete function and raises an ESAPxRFCNativeExceptionGS exception on failing.

itab - Handle of an internal table.

Syntax

public class procedure itDelete(itab: ITAB_H);

1.4.7.1.9.1.10 Method TSAPxRFCEnvironmentGS.itDelLine

Class


Description

Encapsulates an RFC call of ItDelLine function and raises an ESAPxRFCNativeExceptionGS exception on failing.


Line - Row number of the line to be deleted.


261

1

Syntax

public class procedure itDelLine(itab: ITAB_H; Line: LongWord);

1.4.7.1.9.1.11 Method TSAPxRFCEnvironmentGS.itFill

Class


Description

Encapsulates an RFC call of ItFill function and raises an ESAPxRFCNativeExceptionGS exception on failing.


Returns number of rows in an internal table.

Syntax

public class function itFill(itab: ITAB_H): LongWord;

1.4.7.1.9.1.12 Method TSAPxRFCEnvironmentGS.itGetLine

Class


Description

Encapsulates an RFC call of ItGetLine function and raises an ESAPxRFCNativeExceptionGS exception on failing.


Line - Number of the desired row, row numbers start with 1.

Returns pointer to a table row, if successful. Returns NULL otherwise (table row does not exist).

Syntax

public class function itGetLine(itab: ITAB_H; Line: LongWord; RecordSize: LongWord): IntPtr;

1.4.7.1.9.1.13 Method TSAPxRFCEnvironmentGS.itGupLine

Class


Description

Encapsulates an RFC call of ItGupLine function and raises an ESAPxRFCNativeExceptionGS exception on failing.


Line - Number of the desired row, row numbers start with 1.

Returns pointer to a table row, if successful. Returns NULL otherwise (table row does not exist).

Syntax

public class function itGupLine(itab: ITAB_H; Line: LongWord): IntPtr;

1.4.7.1.9.1.14 Method TSAPxRFCEnvironmentGS.itInsLine

Class



262

1

Description

Encapsulates an RFC call of ItInsLine function and raises an ESAPxRFCNativeExceptionGS exception on failing.


Line - Row number before which the line is to be inserted.

Returns pointer to a table row, if successful. Returns NULL otherwise (no space available).

Syntax

public class function itInsLine(itab: ITAB_H; Line: LongWord): IntPtr;

1.4.7.1.9.1.15 Method TSAPxRFCEnvironmentGS.ReadCfgFileName

Class


Description

Reads an alias configuration file's name from registry. Connect for SAP® stores it at registry keyHKLM\Software\gs-soft\SAPxRFC in value CfgFile. By default the name is <windows directory>\SAPxRFCAliases.ini. Seealso WriteCfgFileName ( see page 279).

Syntax

public class function ReadCfgFileName: String;

1.4.7.1.9.1.16 Method TSAPxRFCEnvironmentGS.RfcAbort

Class


Description

Encapsulates an RFC call of RfcAbort function.

Handle - Connection handle.

text - Points to error message. If this field is NULL, the connection is only closed.

Syntax

public class procedure RfcAbort(Handle: RFC_HANDLE; text: pRfc_char_t);

1.4.7.1.9.1.17 Method TSAPxRFCEnvironmentGS.RfcAccept

Class


Description

Encapsulates an RFC call of RfcAccept function and raises an ESAPxRFCNativeExceptionGS exception on failing.

Argv - Command line arguments pointers.

Returns a valid RFC_HANDLE or RFC_HANDLE_NULL.

Syntax

public class function RfcAccept(Argv: ppRfc_char_t): RFC_HANDLE;


263

1

1.4.7.1.9.1.18 Method TSAPxRFCEnvironmentGS.RfcAllocString

Class


Description

Encapsulates an RFC call of RfcAllocString function.

size - Size of string to allocate.

Returns RFC_STRING RFC structure.

Syntax

public class function RfcAllocString(size: LongWord): RFC_STRING;

1.4.7.1.9.1.19 Method TSAPxRFCEnvironmentGS.RfcAllowStartProgram

Class


Syntax

public class procedure RfcAllowStartProgram(pname_list: pRfc_char_t);

1.4.7.1.9.1.20 Method TSAPxRFCEnvironmentGS.RfcCall

Class


Description

Encapsulates an RFC call of RfcCall function and raises an ESAPxRFCNativeExceptionGS exception on failing.


_function - Function module name to be called.

exporting - 'Exporting' parameters.

Tables - 'Tables' parameters.

Syntax

public class procedure RfcCall(Handle: RFC_HANDLE; _function: pRfc_char_t; exporting: pRFC_PARAMETER; Tables: pRFC_TABLE);

1.4.7.1.9.1.21 Method TSAPxRFCEnvironmentGS.RfcCallReceive

Class


Description

Encapsulates an RFC call of RfcCallReceive function and raises an ESAPxRFCNativeExceptionGS exception on failing.


_function - Function module name to be called.


importing - 'Importing' parameters.


264

1


Syntax

public class procedure RfcCallReceive(Handle: RFC_HANDLE; _function: pRfc_char_t; exporting: pRFC_PARAMETER; importing: pRFC_PARAMETER; Tables: pRFC_TABLE);

1.4.7.1.9.1.22 Method TSAPxRFCEnvironmentGS.RfcCancel

Class


Description

Encapsulates an RFC call of RfcCancel function and raises an ESAPxRFCNativeExceptionGS exception on call failing or ifclient library does not support this API.

Handle - RFC connection handle.

cancel_type - Cancel mode.

Syntax

public class procedure RfcCancel(Handle: RFC_HANDLE; cancel_type: RFC_CANCEL_TYPE);

1.4.7.1.9.1.23 Method TSAPxRFCEnvironmentGS.RfcClose

Class


Description

Encapsulates an RFC call of RfcClose.


Syntax

public class procedure RfcClose(Handle: RFC_HANDLE);

1.4.7.1.9.1.24 Method TSAPxRFCEnvironmentGS.RfcConfirmTransID

Class


Description

Encapsulates an RFC call of RfcConfirmTransID function and raises an ESAPxRFCNativeExceptionGS exception on failing.


tid - TID of local transaction that is confirmed.

Syntax

public class procedure RfcConfirmTransID(Handle: RFC_HANDLE; tid: RFC_TID);

1.4.7.1.9.1.25 Method TSAPxRFCEnvironmentGS.RfcConvertBCDToChar

Class



265

1

Parameters

Parameters Description

_in Input data to convert

in_len Length of input data

decs Number of digits after decimal point

_out Output data

out_len Length of output data

Description

Encapsulates an RFC call of RfcConvertBCDToChar function and raises an ESAPxRFCNativeExceptionGS exception onfailing.

Syntax

public class procedure RfcConvertBCDToChar(_in: pRFC_BCD; in_len: Integer; decs: Integer; _out: TSAPxRFCStringBuilderGS; out_len: Integer);

1.4.7.1.9.1.26 Method TSAPxRFCEnvironmentGS.RfcConvertCharToBCD

Class


Description

Encapsulates an RFC call of RfcConvertCharToBCD function and raises an ESAPxRFCNativeExceptionGS exception onfailing.

_in - Input data to convert.

in_len - Length of input data.

pdecs - Number of digits after decimal point.

_out - Output data.

out_len - Length of output data.

Syntax

public class procedure RfcConvertCharToBCD(_in: String; in_len: Integer; var pdecs: Integer; var _out: RFC_BCD; out_len: Integer);

1.4.7.1.9.1.27 Method TSAPxRFCEnvironmentGS.RfcCreateTransID

Class


Description

Encapsulates an RFC call of RfcCreateTransID function and raises an ESAPxRFCNativeExceptionGS exception on failing.


tid - Created transaction-ID.

Syntax

public class procedure RfcCreateTransID(Handle: RFC_HANDLE; tid: RFC_TID);

1.4.7.1.9.1.28 Method TSAPxRFCEnvironmentGS.RfcDispatch

Class



266

1

Description

Encapsulates an RFC call of RfcDispatch function and raises an ESAPxRFCNativeExceptionGS exception on failing.


Returns RFC_RC return code.

Syntax

public class function RfcDispatch(Handle: RFC_HANDLE): RFC_RC;

1.4.7.1.9.1.29 Method TSAPxRFCEnvironmentGS.RfcDispatchExt

Class


Description

Encapsulates an RFC call of RfcDispatch function and raises an ESAPxRFCNativeExceptionGS exception on failing. UnlikeRfcDispatch ( see page 271), RfcDispatchEx allows to ignore result code C_RFC_FAILURE (see RFC_RC ( see page26)) if APSkipFailure points to True.


APSkipFailure - Allows to ignore C_RFC_FAILURE return result, if it points to True value.

Returns RFC_RC return code.

Syntax

public class function RfcDispatchExt(Handle: RFC_HANDLE; var APSkipFailure: Boolean): RFC_RC;

1.4.7.1.9.1.30 Method TSAPxRFCEnvironmentGS.RfcFreeString

Class


Description

Encapsulates an RFC call of RfcFreeString function.

_string - String to free.

Syntax

public class procedure RfcFreeString(_string: RFC_STRING);

1.4.7.1.9.1.31 Method TSAPxRFCEnvironmentGS.RfcGetAttributes

Class


Description

Encapsulates an RFC call of RfcGetAttributes function and raises an ESAPxRFCNativeExceptionGS exception on failing.


RFC_ATTRIBUTES - Pointer to RFC_ATTRIBUTES ( see page 22) structure describing some information about this RFCconnection.


267

1

Syntax

public class procedure RfcGetAttributes(Handle: RFC_HANDLE; var Attributes: RFC_ATTRIBUTES);

1.4.7.1.9.1.32 Method TSAPxRFCEnvironmentGS.RfcGetData

Class


Description

Encapsulates an RFC call of RfcGetData function and raises an ESAPxRFCNativeExceptionGS exception on failing.


Parameters - 'Importing' parameters.


Syntax

public class procedure RfcGetData(Handle: RFC_HANDLE; Parameters: pRFC_PARAMETER; Tables: pRFC_TABLE);

1.4.7.1.9.1.33 Method TSAPxRFCEnvironmentGS.RfcGetName

Class


Parameters


Handle Connection handle

functionname Name of the called function

Description

Encapsulates an RFC call of RfcGetName function and raises an ESAPxRFCNativeExceptionGS exception on failing.

Syntax

public class procedure RfcGetName(Handle: RFC_HANDLE; out functionname: string);

1.4.7.1.9.1.34 Method TSAPxRFCEnvironmentGS.RfcIndirectCallEx

Class


Description

Encapsulates an RFC call of RfcIndirectCallEx function and raises an ESAPxRFCNativeExceptionGS exception on failing.


_function - Function module to be called.



tid - Transaction Identifier.

Syntax

public class procedure RfcIndirectCallEx(Handle: RFC_HANDLE; _function: pRfc_char_t; exporting: pRFC_PARAMETER; Tables: pRFC_TABLE; tid: RFC_TID);


268

1

1.4.7.1.9.1.35 Method TSAPxRFCEnvironmentGS.RfcInstallFunction

Class


Description

Encapsulates an RFC call of RfcInstallFunction function and raises an ESAPxRFCNativeExceptionGS exception on failing.

functionname - Name of function as it can be called from ABAP/4 environment. Zero terminated string.

f_ptr - Function to be called.

Docu - Text describing the functionality and the parameters of the function module.

Syntax

public class procedure RfcInstallFunction(functionname: RFC_FUNCTIONNAME; f_ptr: RFC_ONCALL; Docu: pRfc_char_t);

1.4.7.1.9.1.36 Method TSAPxRFCEnvironmentGS.RfcInstallFunctionExt

Class


Description

Encapsulates an RFC call of RfcInstallFunctionEx function and raises an ESAPxRFCNativeExceptionGS exception on failing.


functionname - Name of function as it can be called from ABAP/4 environment. Zero terminated string.

f_ptr - Function to be called.

Docu - Text describing the functionality and the parameters of the function module.

Syntax

public class procedure RfcInstallFunctionExt(Handle: RFC_HANDLE; functionname: RFC_FUNCTIONNAME; f_ptr: RFC_ONCALL; Docu: pRfc_char_t);

1.4.7.1.9.1.37 Method TSAPxRFCEnvironmentGS.RfcInstallStructure

Class


Description

Encapsulates an RFC call of RfcInstallStructure function and raises an ESAPxRFCNativeExceptionGS exception on failing.

Name - The name of the structure.

Elements - Description of the elements of the structure.

entries - Count of scalar elements in the structure.

pTypeHandle - Returned type handle.

Syntax

public class procedure RfcInstallStructure(Name: pRfc_char_t; Elements: pRFC_TYPE_ELEMENT; entries: LongWord; var pTypeHandle: RFC_TYPEHANDLE);


269

1

1.4.7.1.9.1.38 Method TSAPxRFCEnvironmentGS.RfcInstallTransactionControl

Class


Description

Encapsulates an RFC call of RfcInstallTransactionControl function and raises an ESAPxRFCNativeExceptionGS exceptionon failing.

f_check_ptr - Function to be called, when local transaction starts. Must be used to check, if the transaction is already runningor was already completed.

f_commit_ptr - Function to be called, when local transaction ends. Should be used to commit the transaction locally.

f_rollback_ptr - Function to be called, if local transaction fails due to an error found while the processing is done inside theRFC library. Should be used to roll back a local transaction.

f_confirm_ptr - Function to be called, when local transaction is confirmed. All information stored locally about this transactioncan be deleted.

Syntax

public class procedure RfcInstallTransactionControl(f_check_ptr: RFC_ON_CHECK_TID; f_commit_ptr: RFC_ON_COMMIT; f_rollback_ptr: RFC_ON_ROLLBACK; f_confirm_ptr: RFC_ON_CONFIRM_TID);

1.4.7.1.9.1.39 Method TSAPxRFCEnvironmentGS.RfcInstallTransactionControlEx

Class


Parameters


f_check_ptr Function to be called, when local transaction starts. Must be used to check, if the transaction is already running or was already completed.

f_commit_ptr Function to be called, when local transaction ends. Should be used to commit the transaction locally.

f_rollback_ptr Function to be called, if local transaction fails due to an error found while the processing is done inside the RFC library. Should be used to roll back a local transaction.

f_confirm_ptr Function to be called, when local transaction is confirmed. All information stored locally about this transaction can be deleted.

Description

Encapsulates an RFC call of RfcInstallTransactionControlEx function and raises an ESAPxRFCNativeExceptionGSexception on failing.

Main difference between RfcInstallTransactionControlEx and RfcInstallTransactionControl ( see page 275) is in types ofcallbacks. All callbacks in RfcInstallTransactionControlEx contain Connection handle as a parameter.

Syntax

public class procedure RfcInstallTransactionControlEx(f_check_ptr: RFC_ON_CHECK_TID_EX; f_commit_ptr: RFC_ON_COMMIT_EX; f_rollback_ptr: RFC_ON_ROLLBACK_EX; f_confirm_ptr: RFC_ON_CONFIRM_TID_EX);

1.4.7.1.9.1.40 Method TSAPxRFCEnvironmentGS.RfcLastErrorEx

Class



270

1

Description

Encapsulates an RFC call of RfcLastErrorEx function.

error_info - Pointer to RFC_ERROR_INFO_EX ( see page 24) structure, describing the

Syntax

public class procedure RfcLastErrorEx(var error_info: RFC_ERROR_INFO_EX);

1.4.7.1.9.1.41 Method TSAPxRFCEnvironmentGS.RfcListen

Class


Description

Encapsulates an RFC call of RfcListen function and raises an ESAPxRFCNativeExceptionGS exception on failing.


Returns RFC_OK, if there is an RFC event pending (call or return) and RFC_RETRY, if nothing has arrived yet. And returnsRFC_FAILURE, if an error has occurred .

Syntax

public class function RfcListen(Handle: RFC_HANDLE): RFC_RC;

1.4.7.1.9.1.42 Method TSAPxRFCEnvironmentGS.RfcOpenEx

Class


Description

Encapsulates an RFC call of RfcOpenEx function and raises an ESAPxRFCNativeExceptionGS exception on failing.

connect_param - String of connection parameters.

error_info - Pointer to RFC_ERROR_INFO_EX record which will contain error information if an error happens.

Returns a handle to the RFC connection (RFC_HANDLE

Syntax

public class function RfcOpenEx(connect_param: pRfc_char_t; var error_info: RFC_ERROR_INFO_EX): RFC_HANDLE;

1.4.7.1.9.1.43 Method TSAPxRFCEnvironmentGS.RfcRaise

Class


Description

Encapsulates an RFC call of RfcRaise function and raises an ESAPxRFCNativeExceptionGS exception on failing.


exception - Exception to be raised (zero terminated string).

Syntax

public class procedure RfcRaise(Handle: RFC_HANDLE; exception: pRfc_char_t);


271

1

1.4.7.1.9.1.44 Method TSAPxRFCEnvironmentGS.RfcRaiseTables

Class


Description

Encapsulates an RFC call of RfcRaiseTables function and raises an ESAPxRFCNativeExceptionGS exception on failing.


exception - Exception to be raised (zero terminated string).

Tables - tables parameters as received by RfcGetData ( see page 273).

Syntax

public class procedure RfcRaiseTables(Handle: RFC_HANDLE; exception: pRfc_char_t; Tables: pRFC_TABLE);

1.4.7.1.9.1.45 Method TSAPxRFCEnvironmentGS.RfcReceive

Class


Description

Encapsulates an RFC call of RfcReceive function and raises an ESAPxRFCNativeExceptionGS exception on failing.


importing - 'Importing' parameters.


Syntax

public class procedure RfcReceive(Handle: RFC_HANDLE; importing: pRFC_PARAMETER; Tables: pRFC_TABLE);

1.4.7.1.9.1.46 Method TSAPxRFCEnvironmentGS.RfcResizeXString

Class


Description

Encapsulates an RFC call of RfcResizeXString function.

xstring - Pointer to RFC_XSTRING ( see page 29) structure.

length - New length of XString.

Syntax

public class procedure RfcResizeXString(var xstring: RFC_XSTRING; length: RFC_INT);

1.4.7.1.9.1.47 Method TSAPxRFCEnvironmentGS.RfcSendData

Class


Description

Encapsulates an RFC call of RfcSendData function and raises an ESAPxRFCNativeExceptionGS exception on failing.


272

1


Parameters - 'Exporting' parameters.


Syntax

public class procedure RfcSendData(Handle: RFC_HANDLE; Parameters: pRFC_PARAMETER; Tables: pRFC_TABLE);

1.4.7.1.9.1.48 Method TSAPxRFCEnvironmentGS.RfcStatistic

Class


Description

Encapsulates an RFC call of RfcStatistic function and raises an ESAPxRFCNativeExceptionGS exception on failing.


statistic - SAP_RFC_STATISTIC ( see page 30) structure to fill by connection statistics.

Syntax

public class procedure RfcStatistic(Handle: RFC_HANDLE; var statistic: SAP_RFC_STATISTIC);

1.4.7.1.9.1.49 Method TSAPxRFCEnvironmentGS.RfcUninstallFunction

Class


Description

Encapsulates an RFC call of RfcUninstallFunction function and raises an ESAPxRFCNativeExceptionGS exception on failing.

functionname - Name of an RFC function which should be uninstalled.

Syntax

public class procedure RfcUninstallFunction(functionname: RFC_FUNCTIONNAME);

1.4.7.1.9.1.50 Method TSAPxRFCEnvironmentGS.RfcWaitForRequest

Class


Description

Encapsulates an RFC call of RfcWaitForRequest function and raises an ESAPxRFCNativeExceptionGS exception on failing.


wtime - Wait time.

Syntax

public class procedure RfcWaitForRequest(Handle: RFC_HANDLE; wtime: RFC_INT);

1.4.7.1.9.1.51 Method TSAPxRFCEnvironmentGS.Trace

Class



273

1

Description

Procedure output message AMsg into tracing file, if tracing is turned on. If off - then nothing will happen. Global proceduresSAPxRFCSetTracing ( see page 392) and SAPxRFCGetTracing ( see page 390) allows to control tracing in Connect forSAP® application.

AClassName - Object class name which method call generated tracing message.

AMsg - Tracing message text.

Syntax

public class procedure Trace(const AClassName: String; const AMsg: String);

1.4.7.1.9.1.52 Method TSAPxRFCEnvironmentGS.TypeHandle2ExID

Class


Description

Converts a Connect for SAP® data type to EXID type string identifier.

AType - Connect for SAP® data type.

AConnection - reference to connection object.

Returns EXID type identifier.

Syntax

public class function TypeHandle2ExID(AType: TSAPxRFCDataTypeGS; AConnection: TSAPxRFCCustomConnectionGS = nil): Char;

1.4.7.1.9.1.53 Method TSAPxRFCEnvironmentGS.WriteCfgFileName

Class


Description

Writes an alias configuration file's name into registry. Connect for SAP® stores it at registry keyHKLM\Software\gs-soft\SAPxRFC in value CfgFile. See also ReadCfgFileName ( see page 268).

Syntax

public class procedure WriteCfgFileName(const AValue: String);


1.4.7.1.9.2.1 Property TSAPxRFCEnvironmentGS.StructureCache

Class


Description

Holds all registered structures with RFC_STRUCTURE data type. Use StructureCache for getting a structure handle.

Syntax

public property StructureCache: TSAPxRFCStructureCacheGS;


274

1

1.4.7.1.9.2.2 Property TSAPxRFCEnvironmentGS.Tracer

Class


Description

Returns TSAPxRFCTracerGS object. It is implementation of Connect for SAP® tracer.

Syntax

public property Tracer: TSAPxRFCTracerGS;

1.4.7.1.10 Class TSAPxRFCErrorInfoGS Fields

FErrInfo ( see page 280)

Unit


All Members

Fields

FErrInfo ( see page 280)

Properties

Group ( see page 281)

Key ( see page 281)

Message ( see page 281)

Properties

Group ( see page 281)

Key ( see page 281)

Message ( see page 281)

File

gsSAPxRFCStdObj

Description

TSAPxRFCErrorInfoGS describes the last RFC error. TSAPxRFCErrorInfoGS encapsulates SAP RFC structureRFC_ERROR_INFO_EX ( see page 24).

Syntax

public TSAPxRFCErrorInfoGS = class(TObject);

1.4.7.1.10.1 Fields

1.4.7.1.10.1.1 Field TSAPxRFCErrorInfoGS.FErrInfo

Class

Class TSAPxRFCErrorInfoGS ( see page 280)

Syntax

public FErrInfo: RFC_ERROR_INFO_EX;



275

1

1.4.7.1.10.2.1 Property TSAPxRFCErrorInfoGS.Group

Class


Description

Specifies an error group by which all RFC errors are classified.

Syntax

public property Group: RFC_ERROR_GROUP;

1.4.7.1.10.2.2 Property TSAPxRFCErrorInfoGS.Key

Class


Description

Specifies an error code to identify the error. The Group ( see page 281) and Key have the same meaning. RFC programcan better analyze the error using the error Group instead of error Key.

Syntax

public property Key: String;

1.4.7.1.10.2.3 Property TSAPxRFCErrorInfoGS.Message

Class


Description

Text describing the error.

Syntax

public property Message: string;

1.4.7.1.11 Class TSAPxRFCFieldGS Unit


Legend

Constructor

All Members

Methods










276

1

















Class TSAPxRFCFieldGS













Properties
















277

1

















Offset ( see page 292)

ReadOnly ( see page 292)


Methods


























278

1














Properties


































279

1


File

gsSAPxRFCStdObj

Description

TSAPxRFCFieldGS gives an access to field in SAP RFC structured data, such as:

• records in internal tables. See TSAPxRFCTableGS.Fields ( see page 363) for details.

• record typed parameters. See TSAPxRFCParameterGS.SubFields ( see page 335) for details.

Field data is defined by offset in field list (Offset ( see page 292)), data type (DataType ( see page 292)) and data size(DataSize ( see page 291)). ReadOnly ( see page 292) controls possibility to modify field data. The following methods -AsString ( see page 289), AsDate ( see page 289), AsBCD ( see page 288), AsTime ( see page 290), AsBytes ( seepage 288), AsStruct ( see page 290), AsDouble ( see page 289), AsInteger ( see page 289), AsByte ( see page 288),AsWord ( see page 291), AsNumber ( see page 289), AsVariant ( see page 290), AsVarString ( see page 290),AsVarBytes ( see page 290) and AsXmlString ( see page 291) allow to get field data in specific format. See example ofusing TSAPxRFCFieldGS object there ( see page 351).

Syntax

public TSAPxRFCFieldGS = class(TSAPxRFCListObjectGS);

1.4.7.1.11.1 Methods

1.4.7.1.11.1.1 Method TSAPxRFCFieldGS.Assign

Class

Class TSAPxRFCFieldGS ( see page 281)

Description

Assigns RFC data type and value of one field or parameter to current field.

AObj - The assigning object reference. Object should of one of following classes - TSAPxRFCFieldGS ( see page 281) orTSAPxRFCParameterGS ( see page 324).

Syntax

public procedure Assign(AObj: TSAPxRFCDataObjectGS); override;

1.4.7.1.11.1.2 Method TSAPxRFCFieldGS.CheckDefinition

Class


Description

Checks whether field object has right data type and corresponding data size. If object is not defined properly,ESAPxRFCExceptionGS exception is raised.

Syntax

protected procedure CheckDefinition; override;

1.4.7.1.11.1.3 Constructor TSAPxRFCFieldGS.Create

Class



280

1

Description

Creates and initializes a new TSAPxRFCFieldGS object.

Syntax


1.4.7.1.11.1.4 Destructor TSAPxRFCFieldGS.Destroy

Class


Description

Destroys the TSAPxRFCFieldGS object.

Syntax


1.4.7.1.11.1.5 Method TSAPxRFCFieldGS.Erase

Class


Description

Erases field's data. After call IsNull ( see page 292) property will return True.

Syntax

public procedure Erase;

1.4.7.1.11.1.6 Method TSAPxRFCFieldGS.GetName

Class


Description

Returns a field name.

Syntax

protected function GetName: string; override;

1.4.7.1.11.1.7 Method TSAPxRFCFieldGS.GetRfcData

Class


Description

Returns a pointer to buffer place, where field data is located.

Syntax

protected function GetRfcData: IntPtr; override;

1.4.7.1.11.1.8 Method TSAPxRFCFieldGS.GetRfcDataSize

Class


Description

Returns zero.

Syntax

protected class function GetRfcDataSize: LongWord; override;


281

1

1.4.7.1.11.1.9 Method TSAPxRFCFieldGS.ObjectDataChanging

Class


Description

Method is called by Connect for SAP®, before any of main object properties will be changed.

Syntax

protected procedure ObjectDataChanging; override;

1.4.7.1.11.1.10 Method TSAPxRFCFieldGS.ReadFromBuffer

Class


Description

Copies raw field data from ABuf buffer to record buffer, at field data location.

ABuf - pointer to data to copy to field

Syntax

public procedure ReadFromBuffer(ABuf: IntPtr); override;

1.4.7.1.11.1.11 Method TSAPxRFCFieldGS.SetName

Class


Description

Sets a field name.

AValue - new field name.

Syntax

protected procedure SetName(const AValue: string); override;

1.4.7.1.11.1.12 Method TSAPxRFCFieldGS.WriteToBuffer

Class


Description

Copies raw field data from record buffer, at field data location, to ABuf buffer.

ABuf - pointer to data to copy.

Syntax

public procedure WriteToBuffer(ABuf: IntPtr); override;


1.4.7.1.11.2.1 Property TSAPxRFCFieldGS.AsBCD

Class



282

1

Description

Represents the field's value as Currency. Corresponds to RFCTYPE_BCD ( see page 78) RFC type.

Syntax

public property AsBCD: Currency;

1.4.7.1.11.2.2 Property TSAPxRFCFieldGS.AsByte

Class


Description

Represents the field's value as ShortInt. Corresponds to RFCTYPE_INT1 ( see page 81) RFC type.

Syntax

public property AsByte: Shortint;

1.4.7.1.11.2.3 Property TSAPxRFCFieldGS.AsBytes

Class


Description

Represents the field's value as string of bytes of fixed length. Corresponds to RFCTYPE_BYTE ( see page 79) RFC datatype.

Syntax

public property AsBytes: RawByteString;

1.4.7.1.11.2.4 Property TSAPxRFCFieldGS.AsDate

Class


Description

Represents the field's value as TDateTime. Corresponds to RFCTYPE_DATE ( see page 79) RFC data type.

Syntax

public property AsDate: TDateTime;

1.4.7.1.11.2.5 Property TSAPxRFCFieldGS.AsDouble

Class


Description

Represents the field's value as Double. Corresponds to RFCTYPE_FLOAT ( see page 80) RFC data type.

Syntax

public property AsDouble: Double;

1.4.7.1.11.2.6 Property TSAPxRFCFieldGS.AsInteger

Class


Description

Represents the field's value as Integer. Corresponds to RFCTYPE_INT ( see page 80) RFC data type.


283

1

Syntax

public property AsInteger: Integer;

1.4.7.1.11.2.7 Property TSAPxRFCFieldGS.AsNumber

Class


Description

Represents the field's value as Int64. Corresponds to RFCTYPE_NUM ( see page 82) RFC data type.

Syntax

public property AsNumber: Int64;

1.4.7.1.11.2.8 Property TSAPxRFCFieldGS.AsString

Class


Description

Represents the field's value as string of fixed length. Corresponds to RFCTYPE_CHAR ( see page 79) RFC data type.

Syntax

public property AsString: string;

1.4.7.1.11.2.9 Property TSAPxRFCFieldGS.AsStruct

Class


Description

Represents the field's value as structured byte string of fixed length. Corresponds to RFCTYPE_STRUCTURE ( see page83) RFC data type.

Syntax

public property AsStruct: RawByteString;

1.4.7.1.11.2.10 Property TSAPxRFCFieldGS.AsTime

Class


Description

Represents the field's value as TDateTime. Corresponds to RFCTYPE_TIME ( see page 83) RFC data type.

Syntax

public property AsTime: TDateTime;

1.4.7.1.11.2.11 Property TSAPxRFCFieldGS.AsVarBytes

Class


Description

Represents the field's value as byte string of variable length. Corresponds to RFCTYPE_XSTRING ( see page 85) RFCdata type.

Syntax

public property AsVarBytes: RawByteString;


284

1

1.4.7.1.11.2.12 Property TSAPxRFCFieldGS.AsVariant

Class


Description

Represents the field's value as Variant.

Syntax

public property AsVariant: Variant;

1.4.7.1.11.2.13 Property TSAPxRFCFieldGS.AsVarString

Class


Description

Represents the field's value as variable length string. Corresponds to RFCTYPE_STRING ( see page 83) RFC data type.

Syntax

public property AsVarString: UnicodeString;

1.4.7.1.11.2.14 Property TSAPxRFCFieldGS.AsWord

Class


Description

Represents the field's value as SmallInt. Corresponds to RFCTYPE_INT2 ( see page 81) RFC data type.

Syntax

public property AsWord: Smallint;

1.4.7.1.11.2.15 Property TSAPxRFCFieldGS.AsXMLString

Class


Description

Represents the field's value as XML formatted string. Corresponds to RFCTYPE_XMLDATA ( see page 85) RFC data type.

Syntax

public property AsXMLString: UnicodeString;

1.4.7.1.11.2.16 Property TSAPxRFCFieldGS.CharacterSize

Class


Description

Determines a data size in characters for Connect for SAP® data types:

• dtCharGS;

• dtNumGS

• dtDateGS;

• dtTimeGS.


285

1

Syntax

public property CharacterSize: LongWord;

1.4.7.1.11.2.17 Property TSAPxRFCFieldGS.DataSize

Class


Description

Determines a data size in bytes for Connect for SAP® data types:

• dtByteGS;

• dtCharGS;

• dtStringGS;

• dtXStringGS;

• dtXMLDataGS;

• dtNumGS;

• dtBCDGS.

Syntax

public property DataSize: LongWord;

1.4.7.1.11.2.18 Property TSAPxRFCFieldGS.DataType

Class


Description

Specifies an Connect for SAP® data type. Data type may be assigned also using TypeHandle ( see page 293) property.But assignment to DataType is a preferred way.

Syntax

public property DataType: TSAPxRFCDataTypeGS;

1.4.7.1.11.2.19 Property TSAPxRFCFieldGS.Decimals

Class


Description

Specifies a number of digits after decimal point for dtBCDGS Connect for SAP® data type.

Syntax

public property Decimals: Integer;

1.4.7.1.11.2.20 Property TSAPxRFCFieldGS.IsNull

Class


Description

Indicates whether the field has a value assigned to it. To erase field value call Erase ( see page 286) method.

Syntax

public property IsNull: Boolean;


286

1

1.4.7.1.11.2.21 Property TSAPxRFCFieldGS.Offset

Class


Description

Specifies an offset of the field data in a data buffer.

Syntax

public property Offset: LongWord;

1.4.7.1.11.2.22 Property TSAPxRFCFieldGS.ReadOnly

Class


Description

Specifies whether a field data can be modified.

Syntax

public property ReadOnly: Boolean;

1.4.7.1.11.2.23 Property TSAPxRFCFieldGS.TypeHandle

Class


Description

Specifies an RFC data type handle. Preferred way to set field data type is DataType ( see page 292) property.

Syntax

public property TypeHandle: RFC_TYPEHANDLE;

1.4.7.1.12 Class TSAPxRFCFieldsListGS Unit


Legend

Constructor

All Members

Methods

Add ( see page 318)


AddObjectEx ( see page 319)







FindObject ( see page 320)

FreeRfcData ( see page 321)

GetObjectClass ( see page 321)


287

1

GetObjectRfcDataSize ( see page 321)




ListDataChanged ( see page 322)

ListDataChanging ( see page 322)

Refresh ( see page 322)


Class TSAPxRFCFieldsListGS

AddField ( see page 296)

AddFieldEx ( see page 296)



FieldByName ( see page 297)

FindField ( see page 297)






Properties



Owner ( see page 323)


RfcDataSize ( see page 324)


ExternalRecordBuffer ( see page 298)

Fields ( see page 298)

FieldsRfcDataSize ( see page 299)



Methods

Add ( see page 318)













288

1










AddField ( see page 296)

AddFieldEx ( see page 296)










Properties







ExternalRecordBuffer ( see page 298)


FieldsRfcDataSize ( see page 299)



File

gsSAPxRFCStdObj

Description

TSAPxRFCFieldsListGS holds field objects. TSAPxRFCFieldsListGS is used to manage field objects:

• by TSAPxRFCTableGS ( see page 351). Field list reflects fields in the SAP internal table.

• by TSAPxRFCParameterGS ( see page 324). Field list reflects sub fields of structured data type parameter.

To add a new field to the Fields ( see page 298) array, use AddField ( see page 296) method, if the field is ofTSAPxRFCFieldGS ( see page 281) class or AddFieldEx ( see page 296) in other cases. FindField ( see page 297)allows to search for field by its name. When you need to erase all field values you have to call Erase ( see page 296)method. See example of using TSAPxRFCFieldsListGS object there ( see page 351).


289

1

Syntax

public TSAPxRFCFieldsListGS = class(TSAPxRFCObjectsListGS);

1.4.7.1.12.1 Methods

1.4.7.1.12.1.1 Method TSAPxRFCFieldsListGS.AddField

Class

Class TSAPxRFCFieldsListGS ( see page 293)

Description

Adds a new field object to Fields ( see page 298) array.

Returns the new field.

Syntax

public function AddField: TSAPxRFCFieldGS;

1.4.7.1.12.1.2 Method TSAPxRFCFieldsListGS.AddFieldEx

Class


Description

Adds a new AClass object to Fields ( see page 298) array and returns the new object.

AClass - Class of field to add.

Returns new added field.

Syntax

public function AddFieldEx(AClass: TSAPxRFCFieldClassGS): TSAPxRFCFieldGS;

1.4.7.1.12.1.3 Method TSAPxRFCFieldsListGS.CheckDefinition

Class


Description

Checks whether all field objects from Fields ( see page 298) array have right data type and corresponding data size. If anyof field objects is not defined, ESAPxRFCExceptionGS exception is raised.

Syntax

public procedure CheckDefinition; override;

1.4.7.1.12.1.4 Method TSAPxRFCFieldsListGS.Erase

Class


Description

Erases all fields data. After that call, TSAPxRFCFieldGS.IsNull ( see page 292) for any field in the list will return True.

Syntax



290

1

1.4.7.1.12.1.5 Method TSAPxRFCFieldsListGS.FieldByName

Class


Description

Finds a field by its name. If no field is found, ESAPxRFCExceptionGS ( see page 21) exception is raised.

AName - Name of field to find.

Returns a reference to founded field object.

Syntax

public function FieldByName(const AName: String): TSAPxRFCFieldGS;

1.4.7.1.12.1.6 Method TSAPxRFCFieldsListGS.FindField

Class


Description

Searches for a specified field in the Fields ( see page 298) array. If no field has specified name, FindField returns nil.


Returns a reference to founded field or nil.

Syntax

public function FindField(const AName: String): TSAPxRFCFieldGS;

1.4.7.1.12.1.7 Method TSAPxRFCFieldsListGS.FreeRfcData

Class


Description

Clears and frees RFC data buffer.

Syntax

protected procedure FreeRfcData; override;

1.4.7.1.12.1.8 Method TSAPxRFCFieldsListGS.GetObjectClass

Class


Description

Base class of fields in list. Objects of this class will be added to the list at AddField ( see page 296) call.

Returns a reference to class.

Syntax

protected class function GetObjectClass: TSAPxRFCListObjectClassGS; override;


291

1

1.4.7.1.12.1.9 Method TSAPxRFCFieldsListGS.GetRfcData

Class


Description

Gets an RFC data. If ExternalRecordBuffer ( see page 298) property is assigned, then method will return it value.Otherwise will return a pointer to internal record buffer.

Returns a pointer to buffer.

Syntax


1.4.7.1.12.1.10 Method TSAPxRFCFieldsListGS.GetRfcDataSize

Class


Description

Gets an RFC data size. Actually it is a record buffer size.

Returns size of buffer.

Syntax

protected function GetRfcDataSize: LongWord; override;

1.4.7.1.12.1.11 Method TSAPxRFCFieldsListGS.ListDataChanging

Class


Description

Method is fired before list of fields will be changed.

Syntax

protected procedure ListDataChanging; override;


1.4.7.1.12.2.1 Property TSAPxRFCFieldsListGS.ExternalRecordBuffer

Class


Description

Represents an external buffer where fields' data is stored. When ExternalRecordBuffer is nil, field list will allocate internalrecord buffer.

Syntax

public property ExternalRecordBuffer: IntPtr;

1.4.7.1.12.2.2 Property TSAPxRFCFieldsListGS.Fields

Class



292

1

Description

Indexed array referring to the field objects.

Syntax

public property Fields [AIndex: integer]: TSAPxRFCFieldGS;

1.4.7.1.12.2.3 Property TSAPxRFCFieldsListGS.FieldsRfcDataSize

Class


Description

Returns calculated size of record. It is equal to offset of last field plus its data size.

Syntax

public property FieldsRfcDataSize: LongWord;

1.4.7.1.12.2.4 Property TSAPxRFCFieldsListGS.ReadOnly

Class


Description

Specifies whether all fields can be modified.

Syntax


1.4.7.1.12.2.5 Property TSAPxRFCFieldsListGS.RfcDataSize

Class


Description

Specifies size of record buffer. By default it is equal to FieldsRfcDataSize ( see page 299). But may be overrided.

Syntax

public property RfcDataSize: LongWord;

1.4.7.1.13 Class TSAPxRFCFunctionGS Fields





Unit


Legend

Constructor


293

1

All Members

Methods













































294

1








Properties
























Fields





Methods







295

1















































296

1

Properties
























File

gsSAPxRFCStdObj

Description

TSAPxRFCFunctionGS encapsulates SAP function modules in Connect for SAP® application.

Setting Prepared ( see page 229) property to True, Connect for SAP® will prepare function module for execution. Iffunction requires dynamic definition (by default), then Connect for SAP® will automatically obtain SAP function module metadata from server using RFC_GET_FUNCTION_INTERFACE function module. Also programmer may fill parameter and tablelists by hands and call ObjectDefined ( see page 344) method, which will mark function as having completed fixed set ofparameters and tables. This feature is used by Connect for SAP® Explorer function module wrapper generator.

To execute function, you have to initialize all required input parameters in the InParams ( see page 309) list and addnecessary records to the tables from the Tables ( see page 309) list. Then call ExecFunction ( see page 306) and if noerror happens, you will get output parameter values in the OutParams ( see page 309) list.

Setting Prepared ( see page 229) property to False, Connect for SAP® will release used resources and, in case ofdynamically defined function, will remove function parameter and table objects.

Function module call may be as of transactional as of non-transactional type. This is defined CallType ( see page 309)


297

1

property. If you use transactional function you cannot use output parameters. Unlike non-transactional functions thetransactional ones must be called within an active transaction. Use TSAPxRFCClientConnectionGS ( see page 97)methods to start, restart and complete transaction.

Also function module call may be as blocking as non-blocking. That is controlled by Async ( see page 344) property. Innon-blocking mode, while SAP server executes function module, OnIdleEvent ( see page 345) event handler will be firedfew times.

For locating parameters and tables in TSAPxRFCFunctionGS object use such methods as FindInParameter ( see page307) (for input parameters), FindOutParameter ( see page 307) (for output parameters) and FindTable ( see page 307)(for tables).

Example

The following example shows non-transactional function execution.

var iCount: Integer; iSum: LongInt; procedure FuncExecute(AFunction: TSAPxRFCFunctionGS);begin ... with AFunction do begin Prepared := True; InParams.ParameterByName('ACCOUNT').AsInteger := iCount; ExecFunction; iSum := OutParams.ParameterByName('SUM').AsInteger; { do something with result value } end;end;

See example of transactional function execution there ( see page 97).

Syntax

public TSAPxRFCFunctionGS = class(TSAPxRFCRemoteObjectGS, ISAPxInterfaceBaseGS, ISAPxRFCErrorHandlerGS);

1.4.7.1.13.1 Methods

1.4.7.1.13.1.1 Method TSAPxRFCFunctionGS._AddRef

Class

Class TSAPxRFCFunctionGS ( see page 299)

Syntax

protected function _AddRef: Integer; stdcall;

1.4.7.1.13.1.2 Method TSAPxRFCFunctionGS._Release

Class


Syntax

protected function _Release: Integer; stdcall;


298

1

1.4.7.1.13.1.3 Method TSAPxRFCFunctionGS.CheckDefinition

Class


Syntax

protected procedure CheckDefinition; virtual;

1.4.7.1.13.1.4 Constructor TSAPxRFCFunctionGS.Create

Class


Description

Creates a new TSAPxRFCFunctionGS object.

Syntax


1.4.7.1.13.1.5 Method TSAPxRFCFunctionGS.DefineParam

Class


Description

Creates and defines parameter using meta-data from ADefTab current row. ADefTab must have a structure, as it is inPARAMS table of RFC_GET_FUNCTION_INTERFACE function module.

ADefTab - SAP internal table with meta-data.

AParamList - list of parameters where new parameter will be created.

AParamType - a type of parameter to be defined. SeeTSAPxRFCParameterTypeGS ( see page 396) for details.

Syntax

protected procedure DefineParam(ADefTab: TSAPxRFCTableGS; AParamList: TSAPxRFCParametersListGS; AParamType: TSAPxRFCParameterTypeGS);

1.4.7.1.13.1.6 Method TSAPxRFCFunctionGS.DefineTable

Class


Description

Creates and defines table using meta-data from ADefTab current row. ADefTab must have a structure, as it is in PARAMStable of RFC_GET_FUNCTION_INTERFACE function module.

ADefTab - SAP internal table with meta-data.

ATabList - list of tables where new table will be created.

Syntax

protected procedure DefineTable(ADefTab: TSAPxRFCTableGS; ATabList: TSAPxRFCTablesListGS);

1.4.7.1.13.1.7 Destructor TSAPxRFCFunctionGS.Destroy

Class



299

1

Description

Destroys TSAPxRFCFunctionGS instance.

Syntax


1.4.7.1.13.1.8 Method TSAPxRFCFunctionGS.ExecFunction

Class


Description

Executes the specified function module in a SAP system.

Syntax

public function ExecFunction(AWaitForCompletion: Boolean = True): Boolean;

1.4.7.1.13.1.9 Method TSAPxRFCFunctionGS.FindInParameter

Class


Description

Searches for a specified input parameter in the InParams ( see page 309) array. If no input parameter has specified name,FindInParameter returns nil.

AName - Parameter name to find.

Returns a reference to found parameter or nil.

Syntax

public function FindInParameter(const AName: String): TSAPxRFCParameterGS;

1.4.7.1.13.1.10 Method TSAPxRFCFunctionGS.FindOutParameter

Class


Description

Searches for a specified output parameter in the OutParams ( see page 309) array. If no output parameter has specifiedname, FindOutParameter returns nil.

AName - Parameter name to find.

Returns a reference to found parameter or nil.

Syntax

public function FindOutParameter(const AName: String): TSAPxRFCParameterGS;

1.4.7.1.13.1.11 Method TSAPxRFCFunctionGS.FindTable

Class


Description

Searches for a specified table in the Tables ( see page 309) array. If no table has specified name, FindTable returns nil.


300

1

AName - table name to find.

Returns reference to found table or nil.

Syntax

public function FindTable(const AName: String): TSAPxRFCTableGS;

1.4.7.1.13.1.12 Method TSAPxRFCFunctionGS.GetErrorHandler

Class


Syntax

protected function GetErrorHandler: ISAPxRFCErrorHandlerGS; override;

1.4.7.1.13.1.13 Method TSAPxRFCFunctionGS.InParameterByName

Class


Description

Finds an input parameter by its name. If no input parameter is found, ESAPxRFCExceptionGS exception is raised. If you notneed exception, then use FindInParameter ( see page 307).

Syntax

public function InParameterByName(const AName: String): TSAPxRFCParameterGS;

1.4.7.1.13.1.14 Method TSAPxRFCFunctionGS.InternalPrepare

Class


Description

Performs specific actions to prepare function remote object.

Syntax


1.4.7.1.13.1.15 Method TSAPxRFCFunctionGS.InternalUnprepare

Class


Description

Performs specific actions to unprepare function remote object.

Syntax


1.4.7.1.13.1.16 Method TSAPxRFCFunctionGS.OnError

Class


Syntax

protected function OnError(const AException: Exception; ASender: TObject): Boolean;

1.4.7.1.13.1.17 Method TSAPxRFCFunctionGS.OutParameterByName

Class



301

1

Description

Finds an output parameter by its name. If no output parameter is found, ESAPxRFCExceptionGS exception is raised. If younot need exception, then use FindOutParameter ( see page 307).

Syntax

public function OutParameterByName(const AName: String): TSAPxRFCParameterGS;

1.4.7.1.13.1.18 Method TSAPxRFCFunctionGS.QueryInterface

Class


Syntax

protected function QueryInterface(const IID: TGUID; out Obj): HResult; stdcall;

1.4.7.1.13.1.19 Method TSAPxRFCFunctionGS.TableByName

Class


Description

Finds a table by its name. If no table is found, ESAPxRFCExceptionGS exception is raised. If you not need exception, thenuse FindTable ( see page 307).

Syntax

public function TableByName(const AName: String): TSAPxRFCTableGS;


1.4.7.1.13.2.1 Property TSAPxRFCFunctionGS.CallType

Class


Description

Specifies how function module is called either as transactional either as non-transactional.

Syntax

public property CallType: TSAPxRFCFunctionCallTypeGS;

1.4.7.1.13.2.2 Property TSAPxRFCFunctionGS.InParams

Class


Description

Holds a list of the input (passed to SAP) parameters.

Syntax

public property InParams: TSAPxRFCParametersListGS;

1.4.7.1.13.2.3 Property TSAPxRFCFunctionGS.OutParams

Class


Description

Holds a list of output (received from SAP) parameters. Use OutParams array to access to the output parameters ofnon-transactional functions only.


302

1

Syntax

public property OutParams: TSAPxRFCParametersListGS;

1.4.7.1.13.2.4 Property TSAPxRFCFunctionGS.Tables

Class


Description

Holds an array of the tables used by the function.

Syntax


1.4.7.1.14 Class TSAPxRFCListObjectGS Unit


Legend

Constructor

All Members

Methods


























303

1

Properties










Methods

























Properties







304

1





File

gsSAPxRFCStdObj

Description

TSAPxRFCListObjectGS is an abstract base class for any Connect for SAP® named object contained in the list.

Syntax

public TSAPxRFCListObjectGS = class(TSAPxRFCDataObjectGS);

1.4.7.1.14.1 Methods

1.4.7.1.14.1.1 Method TSAPxRFCListObjectGS.CheckDefinition

Class

Class TSAPxRFCListObjectGS ( see page 310)

Syntax

protected procedure CheckDefinition; virtual;

1.4.7.1.14.1.2 Method TSAPxRFCListObjectGS.GetDataFormat

Class


Description

Gets a data format object.

Syntax


1.4.7.1.14.1.3 Method TSAPxRFCListObjectGS.GetErrorHandler

Class


Syntax

protected function GetErrorHandler: ISAPxRFCErrorHandlerGS; override;

1.4.7.1.14.1.4 Method TSAPxRFCListObjectGS.GetName

Class


Description

Gets an object name.

Syntax

protected function GetName: String; virtual; abstract;

1.4.7.1.14.1.5 Method TSAPxRFCListObjectGS.GetParentDataFormat

Class



305

1

Description

Gets a parent data format object.

Syntax


1.4.7.1.14.1.6 Method TSAPxRFCListObjectGS.ObjectDataChanged

Class


Description

Method is called by Connect for SAP®, when any of main object properties is changed.

Syntax

protected procedure ObjectDataChanged; virtual;

1.4.7.1.14.1.7 Method TSAPxRFCListObjectGS.ObjectDataChanging

Class


Description

Method is called by Connect for SAP®, before any of main object properties will be changed.

Syntax

protected procedure ObjectDataChanging; virtual;

1.4.7.1.14.1.8 Method TSAPxRFCListObjectGS.SetName

Class


Description

Sets a new object name.

Syntax

protected procedure SetName(const AValue: String); virtual; abstract;


1.4.7.1.14.2.1 Property TSAPxRFCListObjectGS.Description

Class


Description

Specifies a SAP RFC object description.

Syntax

public property Description: String;

1.4.7.1.14.2.2 Property TSAPxRFCListObjectGS.List

Class


Description

Points to object list which owns the object.


306

1

Syntax

public property List: TSAPxRFCObjectsListGS;

1.4.7.1.14.2.3 Property TSAPxRFCListObjectGS.Name

Class


Description

Specifies a SAP RFC object name.

Syntax


1.4.7.1.15 Class TSAPxRFCObjectBaseGS Unit


All Members

Methods





Methods





File

gsSAPxRFCStdObj

Syntax

public TSAPxRFCObjectBaseGS = class(TSAPxRFCTracingObjectGS);

1.4.7.1.16 Class TSAPxRFCObjectGS Unit


All Members

Methods










307

1

Properties




Methods









Properties




File

gsSAPxRFCStdObj

Description

TSAPxRFCObjectGS is a base class for Connect for SAP® objects. Common feature for all Connect for SAP® objects is thedata format that is determined by DataFormat ( see page 316) property. There are Connect for SAP® objects which haveno own data format and they inherit it from their parents. Parent data format is determined by ParentDataFormat ( seepage 316).

Syntax

public TSAPxRFCObjectGS = class(TSAPxRFCObjectBaseGS);

1.4.7.1.16.1 Methods

1.4.7.1.16.1.1 Method TSAPxRFCObjectGS.GetDataFormat

Class

Class TSAPxRFCObjectGS ( see page 314)

Description

Gets a data format.

Syntax

protected function GetDataFormat: TSAPxRFCDataFormatGS; virtual;

1.4.7.1.16.1.2 Method TSAPxRFCObjectGS.GetErrorHandler

Class


Syntax

protected function GetErrorHandler: ISAPxRFCErrorHandlerGS; virtual;


308

1

1.4.7.1.16.1.3 Method TSAPxRFCObjectGS.GetParentDataFormat

Class


Description

Gets a parent data format.

Syntax

protected function GetParentDataFormat: TSAPxRFCDataFormatGS; virtual;


1.4.7.1.16.2.1 Property TSAPxRFCObjectGS.DataFormat

Class


Description

Specifies a Connect for SAP® object's data format.

Syntax

public property DataFormat: TSAPxRFCDataFormatGS;

1.4.7.1.16.2.2 Property TSAPxRFCObjectGS.ParentDataFormat

Class


Description

Specifies an Connect for SAP® data format of object's parent.

Syntax

public property ParentDataFormat: TSAPxRFCDataFormatGS;

1.4.7.1.17 Class TSAPxRFCObjectsListGS Unit


Legend

Constructor

All Members

Methods

Add ( see page 318)










309

1












Properties






Methods

Add ( see page 318)




















Properties







310

1

File

gsSAPxRFCStdObj

Description

TSAPxRFCObjectsListGS stores an array of TSAPxRFCListObjectGS ( see page 310) objects and manage it.

Many SAP RFC API calls requires array of object data. For example, parameters of function module. This array is filled byobject data's with trailing zeroed space. TSAPxRFCObjectsListGS supports that. Properties RfcData ( see page 323) andRfcDataSize ( see page 324) returns such buffer and its size.

GetObjectClass ( see page 321) method returns a base class of all objects in the list. GetObjectRfcDataSize ( see page321) method returns size of single object in the list, so all objects in the list must have the same GetRfcDataSize ( seepage 259) size.

Objects in the list are owned by this list. So, list will free object memory, when object is not more needed.

Syntax

public TSAPxRFCObjectsListGS = class(TObject);

1.4.7.1.17.1 Methods

1.4.7.1.17.1.1 Method TSAPxRFCObjectsListGS.Add

Class

Class TSAPxRFCObjectsListGS ( see page 316)

Description

Adds existing AObj object to the end of the Items ( see page 323) array.

AObj - object reference to add.

Syntax

public procedure Add(AObj: TSAPxRFCListObjectGS); virtual;

1.4.7.1.17.1.2 Method TSAPxRFCObjectsListGS.AddObject

Class


Description

Adds a new object to the end of the Items ( see page 323) array and returns the new item.

Returns a reference to created object.

Syntax

public function AddObject: TSAPxRFCListObjectGS;

1.4.7.1.17.1.3 Method TSAPxRFCObjectsListGS.AddObjectEx

Class



311

1

Description

Adds a new object of the AClass class to the end of the Items ( see page 323) array and returns the new item.

AClass - class reference.

Returns a reference to created object.

Syntax

public function AddObjectEx(AClass: TSAPxRFCListObjectClassGS): TSAPxRFCListObjectGS;

1.4.7.1.17.1.4 Method TSAPxRFCObjectsListGS.Assign

Class


Description

Method deletes all items from the current object list, then adds a copy of each item in the AList object list.

AList - object list to assign.

Syntax

public procedure Assign(AList: TSAPxRFCObjectsListGS); virtual;

1.4.7.1.17.1.5 Method TSAPxRFCObjectsListGS.CheckDefinition

Class


Syntax

public procedure CheckDefinition; virtual;

1.4.7.1.17.1.6 Method TSAPxRFCObjectsListGS.Clear

Class


Description

Removes and frees all objects from the list.

Syntax


1.4.7.1.17.1.7 Constructor TSAPxRFCObjectsListGS.Create

Class


Description

Creates a new TSAPxRFCObjectsListGS object which belongs to AOwner RFC object.

AOwner - reference to owning object.

Syntax

public constructor Create(AOwner: TSAPxRFCObjectGS);


312

1

1.4.7.1.17.1.8 Method TSAPxRFCObjectsListGS.Delete

Class


Description

Removes the item specified by the AIndex index in the Items ( see page 323) array and frees this item.

AIndex - zero based index of item to delete.

Syntax

public procedure Delete(AIndex: Integer);

1.4.7.1.17.1.9 Destructor TSAPxRFCObjectsListGS.Destroy

Class


Description

Destroys a TSAPxRFCObjectsListGS object.

Syntax


1.4.7.1.17.1.10 Method TSAPxRFCObjectsListGS.FindObject

Class


Description

Searches for a specified object in the list by its name. If no object was found, FindObject returns nil.

AName - name of object to find.

Returns reference to finded object.

Syntax

protected function FindObject(const AName: String): TSAPxRFCListObjectGS;

1.4.7.1.17.1.11 Method TSAPxRFCObjectsListGS.FreeRfcData

Class


Description

Clears and frees buffer containing RFC data.

Syntax

protected procedure FreeRfcData; virtual;

1.4.7.1.17.1.12 Method TSAPxRFCObjectsListGS.GetObjectClass

Class


Description

Returns a base class of objects kept in Items ( see page 323). Method AddObject ( see page 319) ads objects ofGetObjectClass class, but AddObjectEx ( see page 319) can add objects of classes, which are subclasses of


313

1

GetObjectClass class.

Syntax

protected class function GetObjectClass: TSAPxRFCListObjectClassGS; virtual;

1.4.7.1.17.1.13 Method TSAPxRFCObjectsListGS.GetObjectRfcDataSize

Class


Description

Returns a size of RFC data of one object in the list. All objects in the list must have the same RFC data size.

Syntax

protected class function GetObjectRfcDataSize: LongWord;

1.4.7.1.17.1.14 Method TSAPxRFCObjectsListGS.GetRfcData

Class


Description

Gets an RFC data. See RfcData ( see page 323) for details.

Syntax

protected function GetRfcData: IntPtr; virtual;

1.4.7.1.17.1.15 Method TSAPxRFCObjectsListGS.GetRfcDataSize

Class


Description

Gets an RFC data size. See RfcDataSize ( see page 324) for details.

Syntax

protected function GetRfcDataSize: LongWord; virtual;

1.4.7.1.17.1.16 Method TSAPxRFCObjectsListGS.IndexOf

Class


Description

Returns the index of a AObj object in the Items ( see page 323) array.

AObj - object to locate.

Returns index of AObj object.

Syntax

public function IndexOf(AObj: TSAPxRFCListObjectGS): Integer;

1.4.7.1.17.1.17 Method TSAPxRFCObjectsListGS.ListDataChanged

Class


Description

Method is called by Connect for SAP®, when list data is changed.


314

1

Syntax

protected procedure ListDataChanged; virtual;

1.4.7.1.17.1.18 Method TSAPxRFCObjectsListGS.ListDataChanging

Class


Description

Method is called by Connect for SAP®, before list data will be changed.

Syntax

protected procedure ListDataChanging; virtual;

1.4.7.1.17.1.19 Method TSAPxRFCObjectsListGS.Refresh

Class


Description

Refresh the RfcData ( see page 323) data buffer by rereading the RfcData ( see page 260) data buffers of all RFCobjects from Items ( see page 323) array.

Syntax

public procedure Refresh;

1.4.7.1.17.1.20 Method TSAPxRFCObjectsListGS.Remove

Class


Description

Removes the object with the AIndex index from the list. Removed object will be returned to the method caller.

AIndex - index of object to remove.

Returns a reference to removed object.

Syntax

public function Remove(AIndex: Integer): TSAPxRFCListObjectGS;


1.4.7.1.17.2.1 Property TSAPxRFCObjectsListGS.Count

Class


Description

Indicates a number of entries in the Items ( see page 323) array.

Syntax


1.4.7.1.17.2.2 Property TSAPxRFCObjectsListGS.Items

Class



315

1

Description

Returns a reference to a object in the list by its index.

AIndex - index of object in the list.

Syntax

public property Items [AIndex: integer]: TSAPxRFCListObjectGS;

1.4.7.1.17.2.3 Property TSAPxRFCObjectsListGS.Owner

Class


Description

Specifies an RFC object owning this RFC object list.

Syntax

public property Owner: TSAPxRFCObjectGS;

1.4.7.1.17.2.4 Property TSAPxRFCObjectsListGS.RfcData

Class


Description

Returns a pointer to buffer filled by data of RFC objects from list. Also is added trailing zeroed space of the same length asobjects in the list, as it is required by SAP RFC API.

Syntax

public property RfcData: IntPtr;

1.4.7.1.17.2.5 Property TSAPxRFCObjectsListGS.RfcDataSize

Class


Description

Specifies a size of data buffer which RfcData points to. The RfcDataSize equals to GetObjectRfcDataSize ( see page 321)* (Count ( see page 323) + 1). Where 1 is added for zeroed space at end of the buffer.

Syntax

public property RfcDataSize: LongWord;

1.4.7.1.18 Class TSAPxRFCParameterGS Unit


Legend

Constructor

All Members

Methods




316

1


































Properties











317

1




























Methods




















318

1


















Properties





























319

1










File

gsSAPxRFCStdObj

Description

TSAPxRFCParameterGS allows:

• to set the value of a parameter to call a function module and to get one after call. See TSAPxRFCFunctionGS ( see page 299), InParams ( see page 309) and OutParams ( see page 309) for details.

• to receive the value of parameter at call of Connect for SAP(R) server function module and to send one after call. See TSAPxRFCServerFunctionGS ( see page 155), InParameters ( see page 159) and OutParameters ( see page 160) for details.

TSAPxRFCParameterGS encapsulates RFC_PARAMETER ( see page 25) structure. Array of this structures SAP clienttransmits to SAP server before function module call and receives back after call. The similar schema is used by Connect forSAP® server for server function modules.

Parameter data is defined by data type (DataType ( see page 334)), type handle (TypeHandle ( see page 335)) and datasize (DataSize ( see page 334)). Parameter value may be either of simple data type either of structured data type(dtStructureGS ( see page 393)). In last case TypeHandle ( see page 335) property should set to inform SAP RFC aboutparameter buffer layout (a set of fields). Connect for SAP® automatically performs that at function preparation. SeeTSAPxRFCFunctionGS ( see page 299) for details.

DataPtr ( see page 334) points to buffer containing parameter data. The data can be represented in different formats. Thefollowing methods - AsString ( see page 332), AsDate ( see page 331), AsBCD ( see page 330), AsTime ( see page332), AsBytes ( see page 331), AsStruct ( see page 332), AsDouble ( see page 331), AsInteger ( see page 331),AsByte ( see page 330), AsWord ( see page 333), AsNumber ( see page 331), AsVariant ( see page 332),AsVarString ( see page 333), AsVarBytes ( see page 332) and AsXMLString ( see page 333) allow to get parameterdata in specific format. If parameter has a structured type, SubFields ( see page 335) accesses to the structure's fields.

See example of using TSAPxRFCParameterGS object there ( see page 299).

Syntax

public TSAPxRFCParameterGS = class(TSAPxRFCListObjectGS);

1.4.7.1.18.1 Methods

1.4.7.1.18.1.1 Method TSAPxRFCParameterGS.Assign

Class

Class TSAPxRFCParameterGS ( see page 324)


320

1

Description

Assigns RFC data type and value of one parameter or field to current parameter.

AObj - The assigning object reference. Object should of one of following classes - TSAPxRFCFieldGS ( see page 281) orTSAPxRFCParameterGS ( see page 324).

Syntax

public procedure Assign(AObj: TSAPxRFCDataObjectGS); override;

1.4.7.1.18.1.2 Method TSAPxRFCParameterGS.CheckDefinition

Class


Syntax


1.4.7.1.18.1.3 Constructor TSAPxRFCParameterGS.Create

Class


Description

Creates a new TSAPxRFCParameterGS object.

Syntax


1.4.7.1.18.1.4 Destructor TSAPxRFCParameterGS.Destroy

Class


Description

Destroys the TSAPxRFCParameterGS instance.

Syntax


1.4.7.1.18.1.5 Method TSAPxRFCParameterGS.Erase

Class


Description

Erases field's data. After call IsNull ( see page 334) property will return True.

Syntax


1.4.7.1.18.1.6 Method TSAPxRFCParameterGS.GetName

Class


Description

Gets a parameter name.


321

1

Syntax


1.4.7.1.18.1.7 Method TSAPxRFCParameterGS.GetRfcData

Class


Description

Gets an RFC data.

Returns a pointer to encapsulated RFC_PARAMETER ( see page 25) structure.

Syntax


1.4.7.1.18.1.8 Method TSAPxRFCParameterGS.GetRfcDataSize

Class


Description

Gets an RFC data size.

Returns a size of RFC_PARAMETER ( see page 25) structure.

Syntax


1.4.7.1.18.1.9 Method TSAPxRFCParameterGS.ReadFromBuffer

Class


Description

Reads GetRfcDataSize bytes from ABuf to RfcData.

ABuf - pointer to buffer from which to read a data.

Syntax

public procedure ReadFromBuffer(ABuf: IntPtr); override;

1.4.7.1.18.1.10 Method TSAPxRFCParameterGS.SetName

Class


Description

Sets the parameter new name.

Syntax




322

1

1.4.7.1.18.2.1 Property TSAPxRFCParameterGS.AsBCD

Class


Description

Represents the parameters's value as Currency. Corresponds to RFCTYPE_BCD ( see page 78) RFC type.

Syntax


1.4.7.1.18.2.2 Property TSAPxRFCParameterGS.AsByte

Class


Description

Represents the parameters's value as ShortInt. Corresponds to RFCTYPE_INT1 ( see page 81) RFC type.

Syntax


1.4.7.1.18.2.3 Property TSAPxRFCParameterGS.AsBytes

Class


Description

Represents the parameters's value as string of bytes of fixed length. Corresponds to RFCTYPE_BYTE ( see page 79) RFCdata type.

Syntax


1.4.7.1.18.2.4 Property TSAPxRFCParameterGS.AsDate

Class


Description

Represents the parameters's value as TDateTime. Corresponds to RFCTYPE_DATE ( see page 79) RFC data type.

Syntax


1.4.7.1.18.2.5 Property TSAPxRFCParameterGS.AsDouble

Class


Description

Represents the parameters's value as Double. Corresponds to RFCTYPE_FLOAT ( see page 80) RFC data type.

Syntax


1.4.7.1.18.2.6 Property TSAPxRFCParameterGS.AsInteger

Class



323

1

Description

Represents the parameters's value as Integer. Corresponds to RFCTYPE_INT ( see page 80) RFC data type.

Syntax


1.4.7.1.18.2.7 Property TSAPxRFCParameterGS.AsNumber

Class


Description

Represents the parameters's value as Int64. Corresponds to RFCTYPE_NUM ( see page 82) RFC data type.

Syntax

public property AsNumber: UInt64;

1.4.7.1.18.2.8 Property TSAPxRFCParameterGS.AsString

Class


Description

Represents the parameters's value as string of fixed length. Corresponds to RFCTYPE_CHAR ( see page 79) RFC datatype.

Syntax


1.4.7.1.18.2.9 Property TSAPxRFCParameterGS.AsStruct

Class


Description

Represents the parameters's value as structured byte string of fixed length. Corresponds to RFCTYPE_STRUCTURE (see page 83) RFC data type.

Syntax


1.4.7.1.18.2.10 Property TSAPxRFCParameterGS.AsTime

Class


Description

Represents the parameters's value as TDateTime. Corresponds to RFCTYPE_TIME ( see page 83) RFC data type.

Syntax


1.4.7.1.18.2.11 Property TSAPxRFCParameterGS.AsVarBytes

Class


Description

Represents the parameters's value as byte string of variable length. Corresponds to RFCTYPE_XSTRING ( see page 85)RFC data type.


324

1

Syntax


1.4.7.1.18.2.12 Property TSAPxRFCParameterGS.AsVariant

Class


Description

Represents the parameters's value as Variant.

Syntax


1.4.7.1.18.2.13 Property TSAPxRFCParameterGS.AsVarString

Class


Description

Represents the parameters's value as variable length string. Corresponds to RFCTYPE_STRING ( see page 83) RFC datatype.

Syntax


1.4.7.1.18.2.14 Property TSAPxRFCParameterGS.AsWord

Class


Description

Represents the parameters's value as SmallInt. Corresponds to RFCTYPE_INT2 ( see page 81) RFC data type.

Syntax


1.4.7.1.18.2.15 Property TSAPxRFCParameterGS.AsXMLString

Class


Description

Represents the parameters's value as XML formatted string. Corresponds to RFCTYPE_XMLDATA ( see page 85) RFCdata type.

Syntax


1.4.7.1.18.2.16 Property TSAPxRFCParameterGS.CharacterSize

Class


Description

Specifies an parameter data size in characters. Property allows to change size of value buffer.

Syntax



325

1

1.4.7.1.18.2.17 Property TSAPxRFCParameterGS.DataLength

Class


Description

Returns actual length of parameter raw value buffer. Property references to leng ( see page 25) field ofRFC_PARAMETER ( see page 25) structure, encapsulated by parameter. See also DataPtr ( see page 334).

Syntax

public property DataLength: LongWord;

1.4.7.1.18.2.18 Property TSAPxRFCParameterGS.DataPtr

Class


Description

Returns actual address of parameter raw value buffer. Property references to addr ( see page 25) field ofRFC_PARAMETER ( see page 25) structure, encapsulated by parameter. See also DataLength ( see page 333).

Syntax

public property DataPtr: IntPtr;

1.4.7.1.18.2.19 Property TSAPxRFCParameterGS.DataSize

Class


Description

Specifies an parameter data size in bytes. Property allows to change size of value buffer.

Syntax


1.4.7.1.18.2.20 Property TSAPxRFCParameterGS.DataType

Class


Description

Specifies an Connect for SAP® data type.

Syntax


1.4.7.1.18.2.21 Property TSAPxRFCParameterGS.Decimals

Class


Description

Specifies a number of digits after decimal point.

Syntax



326

1

1.4.7.1.18.2.22 Property TSAPxRFCParameterGS.IsNull

Class


Description

Indicates whether the parameter has a value assigned to it. To erase field value call Erase ( see page 329) method.

Syntax


1.4.7.1.18.2.23 Property TSAPxRFCParameterGS.ParameterType

Class


Description

Specifies the parameter data transfer mode.

ptExportGS - data is transfered from SAP server function module to client only.

ptImportGS - data is transfered from client to SAP server function module only.

ptImportExportGS - data is transfered in both directions.

Syntax

public property ParameterType: TSAPxRFCParameterTypeGS;

1.4.7.1.18.2.24 Property TSAPxRFCParameterGS.StructName

Class


Description

Specifies an SAP data structure name. If this property is assigned, then:

• if parameters SubFields ( see page 335) is empty, then a function Prepare ( see page 227) call will fill SubFields ( see page 335) automatically.

• if TypeHandle is not specified and parameters SubFields ( see page 335) is not empty, then Connect for SAP will automatically install new structure and assign corresponding values to TypeHandle ( see page 335) and DataSize ( see page 334).

Syntax

public property StructName: String;

1.4.7.1.18.2.25 Property TSAPxRFCParameterGS.SubFields

Class


Description

Lists a set of fields forming a structure, when parameter has dtStructureGS ( see page 393) data type.

Syntax

public property SubFields: TSAPxRFCFieldsListGS;

1.4.7.1.18.2.26 Property TSAPxRFCParameterGS.TypeHandle

Class



327

1

Description

Specifies an RFC data type handle. The handle is used for structured data types when DataType ( see page 334) isdtStructureGS ( see page 393). Assigning this property does not fill SubFields ( see page 335) automatically (andbackward). This is required rather to inform SAP RFC about parameter buffer layout.

Syntax


1.4.7.1.19 Class TSAPxRFCParametersListGS Unit


Legend

Constructor

All Members

Methods

Add ( see page 318)




















Class TSAPxRFCParametersListGS

Add ( see page 338)

AddParameter ( see page 338)

AddParameterEx ( see page 338)


FindParameter ( see page 339)


ParameterByName ( see page 339)


328

1

Properties







Parameters ( see page 340)

Methods

Add ( see page 318)





















Add ( see page 338)

AddParameter ( see page 338)

AddParameterEx ( see page 338)


FindParameter ( see page 339)


ParameterByName ( see page 339)

Properties







Parameters ( see page 340)


329

1

File

gsSAPxRFCStdObj

Description

TSAPxRFCParameterListGS holds field objects. TSAPxRFCParameterListGS is used to manage parameter objects:

• by TSAPxRFCFunctionGS ( see page 299). It has 2 parameter lists InParams ( see page 309) and OutParams ( see page 309).

• by TSAPxRFCServerFunctionGS ( see page 155). It has 2 parameter lists InParameters ( see page 159) and OutParameters ( see page 160).

To add a new field to the Parameters ( see page 340) array, use AddParameter ( see page 338) method, if the parameteris of TSAPxRFCParameterGS class, or AddParameterEx ( see page 338) in other cases. FindParameter ( see page 339)allows to search for parameter by its name. When you need to erase all parameter values you have to call Erase ( seepage 339) method. See example of using TSAPxRFCParameterListGS object there ( see page 299).

Syntax

public TSAPxRFCParametersListGS = class(TSAPxRFCObjectsListGS);

1.4.7.1.19.1 Methods

1.4.7.1.19.1.1 Method TSAPxRFCParametersListGS.Add

Class

Class TSAPxRFCParametersListGS ( see page 335)

Description

Adds existing AObj parameter to Parameters array.

AObj - reference to TSAPxRFCParameterGS object to add.

Syntax

public procedure Add(AObj: TSAPxRFCListObjectGS); override;

1.4.7.1.19.1.2 Method TSAPxRFCParametersListGS.AddParameter

Class


Description

Adds new parameter to the Parameters array.

Returns the reference to new parameter.

Syntax

public function AddParameter: TSAPxRFCParameterGS;

1.4.7.1.19.1.3 Method TSAPxRFCParametersListGS.AddParameterEx

Class


Description

Adds a new AClass object to Parameters array and returns the new object.


330

1

AClass - Class of parameter to add.

Returns new added parameter.

Syntax

public function AddParameterEx(AClass: TSAPxRFCParameterClassGS): TSAPxRFCParameterGS;

1.4.7.1.19.1.4 Method TSAPxRFCParametersListGS.Erase

Class


Description

Erases all items of Parameters array. See Erase for details.

Syntax


1.4.7.1.19.1.5 Method TSAPxRFCParametersListGS.FindParameter

Class


Description

Searches for a specified parameter in the Parameters ( see page 340) array. If no field has specified name, FindParameterreturns nil.

AName - Name of parameter to find.

Returns a reference to founded parameter or nil.

Syntax

public function FindParameter(const AName: String): TSAPxRFCParameterGS;

1.4.7.1.19.1.6 Method TSAPxRFCParametersListGS.GetObjectClass

Class


Description

Base class of parameters in list. Objects of this class will be added to list at AddParameter ( see page 338) call.


Syntax


1.4.7.1.19.1.7 Method TSAPxRFCParametersListGS.ParameterByName

Class


Description

Finds a parameter by its name. If no parameter is found, ESAPxRFCExceptionGS exception is raised.

AName - Name of parameter to find.

Returns a reference to founded parameter object.


331

1

Syntax

public function ParameterByName(const AName: String): TSAPxRFCParameterGS;


1.4.7.1.19.2.1 Property TSAPxRFCParametersListGS.Parameters

Class


Description

Indexed array of the parameters.

Syntax

public property Parameters [AIndex: integer]: TSAPxRFCParameterGS;

1.4.7.1.20 Class TSAPxRFCRemoteObjectGS Fields





Unit


Legend

Constructor

All Members

Methods



















332

1












Properties



















Fields





Methods









333

1






















Properties



















File

gsSAPxRFCStdObj


334

1

Description

TSAPxRFCRemoteObjectGS represents base class to all remote objects to be called.

Syntax

public TSAPxRFCRemoteObjectGS = class(TSAPxRFCConnectedObjectGS);

1.4.7.1.20.1 Fields

1.4.7.1.20.1.1 Field TSAPxRFCRemoteObjectGS.FDefinitionState

Class

Class TSAPxRFCRemoteObjectGS ( see page 340)

Description

Determines a state of remote object meta-data.

Syntax

protected FDefinitionState: TSAPxRFCRemoteObjectDefinitionStateGS;

1.4.7.1.20.2 Methods

1.4.7.1.20.2.1 Constructor TSAPxRFCRemoteObjectGS.Create

Class


Description

Creates a new TSAPxRFCRemoteObjectGS object.

Syntax


1.4.7.1.20.2.2 Destructor TSAPxRFCRemoteObjectGS.Destroy

Class


Description

Destroys the TSAPxRFCConnectedObjectGS instance.

Syntax


1.4.7.1.20.2.3 Method TSAPxRFCRemoteObjectGS.DoIdle

Class


Description

Procedure is called by Connect for SAP® software. It implementation calls OnIdleEvent ( see page 345) event handler.Descendant classes may override this method.

Syntax

protected procedure DoIdle; virtual;

1.4.7.1.20.2.4 Method TSAPxRFCRemoteObjectGS.EnterBusyState

Class



335

1

Description

This procedure is called by Connect for SAP® software right before remote object is called. It implementation callsBeforeCallEvent ( see page 345) event handler and set Busy ( see page 345) to True.

Syntax

protected procedure EnterBusyState;

1.4.7.1.20.2.5 Method TSAPxRFCRemoteObjectGS.ExitBusyState

Class


Description

This procedure is called by Connect for SAP® software right after remote object call is finished. It implementation set Busy( see page 345) to False and calls AfterCallEvent ( see page 344) event handler.

Syntax

protected procedure ExitBusyState;

1.4.7.1.20.2.6 Method TSAPxRFCRemoteObjectGS.ObjectDefined

Class


Description

Sets definition state of remote object to dsFixedStaticGS ( see page 397) value. This method is used by descendants ofTSAPxRFCRemoteObjectGS ( see page 340) if they have statically defined meta-data. See also TSAPxRFCFunctionGS( see page 299) description.

Syntax

protected procedure ObjectDefined;


1.4.7.1.20.3.1 Property TSAPxRFCRemoteObjectGS.AfterCallEvent

Class


Description

The multicast event handler that notifies its subscribers after the remote object has been called. See also BeforeCallEvent( see page 345).

Syntax

public property AfterCallEvent: TSAPxMulticastNotifyEventGS;

1.4.7.1.20.3.2 Property TSAPxRFCRemoteObjectGS.Async

Class


Description

Indicates whether remote object uses asynchronous calling mode. When Async is True, then client software can performsome actions in OnIdleEvent ( see page 345) event handler, while SAP remote object call is not finished. If Async is False,then client software will be blocked, until SAP remote object call is finished.

Syntax

public property Async: Boolean;


336

1

1.4.7.1.20.3.3 Property TSAPxRFCRemoteObjectGS.BeforeCallEvent

Class


Description

The multicast event handler that notifies its subscribers before calling the remote object. See also AfterCallEvent ( seepage 344).

Syntax

public property BeforeCallEvent: TSAPxMulticastNotifyEventGS;

1.4.7.1.20.3.4 Property TSAPxRFCRemoteObjectGS.Busy

Class


Description

Determines whether or not remote object is in busy state. In general, remote object is in busy state (Busy is True) right afterBeforeCallEvent ( see page 345) event and up to AfterCallEvent ( see page 344) event.

Syntax

public property Busy: Boolean;

1.4.7.1.20.3.5 Property TSAPxRFCRemoteObjectGS.OnIdleEvent

Class


Description

The multicast event handler that periodically notifies its subscribers while the remote object is being called in asynchronousmode. It can be fired few times, until the call is finished. All that time Busy ( see page 345) is True.

Syntax

public property OnIdleEvent: TSAPxMulticastNotifyEventGS;

1.4.7.1.21 Class TSAPxRFCStructureCacheGS Unit


Legend

Constructor

All Members

Methods

Add ( see page 347)


DefineStructure ( see page 348)


FindStructure ( see page 348)

LookupStructure ( see page 348)

Properties



337

1

Methods

Add ( see page 347)


DefineStructure ( see page 348)


FindStructure ( see page 348)

LookupStructure ( see page 348)

Properties


File

gsSAPxRFCStdObj

Description

TSAPxRFCStructureCacheGS object is a collection of all installed structures, each of them isTSAPxRFCStructureCacheItemGS object.

SAP RFC requires to have a description of the structures used to allow automatic conversion of different datarepresentations by the RFC library. Programmer or other software should submit a description of structure to Connect forSAP®. It will install description and get a type handle. It may be assigned to TypeHandle property as of structured parameter( see page 335) as of internal table ( see page 365). Connect for SAP® software automatically process that forTSAPxRFCFunctionGS.

Connect for SAP® application must have single instance of TSAPxRFCStructureCacheGS, because all type handles areshared inside of application. So, TSAPxRFCEnvironmentGS ( see page 260) owns instance ofTSAPxRFCStructureCacheGS. See StructureCache ( see page 279) property.

If you want to find a structure among installed ones use FindStructure method. To install a structure known by SAP R/3dictionary, DescribeStructure method is used. LookupStructure method combines both calls. To install structure not knownby SAP R/3 dictionary, structure description should formed by hands.

Following example installs custom structure "MyStr" and fill parameter sub fields according to this structure definition.

Example

var oStr: TSAPxRFCStructureCacheItemGS; oPar: TSAPxRFCParameterGS; i: Integer;begin oStr := FEnvironment.StructureCache.FindStructure('MyStr'); if oStr = nil then begin oStr := FEnvironment.StructureCache.Add; with oStr do begin StructName := AStrucName; with Elements.AddElement do begin Name := 'F_ACCP'; DataType := dtNumGS; DataSize := 6; Offset := 0; end;


338

1

with Elements.AddElement do begin Name := 'F_CHAR'; DataType := dtCharGS; DataSize := 10; Offset := 6; end; with Elements.AddElement do begin Name := 'F_CLNT'; DataType := dtCharGS; DataSize := 3; Offset := 16; end; end; oStr.Install; end; oPar.TypeHandle := oStr.TypeHandle; oPar.SubFields.Clear; for i := 0 to oStr.Elements.Count - 1 do oStr.Elements[i].CreateField(oPar.SubFields);end;

Syntax

public TSAPxRFCStructureCacheGS = class(TCollection);

1.4.7.1.21.1 Methods

1.4.7.1.21.1.1 Method TSAPxRFCStructureCacheGS.Add

Class

Class TSAPxRFCStructureCacheGS ( see page 345)

Description

Creates a new TSAPxRFCStructureCacheItemGS instance and adds it to the cache.

Returns the new TSAPxRFCStructureCacheItemGS object.

Syntax

public function Add: TSAPxRFCStructureCacheItemGS;

1.4.7.1.21.1.2 Constructor TSAPxRFCStructureCacheGS.Create

Class


Description

Creates a new TSAPxRFCStructureCacheGS object as a collection of TSAPxRFCStructureCacheItemGS objects.

Syntax


1.4.7.1.21.1.3 Method TSAPxRFCStructureCacheGS.DefineStructure

Class


Description

Returns the structure description object with the specified AName. If no structure has the specified AName, then will becreated and installed new structure. It will derive the layout from AFields.

AName - a structure name to find.


339

1

AFields - a list of fields, which will be used to derive structure layout.

Returns a reference to found object or nil.

Syntax

public function DefineStructure(const AName: String; AFields: TSAPxRFCFieldsListGS): TSAPxRFCStructureCacheItemGS;

1.4.7.1.21.1.4 Destructor TSAPxRFCStructureCacheGS.Destroy

Class


Syntax


1.4.7.1.21.1.5 Method TSAPxRFCStructureCacheGS.FindStructure

Class


Description

Returns the structure description object with the specified AName. If no structure has the specified AName, FindStructurereturns nil.

AName - structure name to find.

Returns a reference to found object or nil.

Syntax

public function FindStructure(const AName: String): TSAPxRFCStructureCacheItemGS;

1.4.7.1.21.1.6 Method TSAPxRFCStructureCacheGS.LookupStructure

Class


Description

Looks up the structure specified by AName in the cache. If no structure is found, LookupStructure calls DescribeStructure.

Syntax

public function LookupStructure(const AName: String; AConnection: TSAPxRFCCustomConnectionGS): TSAPxRFCStructureCacheItemGS;


1.4.7.1.21.2.1 Property TSAPxRFCStructureCacheGS.Items

Class


Description

Property returns the structure description object by its index in the cache.

Syntax

public property Items [AIndex: Integer]: TSAPxRFCStructureCacheItemGS;


340

1

1.4.7.1.22 Class TSAPxRFCStructureCacheItemGS Unit


Legend

Constructor

All Members

Methods



Install ( see page 350)

Properties


Elements ( see page 351)



Methods



Install ( see page 350)

Properties





File

gsSAPxRFCStdObj

Description

TSAPxRFCStructureCacheItemGS encapsulates RFC structure definition and is item of TSAPxRFCStructureCacheGS (see page 345) collection.

The RFC structure is identified by their StructName ( see page 351), has a set of fields in Elements ( see page 351)collection. And after structure definition is installed, it has not null value of TypeHandle ( see page 351) property. "Installed"means - RFC structure definition is known to SAP RFC library, it has assigned type handle and can be sent to / receivedfrom SAP server.

If you does not use dynamic preparation of functions, then you should take care to assign type handle to function structuredparameters and function tables. Connect for SAP® supports two ways to create TSAPxRFCStructureCacheItemGS objectsand get type handle:

• using SAP server dictionary. Use TSAPxRFCStructureCacheGS ( see page 345) methods DescribeStructure, LookupStructure ( see page 348). They will get required info from SAP server using StructName.


341

1

• by hands. Call Add ( see page 347) method, set StructName ( see page 351), fill Elements ( see page 351) property and then call Install ( see page 350).

See example of using a TSAPxRFCStructureCacheItemGS object there ( see page 345).

Syntax

public TSAPxRFCStructureCacheItemGS = class(TCollectionItem);

1.4.7.1.22.1 Methods

1.4.7.1.22.1.1 Constructor TSAPxRFCStructureCacheItemGS.Create

Class

Class TSAPxRFCStructureCacheItemGS ( see page 349)

Description

Creates a new TSAPxRFCStructureCacheItemGS object as an item in the ACollection.

Syntax

public constructor Create(ACollection: TCollection); override;

1.4.7.1.22.1.2 Destructor TSAPxRFCStructureCacheItemGS.Destroy

Class


Description

Destroys the TSAPxRFCStructureCacheItemGS instance.

Syntax


1.4.7.1.22.1.3 Method TSAPxRFCStructureCacheItemGS.Install

Class


Description

Installs a structure description, registering it at SAP RFC library. After that call TypeHandle ( see page 351) property valueis not null and may be used. Method may be called as explicitly by programmer, as a part of DescribeStructure orLookupStructure ( see page 348) calls.

Syntax

public procedure Install;


1.4.7.1.22.2.1 Property TSAPxRFCStructureCacheItemGS.DataSize

Class


Description

Determines a structure total size.

Syntax



342

1

1.4.7.1.22.2.2 Property TSAPxRFCStructureCacheItemGS.Elements

Class


Description

Returns a list of structure definition field objects.

Syntax

public property Elements: TSAPxRFCTypeElementsListGS;

1.4.7.1.22.2.3 Property TSAPxRFCStructureCacheItemGS.StructName

Class


Description

Determines a structure name.

Syntax


1.4.7.1.22.2.4 Property TSAPxRFCStructureCacheItemGS.TypeHandle

Class


Description

Returns a structure definition type handle, returned by RFC library after installing the structure. Property value is accessibleafter Install ( see page 350) method call.

Syntax


1.4.7.1.23 Class TSAPxRFCTableGS Unit


Legend

Constructor

All Members

Methods










343

1

















Class TSAPxRFCTableGS

Append ( see page 356)




CopyRecord ( see page 357)


CreateStandalone ( see page 357)



Edit ( see page 358)


FetchRow ( see page 358)



First ( see page 359)






InitBuffer ( see page 360)

Insert ( see page 360)

Last ( see page 360)

Next ( see page 361)


Post ( see page 361)

Prior ( see page 361)




344

1

Properties












Bof ( see page 362)

Eof ( see page 363)



PreallocRows ( see page 363)


RecNo ( see page 364)

RecordCount ( see page 364)

RecordSize ( see page 364)

State ( see page 364)


TableFormat ( see page 365)

TableHandle ( see page 365)

TableMode ( see page 365)

TableType ( see page 365)


Methods

















345

1















CopyRecord ( see page 357)


CreateStandalone ( see page 357)



Edit ( see page 358)


FetchRow ( see page 358)



First ( see page 359)






InitBuffer ( see page 360)

Insert ( see page 360)

Last ( see page 360)

Next ( see page 361)


Post ( see page 361)

Prior ( see page 361)



Properties







346

1







Bof ( see page 362)

Eof ( see page 363)



PreallocRows ( see page 363)


RecNo ( see page 364)

RecordCount ( see page 364)

RecordSize ( see page 364)

State ( see page 364)


TableFormat ( see page 365)

TableHandle ( see page 365)

TableMode ( see page 365)

TableType ( see page 365)


File

gsSAPxRFCStdObj

Description

TSAPxRFCTableGS encapsulates a SAP RFC internal table.

The table may be either standalone, either belong to function. In last case, the table accessed is specified by the Name (see page 363) property value. If function was either dynamically prepared either statically, using generated by Connect forSAP® Explorer wrapper classes, table structure is automatically defined. In other cases, programmer should define tablestructure by hands. The table data is accessible after table is open by calling Open ( see page 361) method.

Navigating and editing of a TSAPxRFCTableGS object is similar to TDataSet. Use such methods as First ( see page 359),Next ( see page 361), Last ( see page 360) and Prior ( see page 361) to programmatically move the current row pointerthrough the set of records. Use methods Insert ( see page 360) and Edit ( see page 358) to put the TSAPxRFCTableGSin edit mode. Post ( see page 361) finalizes data changes and Cancel ( see page 356) cancels updates to row andreverts field values to their original values.

Example

var oTab: TSAPxRFCTableGS;begin AMyFunc.Prepare; oTab := AMyFunc.TableByName('DATA'); with oTab do begin Erase;


347

1

for i := 0 to SomeValues.Count - 1 do begin Append; FieldByName('FIELD').AsString := SomeValues[i]; Post; end; end; AMyFunc.ExecFunction;end;

Syntax

public TSAPxRFCTableGS = class(TSAPxRFCListObjectGS);

1.4.7.1.23.1 Methods

1.4.7.1.23.1.1 Method TSAPxRFCTableGS.Append

Class

Class TSAPxRFCTableGS ( see page 351)

Description

Starts a addition of new, empty record into end of the table. After that State ( see page 364) property values is rsInsertGS( see page 397). New record will be appended to the table after Post ( see page 361) call. Cancel ( see page 356) callcancels addition of new record. To insert new record after current one use Insert ( see page 360) method.

Syntax

public procedure Append;

1.4.7.1.23.1.2 Method TSAPxRFCTableGS.Cancel

Class


Description

Cancels modifications to the active record if those changes are not yet posted.

Syntax

public procedure Cancel;

1.4.7.1.23.1.3 Method TSAPxRFCTableGS.CheckDefinition

Class


Syntax


1.4.7.1.23.1.4 Method TSAPxRFCTableGS.Close

Class


Description

Closes a dataset. After that call table will have no records.

Syntax


1.4.7.1.23.1.5 Method TSAPxRFCTableGS.CopyRecord

Class



348

1

Description

Copies current record to buffer.

Syntax

public procedure CopyRecord(ABuffer: IntPtr);

1.4.7.1.23.1.6 Constructor TSAPxRFCTableGS.Create

Class


Description

Creates a new TSAPxRFCTableGS object.

Syntax


1.4.7.1.23.1.7 Constructor TSAPxRFCTableGS.CreateStandalone

Class


Description

Creates a new TSAPxRFCTableGS object with AOwner owner object.

Syntax

public constructor CreateStandalone(AOwner: TSAPxRFCObjectGS);

1.4.7.1.23.1.8 Method TSAPxRFCTableGS.Delete

Class


Description

Deletes the active record and positions the cursor on the next record.

Syntax

public procedure Delete;

1.4.7.1.23.1.9 Destructor TSAPxRFCTableGS.Destroy

Class


Description

Destroys the TSAPxRFCTableGS instance.

Syntax


1.4.7.1.23.1.10 Method TSAPxRFCTableGS.Edit

Class


Description

Begin editing of current record data in the table. After that you can change table field values. To save changes to underlyingtable call Post ( see page 361) method. To undo changes to current record call Cancel ( see page 356) method. AfterEditcall State ( see page 364) will be rsEditGS ( see page 397). If there are no records in the table, then Edit call is thesame as Append ( see page 356) call.


349

1

Syntax

public procedure Edit;

1.4.7.1.23.1.11 Method TSAPxRFCTableGS.Erase

Class


Description

Deletes all records in the table.

Syntax


1.4.7.1.23.1.12 Method TSAPxRFCTableGS.FetchRow

Class


Description

Fetches a row from a SAP table. Row number is specified by RecNo property.

Syntax

public procedure FetchRow;

1.4.7.1.23.1.13 Method TSAPxRFCTableGS.FieldByName

Class


Description

Finds a field by its name. If no field is found, ESAPxRFCExceptionGS exception is raised.


Returns a reference to TSAPxRFCFieldGS object.

Syntax

public function FieldByName(const AName: String): TSAPxRFCFieldGS;

1.4.7.1.23.1.14 Method TSAPxRFCTableGS.FindField

Class


Description

Finds a field by its name. If no field has specified name, FindField returns nil.


Returns a reference to TSAPxRFCFieldGS object or nil.

Syntax

public function FindField(const AName: String): TSAPxRFCFieldGS;


350

1

1.4.7.1.23.1.15 Method TSAPxRFCTableGS.First

Class


Description

Positions the current record pointer on the first record in the table. See also Last ( see page 360), Next ( see page 361)and Prior ( see page 361) methods.

Syntax

public procedure First;

1.4.7.1.23.1.16 Method TSAPxRFCTableGS.GetDataFormat

Class


Description

Returns a data format object reference.

Syntax


1.4.7.1.23.1.17 Method TSAPxRFCTableGS.GetName

Class


Description

Gets a table name.

Syntax


1.4.7.1.23.1.18 Method TSAPxRFCTableGS.GetParentDataFormat

Class


Description

Returns a parent data format object reference.

Syntax


1.4.7.1.23.1.19 Method TSAPxRFCTableGS.GetRfcData

Class


Description

Returns a pointer to RFC_TABLE ( see page 28) structure.

Syntax


1.4.7.1.23.1.20 Method TSAPxRFCTableGS.GetRfcDataSize

Class



351

1

Description

Returns a size of RFC_TABLE ( see page 28) structure.

Syntax


1.4.7.1.23.1.21 Method TSAPxRFCTableGS.InitBuffer

Class


Description

Set all fields to empty and unmodified state.

Syntax

public procedure InitBuffer;

1.4.7.1.23.1.22 Method TSAPxRFCTableGS.Insert

Class


Description

Starts a insertion of new, empty record into the table. After that State ( see page 364) property values is rsInsertGS ( seepage 397). New record will be inserted into table after Post ( see page 361) call. Cancel ( see page 356) call cancelsaddition of new record. To add new record to end of the table use Append ( see page 356) method.

Syntax

public procedure Insert;

1.4.7.1.23.1.23 Method TSAPxRFCTableGS.Last

Class


Description

Positions the current record pointer on the last record one in the table. See also First ( see page 359), Next ( see page361) and Prior ( see page 361) methods.

Syntax

public procedure Last;

1.4.7.1.23.1.24 Method TSAPxRFCTableGS.Next

Class


Description

Moves the current record pointer to the next record in the table. If current record is a last record in the table, then positionremains the same and Eof ( see page 363) property is True. See also First ( see page 359), Last ( see page 360) andPrior ( see page 361) methods.

Syntax

public procedure Next;

1.4.7.1.23.1.25 Method TSAPxRFCTableGS.Open

Class



352

1

Description

Opens a table.

Syntax


1.4.7.1.23.1.26 Method TSAPxRFCTableGS.Post

Class


Description

Post changes to SAP RFC internal table:

• after Insert ( see page 360) call to add new record;

• after Edit ( see page 358) call to modify existing record.

After that call State ( see page 364) is rsBrowseGS ( see page 397).

Syntax

public procedure Post;

1.4.7.1.23.1.27 Method TSAPxRFCTableGS.Prior

Class


Description

Moves current record pointer to previous record in the table. If current record is a first record in the table, then positionremains the same and Bof ( see page 362) property is True. See also First ( see page 359), Last ( see page 360) andNext ( see page 361) methods.

Syntax

public procedure Prior;

1.4.7.1.23.1.28 Method TSAPxRFCTableGS.Refresh

Class


Description

Rereads current record from SAP RFC table.

Syntax

public procedure Refresh;

1.4.7.1.23.1.29 Method TSAPxRFCTableGS.SetName

Class


Description

Sets a table name.

Syntax




353

1

1.4.7.1.23.2.1 Property TSAPxRFCTableGS.Active

Class


Description

Specifies whether or not a table is open.

Syntax


1.4.7.1.23.2.2 Property TSAPxRFCTableGS.Bof

Class


Description

Indicates a trial to move current record pointer before first record in table. Property is a True after one of actions:

• Open ( see page 361) a dataset.

• Close ( see page 357) a dataset.

• Call a table's First ( see page 359) method.

• Call a table's Prior ( see page 361) method, and the method fails because the first row is already active.

• Call a table's Last ( see page 360), Next ( see page 361), Refresh ( see page 362), Delete ( see page 357) methods and table is empty.

• Set RecNo ( see page 364) property value before first record.

Syntax

public property Bof: Boolean;

1.4.7.1.23.2.3 Property TSAPxRFCTableGS.Eof

Class


Description

Indicates a trial to move current record pointer after last record in table. Property is a True after one of actions:

• Close ( see page 357) a dataset.

• Call a table's Last ( see page 360) method.

• Call a table's Next ( see page 361) method, and the method fails because the last row is already active.

• Call a table's Open ( see page 361), First ( see page 359), Prior ( see page 361), Refresh ( see page 362) methods and table is empty.

• Call s table's Delete ( see page 357) method and last record was deleted.

• Set RecNo ( see page 364) property value after last record.

Syntax

public property Eof: Boolean;

1.4.7.1.23.2.4 Property TSAPxRFCTableGS.Fields

Class



354

1

Description

Returns a list of table fields.

Syntax

public property Fields: TSAPxRFCFieldsListGS;

1.4.7.1.23.2.5 Property TSAPxRFCTableGS.Name

Class


Description

Determines the function table name.

Syntax


1.4.7.1.23.2.6 Property TSAPxRFCTableGS.PreallocRows

Class


Description

Specifies a count of table rows for which a memory is allocated during dataset opening.

Syntax

public property PreallocRows: LongInt;

1.4.7.1.23.2.7 Property TSAPxRFCTableGS.ReadOnly

Class


Description

Specifies whether table data can be modified.

Syntax


1.4.7.1.23.2.8 Property TSAPxRFCTableGS.RecNo

Class


Description

Determine the active record index in the table.

Syntax

public property RecNo: LongInt;

1.4.7.1.23.2.9 Property TSAPxRFCTableGS.RecordCount

Class


Description

Indicates the total number of records in the table.

Syntax

public property RecordCount: LongInt;


355

1

1.4.7.1.23.2.10 Property TSAPxRFCTableGS.RecordSize

Class


Description

Specifies a size of the table record.

Syntax

public property RecordSize: LongWord;

1.4.7.1.23.2.11 Property TSAPxRFCTableGS.State

Class


Description

Indicates the current operating mode of the table.

Syntax

public property State: TSAPxRFCTableStateGS;

1.4.7.1.23.2.12 Property TSAPxRFCTableGS.StructName

Class


Description

Specifies an SAP data structure name. If this property is assigned, then:

• if tables Fields ( see page 363) is empty, then a function Prepare ( see page 227) call or table Open ( see page 361) call will fill Fields ( see page 363) automatically.

• if TypeHandle is not specified and parameters Fields ( see page 363) is not empty, then Connect for SAP will automatically install new structure and assign corresponding values to TypeHandle ( see page 335) and RecordSize ( see page 364).

Syntax


1.4.7.1.23.2.13 Property TSAPxRFCTableGS.TableFormat

Class


Syntax

public property TableFormat: TSAPxRFCReadTableFormatGS;

1.4.7.1.23.2.14 Property TSAPxRFCTableGS.TableHandle

Class


Description

Returns ITAB_H ( see page 31) handle to SAP RFC internal table.

Syntax

public property TableHandle: ITAB_H;


356

1

1.4.7.1.23.2.15 Property TSAPxRFCTableGS.TableMode

Class


Description

Specifies an "itmode ( see page 28)" field of RFC_TABLE ( see page 28) record.

Syntax

public property TableMode: RFC_ITMODE;

1.4.7.1.23.2.16 Property TSAPxRFCTableGS.TableType

Class


Description

Specifies a "type ( see page 28)" field of RFC_TABLE ( see page 28) record as data type.

Syntax

public property TableType: TSAPxRFCDataTypeGS;

1.4.7.1.23.2.17 Property TSAPxRFCTableGS.TypeHandle

Class


Description

Specifies a "type ( see page 28)" field of RFC_TABLE ( see page 28) record as data type handle. Assigning this propertydoes not fill Fields ( see page 363) automatically. This is required rather to inform SAP RFC about table record bufferlayout.

Syntax


1.4.7.1.24 Class TSAPxRFCTablesListGS Unit


Legend

Constructor

All Members

Methods

Add ( see page 318)











357

1











Class TSAPxRFCTablesListGS

AddTable ( see page 368)

AddTableEx ( see page 368)





Properties








Methods

Add ( see page 318)




















358

1



AddTable ( see page 368)

AddTableEx ( see page 368)





Properties








File

gsSAPxRFCStdObj

Description

TSAPxRFCTablesListGS holds table objects. TSAPxRFCTablesListGS is used by function to manage a set of SAP tables.

To add a new table to the list use AddTable ( see page 368) method, if the table has TSAPxRFCTableGS ( see page351) class or AddTableEx ( see page 368) for descendant classes. FindTable ( see page 368) allows to search forspecific table. When you need to erase all tables you have to call Erase ( see page 368) method.

Syntax

public TSAPxRFCTablesListGS = class(TSAPxRFCObjectsListGS);

1.4.7.1.24.1 Methods

1.4.7.1.24.1.1 Method TSAPxRFCTablesListGS.AddTable

Class

Class TSAPxRFCTablesListGS ( see page 366)

Description

Adds a new table object to Tables ( see page 369) array.

Returns the new field.

Syntax

public function AddTable: TSAPxRFCTableGS;

1.4.7.1.24.1.2 Method TSAPxRFCTablesListGS.AddTableEx

Class



359

1

Description

Adds a new AClass object to Tables ( see page 369) array and returns the new object. AClass must be descendant ofTSAPxRFCTableGS ( see page 351).

AClass - Class of table to add.

Returns new added field.

Syntax

public function AddTableEx(AClass: TSAPxRFCTableClassGS): TSAPxRFCTableGS;

1.4.7.1.24.1.3 Method TSAPxRFCTablesListGS.Erase

Class


Description

Erases all tables data. After that call of TSAPxRFCTableGS.RecordCount ( see page 364) for any table in the list willreturn zero.

Syntax


1.4.7.1.24.1.4 Method TSAPxRFCTablesListGS.FindTable

Class


Description

Searches for a specified table in the Tables ( see page 369) array. If no table has specified name, FindTable returns nil.

AName - Name of table to find.

Returns a reference to founded table or nil.

Syntax

public function FindTable(const AName: String): TSAPxRFCTableGS;

1.4.7.1.24.1.5 Method TSAPxRFCTablesListGS.GetObjectClass

Class


Description

Base class of tables in list. Objects of this class will be added to the list at AddTable ( see page 368) call.


Syntax


1.4.7.1.24.1.6 Method TSAPxRFCTablesListGS.TableByName

Class



360

1

Description

Finds a table by its name. If no table is found, ESAPxRFCExceptionGS ( see page 21) exception is raised.

AName - Name of table to find.

Returns a reference to founded table object.

Syntax

public function TableByName(const AName: String): TSAPxRFCTableGS;


1.4.7.1.24.2.1 Property TSAPxRFCTablesListGS.Tables

Class


Description

Indexed array referring to the table objects.

Syntax

public property Tables [AIndex: integer]: TSAPxRFCTableGS;

1.4.7.1.25 Class TSAPxRFCTracingObjectGS Unit


All Members

Methods





Methods





File

gsSAPxRFCStdObj

Syntax

public TSAPxRFCTracingObjectGS = class(TObject);

1.4.7.1.25.1 Methods

1.4.7.1.25.1.1 Method TSAPxRFCTracingObjectGS.Trace (String)

Class

Class TSAPxRFCTracingObjectGS ( see page 369)


361

1

Syntax

public procedure Trace(const AMsg: String); overload;

1.4.7.1.25.1.2 Method TSAPxRFCTracingObjectGS.Trace (String, String)

Class


Syntax

public procedure Trace(const AClassName: String; const AMsg: String); overload;

1.4.7.1.25.1.3 Method TSAPxRFCTracingObjectGS.TraceEnter

Class


Syntax

public procedure TraceEnter(const AMsg: String);

1.4.7.1.25.1.4 Method TSAPxRFCTracingObjectGS.TraceExit

Class


Syntax

public procedure TraceExit(const AMsg: String);

1.4.7.1.26 Class TSAPxRFCTypeElementGS Unit


Legend

Constructor

All Members

Methods

















362

1










Class TSAPxRFCTypeElementGS

ArrangeOffsets ( see page 374)



CreateField ( see page 374)






Properties















ExID ( see page 376)



Methods






363

1






















ArrangeOffsets ( see page 374)



CreateField ( see page 374)






Properties














364

1



ExID ( see page 376)



File

gsSAPxRFCStdObj

Description

TSAPxRFCTypeElementGS encapsulates an RFC structure definition element (field) and is an item of aTSAPxRFCTypeElementsListGS object list.

The RFC structure element is identified by their Name ( see page 314), DataType ( see page 376), DataSize ( see page375) and Offset ( see page 376) properties. Use method CreateField ( see page 374) to add new field to the field list, as itis described by element.

See example of using a TSAPxRFCTypeElementGS object there ( see page 345).

Syntax

public TSAPxRFCTypeElementGS = class(TSAPxRFCListObjectGS);

1.4.7.1.26.1 Methods

1.4.7.1.26.1.1 Method TSAPxRFCTypeElementGS.ArrangeOffsets

Class

Class TSAPxRFCTypeElementGS ( see page 370)

Syntax

public procedure ArrangeOffsets;

1.4.7.1.26.1.2 Method TSAPxRFCTypeElementGS.CheckDefinition

Class


Syntax


1.4.7.1.26.1.3 Constructor TSAPxRFCTypeElementGS.Create

Class


Description

Introduces an abstract constructor.

Syntax


1.4.7.1.26.1.4 Method TSAPxRFCTypeElementGS.CreateField

Class



365

1

Description

Adds a new field to the AFieldsList and assign to it attributes of the type element.

AFieldList - List of fields to which add new field.

Returns a reference to new added field.

Syntax

public function CreateField(AFieldList: TSAPxRFCFieldsListGS): TSAPxRFCFieldGS;

1.4.7.1.26.1.5 Destructor TSAPxRFCTypeElementGS.Destroy

Class


Description

Destroys a TSAPxRFCTypeElementGS object.

Syntax


1.4.7.1.26.1.6 Method TSAPxRFCTypeElementGS.GetName

Class


Description

Gets a type element name.

Syntax

protected function GetName: String; override;

1.4.7.1.26.1.7 Method TSAPxRFCTypeElementGS.GetRfcData

Class


Description

Returns a pointer to the RFC_TYPE_ELEMENT ( see page 29) structure.

Syntax


1.4.7.1.26.1.8 Method TSAPxRFCTypeElementGS.GetRfcDataSize

Class


Description

Returns a size of the RFC_TYPE_ELEMENT ( see page 29) structure.

Syntax


1.4.7.1.26.1.9 Method TSAPxRFCTypeElementGS.SetName

Class



366

1

Description

Sets a new type element name.

Syntax

protected procedure SetName(const AValue: String); override;


1.4.7.1.26.2.1 Property TSAPxRFCTypeElementGS.CharacterSize

Class


Description

Determines an element data size in characters for data types:

• dtCharGS;

• dtNumGS.

Syntax


1.4.7.1.26.2.2 Property TSAPxRFCTypeElementGS.DataSize

Class


Description

Determines an element data size in bytes.

Syntax


1.4.7.1.26.2.3 Property TSAPxRFCTypeElementGS.DataType

Class


Description

Determines an element data type. Properties DataType and TypeHandle ( see page 376) are linked. Setting any of themautomatically updates other and ExID ( see page 376) property values.

Syntax


1.4.7.1.26.2.4 Property TSAPxRFCTypeElementGS.Decimals

Class


Description

Determine a number of digits after decimal point.

Syntax

public property Decimals: LongWord;


367

1

1.4.7.1.26.2.5 Property TSAPxRFCTypeElementGS.ExID

Class


Description

EXID identifier of data element. Properties DataType ( see page 376) and TypeHandle ( see page 376) are linked.Setting any of them automatically updates other and ExID property values.

Syntax

public property ExID: Char;

1.4.7.1.26.2.6 Property TSAPxRFCTypeElementGS.Offset

Class


Description

Determine an element's offset in an element list. If not specified, then SAP RFC defines offset of element in the structurebuffer using it order and data size in the TSAPxRFCTypeElementsListGS ( see page 377).

Syntax

public property Offset: LongWord;

1.4.7.1.26.2.7 Property TSAPxRFCTypeElementGS.TypeHandle

Class


Description

Determines an element data type handle. Properties DataType ( see page 376) and TypeHandle are linked. Setting any ofthem automatically updates other and ExID ( see page 376) property values.

Syntax


1.4.7.1.27 Class TSAPxRFCTypeElementsListGS Unit


Legend

Constructor

All Members

Methods

Add ( see page 318)










368

1












Class TSAPxRFCTypeElementsListGS

AddElement ( see page 379)

FindElement ( see page 379)


InitializeFieldList ( see page 379)

Properties








Methods

Add ( see page 318)





















369

1


AddElement ( see page 379)

FindElement ( see page 379)


InitializeFieldList ( see page 379)

Properties








File

gsSAPxRFCStdObj

Description

TSAPxRFCTypeElementsListGS is a list of TSAPxRFCTypeElementGS objects.

Elements are accessible through Elements ( see page 380) property. Use AddElement ( see page 379) method to add anew element to Elements ( see page 380) array. The order of elements define offset of elements in the structure buffer. So,it is critically important.

See example of using a TSAPxRFCTypeElementsListGS object there ( see page 345).

Syntax

public TSAPxRFCTypeElementsListGS = class(TSAPxRFCObjectsListGS);

1.4.7.1.27.1 Methods

1.4.7.1.27.1.1 Method TSAPxRFCTypeElementsListGS.AddElement

Class

Class TSAPxRFCTypeElementsListGS ( see page 377)

Description

Creates a new TSAPxRFCTypeElementGS ( see page 370) instance and adds it to the Elements ( see page 380) array.

Returns a reference to the new TSAPxRFCTypeElementGS ( see page 370) element.

Syntax

public function AddElement: TSAPxRFCTypeElementGS;

1.4.7.1.27.1.2 Method TSAPxRFCTypeElementsListGS.FindElement

Class


Description

Returns the element with the specified AName. If no element has the specified AName, FindElement returns nil.


370

1

Syntax

public function FindElement(const AName: String): TSAPxRFCTypeElementGS;

1.4.7.1.27.1.3 Method TSAPxRFCTypeElementsListGS.GetObjectClass

Class


Description

Returns a class of a type element object - TSAPxRFCTypeElementGS ( see page 370).

Syntax


1.4.7.1.27.1.4 Method TSAPxRFCTypeElementsListGS.InitializeFieldList

Class


Syntax

public procedure InitializeFieldList(const AFieldList: TSAPxRFCFieldsListGS);


1.4.7.1.27.2.1 Property TSAPxRFCTypeElementsListGS.Elements

Class


Description

Indexed list of elements.

Syntax

public property Elements [AIndex: integer]: TSAPxRFCTypeElementGS;

1.4.7.1.28 Class TSAPxRFCValueAdapterGS Events

OnGetData ( see page 388)

OnGetDataFormat ( see page 388)

OnSetData ( see page 388)

Unit


Legend

Constructor

All Members

Methods

AssignValue ( see page 382)



DoGetData ( see page 382)

DoSetData ( see page 383)


371

1


Properties
























ValueFormat ( see page 388)

Events

OnGetData ( see page 388)

OnGetDataFormat ( see page 388)

OnSetData ( see page 388)

Methods

AssignValue ( see page 382)



DoGetData ( see page 382)

DoSetData ( see page 383)


Properties










372

1
















ValueFormat ( see page 388)

File

gsSAPxRFCStdObj

Description

TSAPxRFCValueAdapterGS is a utility class performing conversion of data from RFC representation to Delphirepresentation and backward. It is used by TSAPxRFCParameterGS ( see page 324) and TSAPxRFCFieldGS ( see page281) as a common for both classes implementation. Value adapter does not have a value storage. In place of that, using itclasses should set OnGetData ( see page 388), OnSetData ( see page 388) and OnGetDataFormat ( see page 388)event handlers.

Syntax

public TSAPxRFCValueAdapterGS = class(TObject);

1.4.7.1.28.1 Methods

1.4.7.1.28.1.1 Method TSAPxRFCValueAdapterGS.AssignValue

Class

Class TSAPxRFCValueAdapterGS ( see page 380)

Description

Assigns RFC data type and value of one value adapter to current value adapter.

AObj - The assigning value adapter.

Syntax

public procedure AssignValue(ADapt: TSAPxRFCValueAdapterGS);

1.4.7.1.28.1.2 Constructor TSAPxRFCValueAdapterGS.Create

Class


Description

Creates a new TSAPxRFCValueAdapterGS object.


373

1

Syntax


1.4.7.1.28.1.3 Destructor TSAPxRFCValueAdapterGS.Destroy

Class


Description

Destroys the TSAPxRFCValueAdapterGS instance.

Syntax


1.4.7.1.28.1.4 Method TSAPxRFCValueAdapterGS.DoGetData

Class


Description

Method is called by Connect for SAP® when value adapter should return a data. Method fires OnGetData ( see page 388)event.

ADataType - returns a stored value data type.

ATypeHandle - returns a stored value data type handle.

ApData - returns a pointer to a stored value buffer.

ALen - returns a length of a stored value.

Syntax

protected procedure DoGetData(var ADataType: TSAPxRFCDataTypeGS; var ATypeHandle: RFC_TYPEHANDLE; var ApData: IntPtr; var ALen: LongWord);

1.4.7.1.28.1.5 Method TSAPxRFCValueAdapterGS.DoSetData

Class


Description

Method is called by Connect for SAP® when value adapter should write a data. Method fires OnSetData ( see page 388)event.

ADataType - specifies a value data type.

ATypeHandle - specifies a value data type handle.

ApData - specifies a pointer to a value buffer.

ALen - specifies a length of a value.

Syntax

protected procedure DoSetData(ADataType: TSAPxRFCDataTypeGS; ATypeHandle: RFC_TYPEHANDLE; ApData: IntPtr; ALen: LongWord);

1.4.7.1.28.1.6 Method TSAPxRFCValueAdapterGS.Erase

Class



374

1

Description

Erases data. After call IsNull ( see page 387) property will return True.

Syntax



1.4.7.1.28.2.1 Property TSAPxRFCValueAdapterGS.AsBCD

Class


Description

Represents the value as Currency. Corresponds to RFCTYPE_BCD ( see page 78) RFC type.

Syntax


1.4.7.1.28.2.2 Property TSAPxRFCValueAdapterGS.AsByte

Class


Description

Represents the value as ShortInt. Corresponds to RFCTYPE_INT1 ( see page 81) RFC type.

Syntax


1.4.7.1.28.2.3 Property TSAPxRFCValueAdapterGS.AsBytes

Class


Description

Represents the value as string of bytes of fixed length. Corresponds to RFCTYPE_BYTE ( see page 79) RFC data type.

Syntax


1.4.7.1.28.2.4 Property TSAPxRFCValueAdapterGS.AsDate

Class


Description

Represents the value as TDateTime. Corresponds to RFCTYPE_DATE ( see page 79) RFC data type.

Syntax


1.4.7.1.28.2.5 Property TSAPxRFCValueAdapterGS.AsDouble

Class


Description

Represents the value as Double. Corresponds to RFCTYPE_FLOAT ( see page 80) RFC data type.


375

1

Syntax


1.4.7.1.28.2.6 Property TSAPxRFCValueAdapterGS.AsInteger

Class


Description

Represents the value as Integer. Corresponds to RFCTYPE_INT ( see page 80) RFC data type.

Syntax


1.4.7.1.28.2.7 Property TSAPxRFCValueAdapterGS.AsNumber

Class


Description

Represents the value as Int64. Corresponds to RFCTYPE_NUM ( see page 82) RFC data type.

Syntax

public property AsNumber: UInt64;

1.4.7.1.28.2.8 Property TSAPxRFCValueAdapterGS.AsString

Class


Description

Represents the value as string of fixed length. Corresponds to RFCTYPE_CHAR ( see page 79) RFC data type.

Syntax


1.4.7.1.28.2.9 Property TSAPxRFCValueAdapterGS.AsStruct

Class


Description

Represents the value as structured byte string of fixed length. Corresponds to RFCTYPE_STRUCTURE ( see page 83)RFC data type.

Syntax


1.4.7.1.28.2.10 Property TSAPxRFCValueAdapterGS.AsTime

Class


Description

Represents the value as TDateTime. Corresponds to RFCTYPE_TIME ( see page 83) RFC data type.

Syntax



376

1

1.4.7.1.28.2.11 Property TSAPxRFCValueAdapterGS.AsVarBytes

Class


Description

Represents the value as byte string of variable length. Corresponds to RFCTYPE_XSTRING ( see page 85) RFC data type.

Syntax


1.4.7.1.28.2.12 Property TSAPxRFCValueAdapterGS.AsVariant

Class


Description

Represents the value as Variant.

Syntax


1.4.7.1.28.2.13 Property TSAPxRFCValueAdapterGS.AsVarString

Class


Description

Represents the value as variable length string. Corresponds to RFCTYPE_STRING ( see page 83) RFC data type.

Syntax


1.4.7.1.28.2.14 Property TSAPxRFCValueAdapterGS.AsWord

Class


Description

Represents the value as SmallInt. Corresponds to RFCTYPE_INT2 ( see page 81) RFC data type.

Syntax


1.4.7.1.28.2.15 Property TSAPxRFCValueAdapterGS.AsXMLString

Class


Description

Represents the value as XML formatted string. Corresponds to RFCTYPE_XMLDATA ( see page 85) RFC data type.

Syntax


1.4.7.1.28.2.16 Property TSAPxRFCValueAdapterGS.CharacterSize

Class



377

1

Description

Specifies a value data size in characters. Property allows to change size of value buffer.

Syntax


1.4.7.1.28.2.17 Property TSAPxRFCValueAdapterGS.DataFormat

Class


Description

Returns a reference to a data format object.

Syntax

protected property DataFormat: TSAPxRFCDataFormatGS;

1.4.7.1.28.2.18 Property TSAPxRFCValueAdapterGS.DataSize

Class


Description

Specifies a value data size in bytes. Property allows to change size of value buffer.

Syntax


1.4.7.1.28.2.19 Property TSAPxRFCValueAdapterGS.DataType

Class


Description

Specifies an Connect for SAP® data type.

Syntax


1.4.7.1.28.2.20 Property TSAPxRFCValueAdapterGS.Decimals

Class


Description

Specifies a number of digits after decimal point.

Syntax


1.4.7.1.28.2.21 Property TSAPxRFCValueAdapterGS.IsNull

Class


Description

Indicates whether a value has been assigned. To erase value call Erase ( see page 383) method.

Syntax



378

1

1.4.7.1.28.2.22 Property TSAPxRFCValueAdapterGS.ReadOnly

Class


Description

Specifies whether a data can be modified.

Syntax


1.4.7.1.28.2.23 Property TSAPxRFCValueAdapterGS.TypeHandle

Class


Description

Specifies an RFC data type handle. Preferred way to set field data type is DataType ( see page 387) property.

Syntax


1.4.7.1.28.2.24 Property TSAPxRFCValueAdapterGS.ValueFormat

Class


Syntax

public property ValueFormat: TSAPxRFCValueFormatGS;

1.4.7.1.28.3 Events

1.4.7.1.28.3.1 Event TSAPxRFCValueAdapterGS.OnGetData

Class


Description

Event is fired when value adapter should return a data.

Syntax

public property OnGetData: TSAPxRFCValueAdapterGetEventGS;

1.4.7.1.28.3.2 Event TSAPxRFCValueAdapterGS.OnGetDataFormat

Class


Description

Event is fired when value adapter should return a data format object.

Syntax

public property OnGetDataFormat: TSAPxRFCValueAdapterGetDataFormatEventGS;

1.4.7.1.28.3.3 Event TSAPxRFCValueAdapterGS.OnSetData

Class



379

1

Description

Event is fired when value adapter should set a data.

Syntax

public property OnSetData: TSAPxRFCValueAdapterSetEventGS;

1.4.7.2 Interfaces

1.4.7.2.1 Interface ISAPxRFCErrorHandlerGS Unit


All Members

Methods


Methods


File

gsSAPxRFCStdObj

Syntax

public ISAPxRFCErrorHandlerGS = interface(ISAPxInterfaceBaseGS);

1.4.7.2.1.1 Methods

1.4.7.2.1.1.1 Method ISAPxRFCErrorHandlerGS.OnError

Interface

Interface ISAPxRFCErrorHandlerGS ( see page 388)

Syntax

function OnError(const AException: Exception; ASender: TObject): Boolean;

1.4.7.3 Functions

1.4.7.3.1 Function SAPxRFCDataType2Str Unit


File

gsSAPxRFCStdObj

Description

Returns name of specified by ADataType Connect for SAP® data type.

Syntax

function SAPxRFCDataType2Str(ADataType: TSAPxRFCDataTypeGS): String;


380

1

1.4.7.3.2 Function SAPxRFCFinalize Unit


File

gsSAPxRFCStdObj

Description

Finalizes Connect for SAP® environment. Decrements initialization counter and when it is zero, destroyFSAPxRFCEnvironment ( see page 403) object and unloads client library, calling SAPxRFCUnLoadLib ( see page 21).

Connect for SAP® components automatically calls this method, when they requires environment to be finalized. But if youare using low level Connect for SAP® calls, then environment finalization you should perform yourself.

Syntax

procedure SAPxRFCFinalize;

1.4.7.3.3 Function SAPxRFCGetSAPRFCINIFileName Unit


File

gsSAPxRFCStdObj

Syntax

function SAPxRFCGetSAPRFCINIFileName: String;

1.4.7.3.4 Function SAPxRFCGetTracing Unit


File

gsSAPxRFCStdObj

Description

Procedure retrieve current Connect for SAP® tracing mode. AValue is True, if tracing is turned on, otherwise - False.ATraceFileName returns tracing file name. To change tracing mode use SAPxRFCSetTracing ( see page 392) procedure.

Syntax

procedure SAPxRFCGetTracing(var AValue: Boolean; var ATraceFileName: String);

1.4.7.3.5 Function SAPxRFCInitialize Unit


File

gsSAPxRFCStdObj

Description

Initialize Connect for SAP® environment. Increment initialization counter and when it is 1, create FSAPxRFCEnvironment (see page 403) object and load client library, calling SAPxRFCLoadLib ( see page 21).

Connect for SAP® components automatically calls this method, when they requires environment to be initialized. But if you


381

1

are using low level Connect for SAP® calls, then environment initialization you should perform yourself.

Syntax

procedure SAPxRFCInitialize;

1.4.7.3.6 Function SAPxRFCIsStructType Unit


File

gsSAPxRFCStdObj

Description

Function return True, if specified by AStr data type EXID is a structured data type. Otherwise - False. AConnection isrequired to get decision using SAP version, although it may be omitted (nil).

Syntax

function SAPxRFCIsStructType(const AStr: String; AConnection: TSAPxRFCCustomConnectionGS = nil): Boolean;

1.4.7.3.7 Function SAPxRFCParameterType2Str Unit


File

gsSAPxRFCStdObj

Syntax

function SAPxRFCParameterType2Str(AParamType: TSAPxRFCParameterTypeGS): String;

1.4.7.3.8 Function SAPxRFCRaiseCustomException Unit


File

gsSAPxRFCStdObj

Syntax

procedure SAPxRFCRaiseCustomException(const AID: String);

1.4.7.3.9 Function SAPxRFCRaiseException Unit


File

gsSAPxRFCStdObj

Syntax

procedure SAPxRFCRaiseException(const AMsg: String);


382

1

1.4.7.3.10 Function SAPxRFCRaiseNativeException Unit


File

gsSAPxRFCStdObj

Syntax

procedure SAPxRFCRaiseNativeException(const AMsg: String; ARFCCode: RFC_RC);

1.4.7.3.11 Function SAPxRFCSetTracing Unit


File

gsSAPxRFCStdObj

Syntax

procedure SAPxRFCSetTracing(AValue: Boolean); overload;

1.4.7.3.12 Function SAPxRFCSetTracing Unit


File

gsSAPxRFCStdObj

Description

Procedure set Connect for SAP® tracing mode. If AValue is True, then tracing will be turned on, otherwise - off.ATraceFileName specifies tracing file name. To get current tracing mode use SAPxRFGetTracing ( see page 390)procedure.

Syntax

procedure SAPxRFCSetTracing(AValue: Boolean; const ATraceFileName: String); overload;


1.4.7.4.1 Enumeration TSAPxRFCBytesPerCharGS Unit


File

gsSAPxRFCStdObj

Description

Determines server side representation of character (dtCharGS) data type.

Syntax

public TSAPxRFCBytesPerCharGS = ( bcAutoDetect, bcOne,


383

1

bcTwo, bcFour);

1.4.7.4.2 Enumeration TSAPxRFCDataFormatValueGS All Members


fvMapBCD Specified the BCD RFC data format.

fvIntType Data format has IntType property value assigned or not.

fvFloatType Data format has FloatType property value assigned or not.

Unit


File

gsSAPxRFCStdObj

Description

TSAPxRFCDataFormatValueGS values determine the RFC data formats which can be mapped on different Delphi dataformats.

Syntax

public TSAPxRFCDataFormatValueGS = ( fvMapBCD, fvIntType, fvFloatType, fvBytesPerChar, fvReadTable);

1.4.7.4.3 Enumeration TSAPxRFCDataTypeGS All Members


dtNullGS Specifies not supported data type (is clone of RFCTYPE_NULL ( see page 82)).

dtCharGS Specifies 1-byte or multi byte character, fixed sized, blank padded (is clone of RFCTYPE_CHAR ( see page 79)).

dtDateGS Specifies RFC data type DATE with format YYYYMMDD (is clone of RFCTYPE_DATE ( see page 79)).

dtBCDGS Specifies BCD number, any length between 1 and 16 bytes (is clone of RFCTYPE_BCD ( see page 78)).

dtTimeGS Specifies RFC data type DATE with format HHMMSS (is clone of RFCTYPE_TIME ( see page 83)).

dtByteGS Specifies raw data, binary, fixed length, zero padded (is clone of RFCTYPE_BYTE ( see page 79)).

dtNumGS Specifies RFC data type as a set of digits with fixed size, '0' padded (is clone of RFCTYPE_NUM ( see page 82)).

dtFloatGS Specifies floating point with double precision (is clone of RFCTYPE_FLOAT ( see page 80)).

dtIntGS Specifies 4-byte integer (is clone of RFCTYPE_INT ( see page 80)).

dtInt2GS Specifies 2-byte integer, obsolete and not directly supported by ABAP/4 (is clone of RFCTYPE_INT2 ( see page 81)).

dtInt1GS Specifies 2-byte integer, obsolete and not directly supported by ABAP/4 (is clone of RFCTYPE_INT1 ( see page 81)).

dtStructureGS Specifies a structure (is clone of RFCTYPE_STRUCTURE ( see page 83)).

dtStringGS Specifies zero terminated string (is clone of RFCTYPE_STRING ( see page 83)).


384

1

dtXStringGS Specifies raw string with length field in bytes (is clone of RFCTYPE_XSTRING ( see page 85)).

dtXMLDataGS Specifies zero terminated string describing ABAP data types/structure as XML (is clone of RFCTYPE_XMLDATA ( see page 85)).

Unit


File

gsSAPxRFCStdObj

Description

TSAPxRFCDataTypeGS values specify Connect for SAP® data type, which corresponds to SAP RFC data type handle -RFC_TYPEHANDLE ( see page 44).

Syntax

public TSAPxRFCDataTypeGS = ( dtNullGS, dtCharGS, dtDateGS, dtBCDGS, dtTimeGS, dtByteGS, dtNumGS, dtFloatGS, dtIntGS, dtInt2GS, dtInt1GS, dtStructureGS, dtStringGS, dtXStringGS, dtXMLDataGS, dtLineTypeGS);

1.4.7.4.4 Enumeration TSAPxRFCErrorActionGS All Members


eaDefault An error is handled by default - exception is raised in most cases.

eaReRaise An exception is raised.

eaSilence An error is concealed and execution is continued.

Unit


File

gsSAPxRFCStdObj

Description

TSAPxRFCErrorActionGS values specify a way of handling an error.

Syntax

public TSAPxRFCErrorActionGS = ( eaDefault, eaReRaise, eaSilence);


385

1

1.4.7.4.5 Enumeration TSAPxRFCFloatTypeGS All Members


ftAutoDetect Connect for SAP® will automatically detect server representation of float data type.

ftIEEE Forces Connect for SAP® to expect float data in IEEE format.

ftIBM370 Forces Connect for SAP® to expect float data in IBM/370 format.

Unit


File

gsSAPxRFCStdObj

Description

Determines server side representation of float (dtFloatGS) data type.

Syntax

public TSAPxRFCFloatTypeGS = ( ftAutoDetect, ftIEEE, ftIBM370);

1.4.7.4.6 Enumeration TSAPxRFCFunctionCallTypeGS All Members


ftTransactionalGS Function is called as transactional.

ftNonTransactionalGS Function is called as non-transactional.

Unit


File

gsSAPxRFCStdObj

Description

TSAPxRFCFunctionCallTypeGS values determine how a function is called.

Syntax

public TSAPxRFCFunctionCallTypeGS = ( ftTransactionalGS, ftNonTransactionalGS);

1.4.7.4.7 Enumeration TSAPxRFCIntTypeGS All Members


itAutoDetect Connect for SAP® will automatically detect server representation of integer data types.

itLittleEndian Forces Connect for SAP® to expect integer data in "Little" data format.

itBigEndian Forces Connect for SAP® to expect integer data in "Big Indian" data format.


386

1

Unit


File

gsSAPxRFCStdObj

Description

Data type determines server side representation of integer (dtIntGS, dtInt1GS, dtInt2GS) data types.

Syntax

public TSAPxRFCIntTypeGS = ( itAutoDetect, itLittleEndian, itBigEndian);

1.4.7.4.8 Enumeration TSAPxRFCMapBCDToTypeGS All Members


bmDefault BCD is mapped on the most suited Delphi data type.

bmInteger BCD is mapped on Integer Delphi data type.

bmInt64 BCD is mapped on Int64 Delphi data type.

bmCurrency BCD is mapped on Currency Delphi data type.

bmDouble BCD is mapped on Double Delphi data type.

bmString BCD is mapped on String Delphi data type.

Unit


File

gsSAPxRFCStdObj

Description

TSAPxRFCMapBCDToTypeGS values specify how BCD RFC data format is mapped on Delphi data formats.

Syntax

public TSAPxRFCMapBCDToTypeGS = ( bmDefault, bmInteger, bmInt64, bmCurrency, bmDouble, bmString);

1.4.7.4.9 Enumeration TSAPxRFCParameterTypeGS Unit


File

gsSAPxRFCStdObj

Description

Determines direction of parameter data transfer.


387

1

Syntax

public TSAPxRFCParameterTypeGS = ( ptExportGS, ptImportGS, ptImportExportGS);

1.4.7.4.10 Enumeration TSAPxRFCReadTableFormatGS Unit


File

gsSAPxRFCStdObj

Syntax

public TSAPxRFCReadTableFormatGS = ( rtAutoDetect, rtBinary, rtText);

1.4.7.4.11 Enumeration TSAPxRFCRemoteObjectDefinitionStateGS All Members


dsUncheckedGS Meta data is unchecked.

dsCheckedDynamicGS Meta data is dynamically got from a SAP system.

dsCheckedStaticGS Meta data is statically defined by programmer. This value is automatically set up if programmer has added just a one parameter (input or output) or a one table.

dsFixedStaticGS Meta data is statically defined by programmer. Unlike dsCheckedStaticGS value dsFixedStaticGS is set up by a TSAPxRFCRemoteObjectGS ( see page 340) descendant via ObjectDefined ( see page 344) call.

Unit


File

gsSAPxRFCStdObj

Description

TSAPxRFCRemoteObjectDefinitionStateGS values indicate a state of TSAPxRFCRemoteObjectGS ( see page 340)descendants' meta data.

Syntax

public TSAPxRFCRemoteObjectDefinitionStateGS = ( dsUncheckedGS, dsCheckedDynamicGS, dsCheckedStaticGS, dsFixedStaticGS);

1.4.7.4.12 Enumeration TSAPxRFCTableStateGS All Members


rsInactiveGS Table is closed, so its data is unavailable.

rsBrowseGS Data can be viewed, but not changed. This is the default state of an open table.


388

1

rsEditGS Active record can be modified.

rsInsertGS The active record is a newly inserted buffer that has not been posted. This record can be modified and then either posted or discarded.

Unit


File

gsSAPxRFCStdObj

Description

TSAPxRFCTableStateGS indicates the current operating mode of a TSAPxRFCTableGS ( see page 351) table.

Syntax

public TSAPxRFCTableStateGS = ( rsInactiveGS, rsBrowseGS, rsEditGS, rsInsertGS);

1.4.7.4.13 Enumeration TSAPxRFCTreeStateGS Unit


File

gsSAPxRFCStdObj

Syntax

public TSAPxRFCTreeStateGS = ( tsUndefinedGS, tsFalseGS, tsTrueGS);

1.4.7.4.14 Enumeration TSAPxRFCValueFormatGS Unit


File

gsSAPxRFCStdObj

Syntax

public TSAPxRFCValueFormatGS = ( vtDeepGS, vtFlatGS, vtTextGS);

1.4.7.5 Types

1.4.7.5.1 Type ISAPxInterfaceBaseGS Unit



389

1

File

gsSAPxRFCStdObj

Syntax

ISAPxInterfaceBaseGS = IInterface IUnknown ;

1.4.7.5.2 Type TSAPxRFCConnectedObjectClassGS Unit


File

gsSAPxRFCStdObj

Description

Meta class of TSAPxRFCConnectedObjectGS.

Syntax

TSAPxRFCConnectedObjectClassGS = class of TSAPxRFCConnectedObjectGS;

1.4.7.5.3 Type TSAPxRFCCustomConnectionClassGS Unit


File

gsSAPxRFCStdObj

Syntax

TSAPxRFCCustomConnectionClassGS = class of TSAPxRFCCustomConnectionGS;

1.4.7.5.4 Type TSAPxRFCDataFormatValuesGS Unit


File

gsSAPxRFCStdObj

Description

Set of TSAPxRFCDataFormatValueGS ( see page 392).

Syntax

TSAPxRFCDataFormatValuesGS = set of TSAPxRFCDataFormatValueGS;

1.4.7.5.5 Type TSAPxRFCErrorEventGS Unit


File

gsSAPxRFCStdObj

Description

Event occurs when an error happened.


390

1

E - An Exception object.

AErrAction - Returns value determining how to proceed with an exception.

Syntax

TSAPxRFCErrorEventGS = procedure (ASender: TObject; E: Exception; var AErrAction: TSAPxRFCErrorActionGS) of object;

1.4.7.5.6 Type TSAPxRFCFieldClassGS Unit


File

gsSAPxRFCStdObj

Description

Meta class of TSAPxRFCFieldGS.

Syntax

TSAPxRFCFieldClassGS = class of TSAPxRFCFieldGS;

1.4.7.5.7 Type TSAPxRFCListObjectClassGS Unit


File

gsSAPxRFCStdObj

Description

Meta class of TSAPxRFCListObjectGS.

Syntax

TSAPxRFCListObjectClassGS = class of TSAPxRFCListObjectGS;

1.4.7.5.8 Type TSAPxRFCLoginCallBackGS Unit


File

gsSAPxRFCStdObj

Description

Event occurs when client connection is establishing and the LoginPrompt property is True. Event allows to submit toConnect for SAP® user credentials.

AMandat - Specifies a client number.

AUser - Specifies a user name.

APwd - Specifies a password.

ALang - Specifies a language.

Syntax

TSAPxRFCLoginCallBackGS = function (var AMandant, AUser, APwd, ALang: String): Boolean;


391

1

1.4.7.5.9 Type TSAPxRFCParameterClassGS Unit


File

gsSAPxRFCStdObj

Description

Meta class of TSAPxRFCParameterGS.

Syntax

TSAPxRFCParameterClassGS = class of TSAPxRFCParameterGS;

1.4.7.5.10 Type TSAPxRFCRemoteObjectClassGS Unit


File

gsSAPxRFCStdObj

Description

Meta class of TSAPxRFCRemoteObjectGS.

Syntax

TSAPxRFCRemoteObjectClassGS = class of TSAPxRFCRemoteObjectGS;

1.4.7.5.11 Type TSAPxRFCTableClassGS Unit


File

gsSAPxRFCStdObj

Description

Meta class of TSAPxRFCTableGS.

Syntax

TSAPxRFCTableClassGS = class of TSAPxRFCTableGS;

1.4.7.5.12 Type TSAPxRFCValueAdapterGetDataFormatEventGS Unit


File

gsSAPxRFCStdObj

Description

Event occurs when a TSAPxRFCValueAdapterGS object attempts to get a data format.

ADataFormat - Specifies a data format object.


392

1

Syntax

TSAPxRFCValueAdapterGetDataFormatEventGS = procedure (var ADataFormat: TSAPxRFCDataFormatGS) of object;

1.4.7.5.13 Type TSAPxRFCValueAdapterGetEventGS Unit


File

gsSAPxRFCStdObj

Description

Event occurs when a TSAPxRFCValueAdapterGS object attempts to get a data.

ATypeHandle - returns a type handle of stored value.

ApData - returns a pointer to stored value buffer.

ALen - returns a length of stored value.

Syntax

TSAPxRFCValueAdapterGetEventGS = procedure (var ATypeHandle: RFC_TYPEHANDLE; var ApData: IntPtr; var ALen: LongWord) of object;

1.4.7.5.14 Type TSAPxRFCValueAdapterSetEventGS Unit


File

gsSAPxRFCStdObj

Description

Event occurs when a TSAPxRFCValueAdapterGS object attempts to set a data.

ATypeHandle - specifies a type handle of new value.

ApData - specifies a pointer to a new value buffer.

ALen - specifies a length of new value.

Syntax

TSAPxRFCValueAdapterSetEventGS = procedure (ATypeHandle: RFC_TYPEHANDLE; ApData: IntPtr; ALen: LongWord) of object;

1.4.7.5.15 Type TSAPxRFCWaitEventGS Unit


File

gsSAPxRFCStdObj

Description

Event occurs when software requires to show some action feedback to end user.


393

1

Syntax

TSAPxRFCWaitEventGS = procedure of object;

1.4.7.6 Variables

1.4.7.6.1 Variable FSAPxRFCEnvironment Unit


File

gsSAPxRFCStdObj

Syntax

FSAPxRFCEnvironment: TSAPxRFCEnvironmentGS = nil;

1.4.7.6.2 Variable FSAPxRFCLoginCallBack Unit


File

gsSAPxRFCStdObj

Description

References to procedure which responds to logging in a SAP system.

Syntax

FSAPxRFCLoginCallBack: TSAPxRFCLoginCallBackGS = nil;

1.4.7.7 Constants

1.4.7.7.1 Constant CSAPxRFCMaxNonFlatSize Unit


File

gsSAPxRFCStdObj

Syntax

CSAPxRFCMaxNonFlatSize = 1024;

1.4.7.7.2 Constant SSAPxRFCCfgKeyName Unit


File

gsSAPxRFCStdObj

Description

Specifies a path to registry key containing Connect for SAP® parameters.


394

1

Syntax

SSAPxRFCCfgKeyName = 'Software\gs-soft\SAPxRFC';

1.4.7.7.3 Constant SSAPxRFCCfgValName Unit


File

gsSAPxRFCStdObj

Description

Specifies a registry value name containing a configuration file name. See also SSAPxRFCCfgKeyName ( see page 403)and SSAPxRFCDefCfgFileName ( see page 404).

Syntax

SSAPxRFCCfgValName = 'CfgFile';

1.4.7.7.4 Constant SSAPxRFCDefCfgFileName Unit


File

gsSAPxRFCStdObj

Syntax

SSAPxRFCDefCfgFileName = 'SAPxRFCAliases.ini';

1.4.7.7.5 Constant SSAPxRFCDefCfgKeyName Unit


File

gsSAPxRFCStdObj

Description

Specifies a registry SSAPxRFCCfgKeyName ( see page 403) subkey name containing an alias information, when aliasesare stored in registry using TSAPxRFCRegistryAliasListGS ( see page 116).

Syntax

SSAPxRFCDefCfgKeyName = 'Aliases';

1.4.7.7.6 Constant SSAPxRFCDefRootKey Unit


File

gsSAPxRFCStdObj

Syntax

SSAPxRFCDefRootKey = HKEY_CURRENT_USER;


395

1

1.4.7.7.7 Constant SSAPxRFCDefRootKeyOld Unit


File

gsSAPxRFCStdObj

Syntax

SSAPxRFCDefRootKeyOld = HKEY_LOCAL_MACHINE;

1.4.8 Unit gsSAPxRFCUtil

Classes

TSAPxMulticastEventBaseGS ( see page 407)

TSAPxMulticastNotifyEventGS ( see page 408)

TSAPxRFCFuncWrapperGS ( see page 409)

TSAPxRFCStringBuilderGS ( see page 410)

Constants

C_SAPxVersion ( see page 421)

PathDelim ( see page 421)

PathSep ( see page 421)

sLineBreak ( see page 421)

Functions

Pos ( see page 412)

SAPxRFCAnsiToUtf8 ( see page 413)

SAPxRFCCharInSet ( see page 413)

SAPxRFCCurrToStr ( see page 413)

SAPxRFCFloatToStr ( see page 413)

SAPxRFCGetModuleName ( see page 413)

SAPxRFCGetVersionInfo ( see page 414)

SAPxRFCIsNumEmpty ( see page 414)

SAPxRFCIsTextNum ( see page 414)

SAPxRFCMemFill ( see page 414)

SAPxRFCMemMove ( see page 414)

SAPxRFCPadLeft ( see page 415)

SAPxRFCReverseBytes ( see page 415)

SAPxRFCStrToAPIStr ( see page 416)

SAPxRFCStrToCh ( see page 416)

SAPxRFCToolVer ( see page 416)

1.4 Units Connect for SAP ® Unit gsSAPxRFCUtil

396

1

SAPxRFCTrimAll ( see page 416)

SAPxRFCUtf8Decode ( see page 417)

SAPxRFCUtf8Encode ( see page 417)

SAPxRFCUtf8ToAnsi ( see page 417)

SAPxRFCWideStrLen ( see page 417)

SAPxRFCWStrCopy ( see page 418)

Group


Types

IntPtr ( see page 418)

PBoolean ( see page 418)

PRawByteString ( see page 418)

PUInt64 ( see page 419)

RawByteString ( see page 419)

TBytes ( see page 419)

TSAPxNativeInt ( see page 419)

TSAPxNativeUInt ( see page 419)

TSysCharSet ( see page 420)

UInt64 ( see page 420)

UnicodeString ( see page 420)

UTF8String ( see page 420)

Description

Unit gsSAPxRFCUtil contains generic utility types, procedures, functions and classes. All of them are not dependent on SAPRFC.

1.4.8.1 Classes

1.4.8.1.1 Class TSAPxMulticastEventBaseGS Unit

Unit gsSAPxRFCUtil ( see page 405)

All Members

Methods

Add ( see page 407)




Properties



Methods

Add ( see page 407)




397

1


Properties



File

gsSAPxRFCUtil

Syntax

public TSAPxMulticastEventBaseGS = class(TObject);

1.4.8.1.1.1 Methods

1.4.8.1.1.1.1 Method TSAPxMulticastEventBaseGS.Add

Class

Class TSAPxMulticastEventBaseGS ( see page 407)

Syntax

protected procedure Add(AHandler: TMethod);

1.4.8.1.1.1.2 Method TSAPxMulticastEventBaseGS.IndexOf

Class


Syntax

protected function IndexOf(AHandler: TMethod): Integer;

1.4.8.1.1.1.3 Method TSAPxMulticastEventBaseGS.IsEmpty

Class


Syntax

public function IsEmpty: Boolean;

1.4.8.1.1.1.4 Method TSAPxMulticastEventBaseGS.Remove

Class


Syntax

protected procedure Remove(AHandler: TMethod);


1.4.8.1.1.2.1 Property TSAPxMulticastEventBaseGS.Count

Class


Syntax

protected property Count: Integer;


398

1

1.4.8.1.1.2.2 Property TSAPxMulticastEventBaseGS.Methods

Class


Syntax

protected property Methods [AIndex: Integer]: TMethod;

1.4.8.1.2 Class TSAPxMulticastNotifyEventGS Unit


All Members

Methods

Add ( see page 407)




Class TSAPxMulticastNotifyEventGS

Add ( see page 409)



Properties



Methods

Add ( see page 407)




Class TSAPxMulticastNotifyEventGS

Add ( see page 409)



Properties



File

gsSAPxRFCUtil

Syntax

public TSAPxMulticastNotifyEventGS = class(TSAPxMulticastEventBaseGS);

1.4.8.1.2.1 Methods


399

1

1.4.8.1.2.1.1 Method TSAPxMulticastNotifyEventGS.Add

Class

Class TSAPxMulticastNotifyEventGS ( see page 408)

Syntax

public procedure Add(AHandler: TNotifyEvent);

1.4.8.1.2.1.2 Method TSAPxMulticastNotifyEventGS.Call

Class


Syntax

public procedure Call(ASender: TObject);

1.4.8.1.2.1.3 Method TSAPxMulticastNotifyEventGS.Remove

Class


Syntax

public procedure Remove(AHandler: TNotifyEvent);

1.4.8.1.3 Class TSAPxRFCFuncWrapperGS Unit


File

gsSAPxRFCUtil

Description

The class implement thunks between Delphi object method calling convention and SAP RFC call back function callingconvention. It is rather internal class.

Syntax

public TSAPxRFCFuncWrapperGS = class(TObject);

1.4.8.1.4 Class TSAPxRFCStringBuilderGS Unit


Legend

Constructor

All Members

Methods








400

1

Realloc ( see page 411)

SetSize ( see page 411)

ToBuffer ( see page 412)

ToString ( see page 412)

Write ( see page 412)

Properties

Capacity ( see page 412)

Length ( see page 412)

Methods







Realloc ( see page 411)

SetSize ( see page 411)

ToBuffer ( see page 412)

ToString ( see page 412)


Properties

Capacity ( see page 412)

Length ( see page 412)

File

gsSAPxRFCUtil

Syntax

public TSAPxRFCStringBuilderGS = class(TCustomMemoryStream);

1.4.8.1.4.1 Methods

1.4.8.1.4.1.1 Method TSAPxRFCStringBuilderGS.Append (Char, Integer)

Class

Class TSAPxRFCStringBuilderGS ( see page 410)

Syntax

public function Append(const AChar: Char; const ACount: Integer = 1): TSAPxRFCStringBuilderGS; overload;

1.4.8.1.4.1.2 Method TSAPxRFCStringBuilderGS.Append (String)

Class


Syntax

public function Append(const AStr: String): TSAPxRFCStringBuilderGS; overload;

1.4.8.1.4.1.3 Method TSAPxRFCStringBuilderGS.Clear

Class



401

1

Syntax


1.4.8.1.4.1.4 Constructor TSAPxRFCStringBuilderGS.Create (Integer)

Class


Syntax

public constructor Create(ACapacity: Integer = 0); overload;

1.4.8.1.4.1.5 Constructor TSAPxRFCStringBuilderGS.Create (String)

Class


Syntax

public constructor Create(const AStr: String); overload;

1.4.8.1.4.1.6 Destructor TSAPxRFCStringBuilderGS.Destroy

Class


Syntax


1.4.8.1.4.1.7 Method TSAPxRFCStringBuilderGS.Realloc

Class


Syntax

protected function Realloc(var ANewCapacity: Integer): Pointer; virtual;

1.4.8.1.4.1.8 Method TSAPxRFCStringBuilderGS.SetSize

Class


Syntax

public procedure SetSize(ANewSize: Longint); override;

1.4.8.1.4.1.9 Method TSAPxRFCStringBuilderGS.ToBuffer

Class


Syntax

public function ToBuffer: PChar;

1.4.8.1.4.1.10 Method TSAPxRFCStringBuilderGS.ToString

Class


Syntax

public function ToString: String;


402

1

1.4.8.1.4.1.11 Method TSAPxRFCStringBuilderGS.Write

Class


Syntax

public function Write(const ABuffer; ACount: Longint): Longint; override;


1.4.8.1.4.2.1 Property TSAPxRFCStringBuilderGS.Capacity

Class


Syntax

public property Capacity: Longint;

1.4.8.1.4.2.2 Property TSAPxRFCStringBuilderGS.Length

Class


Syntax

public property Length: Longint;

1.4.8.2 Functions

1.4.8.2.1 Function Pos Unit


File

gsSAPxRFCUtil

Syntax

function Pos(const SubStr: String; const Str: String; Offset: Integer = 0): Integer; overload;

1.4.8.2.2 Function SAPxRFCAnsiToUtf8 Unit


File

gsSAPxRFCUtil

Syntax

function SAPxRFCAnsiToUtf8(const S: string): UTF8String;

1.4.8.2.3 Function SAPxRFCCharInSet Unit



403

1

File

gsSAPxRFCUtil

Syntax

function SAPxRFCCharInSet(AChar: Char; ASet: TSysCharSet): Boolean;

1.4.8.2.4 Function SAPxRFCCurrToStr Unit


File

gsSAPxRFCUtil

Syntax

function SAPxRFCCurrToStr(const AVal: Currency): String;

1.4.8.2.5 Function SAPxRFCFloatToStr Unit


File

gsSAPxRFCUtil

Syntax

function SAPxRFCFloatToStr(const AVal: Double): String;

1.4.8.2.6 Function SAPxRFCGetModuleName Unit


File

gsSAPxRFCUtil

Syntax

function SAPxRFCGetModuleName(Module: HMODULE): string;

1.4.8.2.7 Function SAPxRFCGetVersionInfo Unit


File

gsSAPxRFCUtil

Syntax

function SAPxRFCGetVersionInfo(const AFileName: string; var AProduct: string; var AVersion: string; var AVersionName: string; var ACopyright: string; var AInfo: string): Boolean;

1.4.8.2.8 Function SAPxRFCIsNumEmpty Unit



404

1

File

gsSAPxRFCUtil

Syntax

function SAPxRFCIsNumEmpty(const AStr: String): Boolean;

1.4.8.2.9 Function SAPxRFCIsTextNum Unit


File

gsSAPxRFCUtil

Description

Function returns True, if AStr contains valid textual representation of number. And, if it is required, may adjust SAP R/3represention to make it Delphi compatible.

AStr - number in textual form

Syntax

function SAPxRFCIsTextNum(var AStr: String): Boolean;

1.4.8.2.10 Function SAPxRFCMemFill Unit


File

gsSAPxRFCUtil

Syntax

procedure SAPxRFCMemFill(ADest: IntPtr; ASize: Integer; AByte: Byte);

1.4.8.2.11 Function SAPxRFCMemMove Unit


File

gsSAPxRFCUtil

Description

Procedure moves region of memory from ASrc source location to ADest destination location. The ASize parameter specifiesregion size in bytes.

ASrc - address of source location

ADest - address of destination location

ASize - size of region in bytes

Syntax

procedure SAPxRFCMemMove(ASrc: IntPtr; ADest: IntPtr; ASize: Integer);


405

1

1.4.8.2.12 Function SAPxRFCPadLeft Unit


File

gsSAPxRFCUtil

Description

Function pads AStr string from left side up to ALen total length using ACh character and returns resulting string.

AStr - string to pad from left

ALen - total length of string

ACh - padding character

Syntax

function SAPxRFCPadLeft(const AStr: String; ALen: Integer; AChar: Char): string;

1.4.8.2.13 Function SAPxRFCReverseBytes Unit


File

gsSAPxRFCUtil

Description

The procedure reverses sequence of bytes pointed by APtr. A sequence is ASize bytes long. The procedure uses temporarybuffer, pointed by ABuffer pointer. The buffer must be of the same length as sequence of byte.

APtr - address of sequence of bytes to reverse

ABuffer - address of temporary buffer

ASize - length of sequence

Syntax

procedure SAPxRFCReverseBytes(var APtr: IntPtr; ABuffer: IntPtr; ASize: Integer);

1.4.8.2.14 Function SAPxRFCStrToAPIStr Unit


File

gsSAPxRFCUtil

Description

The function is used by Connect for SAP to cast Delpgi string to Win32 API string representation. It is PChar in Win32 modeand System.String in .Net mode. The function primary goal is make code compatible with Win32 and .Net modes.

AValue - a string to cast


406

1

Syntax

function SAPxRFCStrToAPIStr(const AValue: string): PChar;

1.4.8.2.15 Function SAPxRFCStrToCh Unit


File

gsSAPxRFCUtil

Description

The function extracts first character from the string. If string is empty, then function returns one space.

AStr - the string to extract character

Syntax

function SAPxRFCStrToCh(const AStr: String): Char;

1.4.8.2.16 Function SAPxRFCToolVer Unit


File

gsSAPxRFCUtil

Syntax

function SAPxRFCToolVer: String;

1.4.8.2.17 Function SAPxRFCTrimAll Unit


File

gsSAPxRFCUtil

Description

The function trims all leading and trailing ACh characters from AStr string. And returns True, if the AStr is not empty aftertriming.

AStr - a string to trim

ACh - a character to trim

Syntax

function SAPxRFCTrimAll(var AStr: String; ACh: Char): Boolean;

1.4.8.2.18 Function SAPxRFCUtf8Decode Unit



407

1

File

gsSAPxRFCUtil

Syntax

function SAPxRFCUtf8Decode(const S: UTF8String): UnicodeString;

1.4.8.2.19 Function SAPxRFCUtf8Encode Unit


File

gsSAPxRFCUtil

Syntax

function SAPxRFCUtf8Encode(const WS: UnicodeString): UTF8String;

1.4.8.2.20 Function SAPxRFCUtf8ToAnsi Unit


File

gsSAPxRFCUtil

Syntax

function SAPxRFCUtf8ToAnsi(const S: UTF8String): string;

1.4.8.2.21 Function SAPxRFCWideStrLen Unit


File

gsSAPxRFCUtil

Syntax

function SAPxRFCWideStrLen(AStr: PWideChar): Integer;

1.4.8.2.22 Function SAPxRFCWStrCopy Unit


File

gsSAPxRFCUtil

Syntax

function SAPxRFCWStrCopy(Dest: PWideChar; const Source: PWideChar): PWideChar;

1.4.8.3 Types


408

1

1.4.8.3.1 Type IntPtr Unit


File

gsSAPxRFCUtil

Description

The IntPtr type is introduced for compatibility of the source code in the Win32 and .Net modes. In Win32 mode it is alias forPointer. In .Net mode is used predefined .Net type.

Syntax

IntPtr = Pointer;

1.4.8.3.2 Type PBoolean Unit


File

gsSAPxRFCUtil

Syntax

PBoolean = ^Boolean;

1.4.8.3.3 Type PRawByteString Unit


File

gsSAPxRFCUtil

Description

Pointer to a string of bytes.

Syntax

PRawByteString = PAnsiChar;

1.4.8.3.4 Type PUInt64 Unit


File

gsSAPxRFCUtil

Syntax

PUInt64 = ^gsSAPxRFCUtil.UInt64;

1.4.8.3.5 Type RawByteString Unit



409

1

File

gsSAPxRFCUtil

Description

String of bytes. On pre-Delphi 2009 tools it is defined as AnsiString. On Delphi 2009 it is a native Delphi type.

Syntax

RawByteString = AnsiString;

1.4.8.3.6 Type TBytes Unit


File

gsSAPxRFCUtil

Description

The TBytes type is introduced for compatibility of the source code in the Win32 and .Net modes. In Win32 mode it is alias for"array of bytes". In .Net mode is used predefined .Net type.

Syntax

TBytes = array of Byte;

1.4.8.3.7 Type TSAPxNativeInt Unit


File

gsSAPxRFCUtil

Syntax

TSAPxNativeInt = Integer;

1.4.8.3.8 Type TSAPxNativeUInt Unit


File

gsSAPxRFCUtil

Syntax

TSAPxNativeUInt = LongWord;

1.4.8.3.9 Type TSysCharSet Unit


File

gsSAPxRFCUtil

Syntax

TSysCharSet = set of Char;


410

1

1.4.8.3.10 Type UInt64 Unit


File

gsSAPxRFCUtil

Syntax

UInt64 = Int64;

1.4.8.3.11 Type UnicodeString Unit


File

gsSAPxRFCUtil

Description

String of Unicode (UCS-2) characters. On pre-Delphi 2009 tools it is defined as WideString. On Delphi 2009 it is a nativeDelphi type.

Syntax

UnicodeString = WideString;

1.4.8.3.12 Type UTF8String Unit


File

gsSAPxRFCUtil

Description

String of Unicode (UTF-8) characters. On pre-Delphi 7 tools it is defined as AnsiString. On Delphi 7 and newer it is a nativeDelphi type.

Syntax

UTF8String = type string;

1.4.8.4 Constants

1.4.8.4.1 Constant C_SAPxVersion Unit


File

gsSAPxRFCUtil

Syntax

C_SAPxVersion = '3.0.17';


411

1

1.4.8.4.2 Constant PathDelim Unit


File

gsSAPxRFCUtil

Syntax

PathDelim = '\';

1.4.8.4.3 Constant PathSep Unit


File

gsSAPxRFCUtil

Syntax

PathSep = ';';

1.4.8.4.4 Constant sLineBreak Unit


File

gsSAPxRFCUtil

Syntax

sLineBreak = #13#10;

1.4.9 Unit gsSAPxRFCvClient

Classes

TSAPxRFCvBlobStreamGS ( see page 423)

TSAPxRFCvClientConnectionGS ( see page 424)

TSAPxRFCvCustomTableGS ( see page 433)

TSAPxRFCvFunctionGS ( see page 449)

TSAPxRFCvParamsGS ( see page 455)

TSAPxRFCvRemoteObjectGS ( see page 466)

TSAPxRFCvServerTableGS ( see page 474)

TSAPxRFCvTableGS ( see page 486)

TSAPxRFCvCustomClientConnectionGS ( see page 496)

1.4 Units Connect for SAP ® Unit gsSAPxRFCvClient

412

1

TSAPxRFCvCustomRemoteObjectGS ( see page 498)

Group


Legend

Enumeration

Records, Enums

TSAPxRFCvParamKindGS ( see page 498)

Types

TRecBuf ( see page 499)

TRecordBuffer ( see page 499)

TSAPxRFCvParamKindsGS ( see page 499)

TSAPxRFCvParamSetKindGS ( see page 499)

TValueBuffer ( see page 499)

Description

Unit gsSAPxRFCvClient contains a set of components for realization of client part of application.

The TSAPxRFCvClientConnectionGS ( see page 424) is the main component of client program. It maintain connectionfrom Connect for SAP® application to the SAP server. The TSAPxRFCvFunctionGS ( see page 449) allows to maintaininput parameters, execute and receive results of any SAP RFC function module.

Such descendants of TDataSet component as TSAPxRFCvTableGS ( see page 486), TSAPxRFCvParamsGS ( see page455) and TSAPxRFCvServerTableGS ( see page 474) can be used with data-aware controls. The TSAPxRFCvTableGS (see page 486) component allows accessing to the specified table from TSAPxRFCvFunctionGS ( see page 449)component's table list. The TSAPxRFCvParamsGS ( see page 455) component allows accessing to the parameters ofTSAPxRFCvFunctionGS component. The TSAPxRFCvServerTableGS ( see page 474) component accesses to SAPserver table's data and field description.

1.4.9.1 Classes

1.4.9.1.1 Class TSAPxRFCvBlobStreamGS Unit

Unit gsSAPxRFCvClient ( see page 422)

Legend

Constructor

All Members

Methods



Truncate ( see page 424)



413

1

Methods



Truncate ( see page 424)


File

gsSAPxRFCvClient

Description

TSAPxRFCvBlobStreamGS is a stream object that provides services which allow applications to read from or write todataset field objects that represent Binary large object (BLOB) fields. Connect for SAP® represents byte string data andcharacter string data as of fixed as of variable length's with maximum length greater than 8192 as BLOB fields.

Syntax

public TSAPxRFCvBlobStreamGS = class(TMemoryStream);

1.4.9.1.1.1 Methods

1.4.9.1.1.1.1 Constructor TSAPxRFCvBlobStreamGS.Create

Class

Class TSAPxRFCvBlobStreamGS ( see page 423)

Description

Object constructor creates stream for specific BLOB field and opens stream in specified mode.

Field - BLOB field.

Mode - BLOB stream open mode.

Syntax

public constructor Create(Field: TBlobField; Mode: TBlobStreamMode);

1.4.9.1.1.1.2 Destructor TSAPxRFCvBlobStreamGS.Destroy

Class


Description

Object destructor. Destroy triggers an OnDataChange event if the BLOB stream was used to overwrite or modify the data inthe field. Destroy then frees any buffers that were allocated to handle the data.

Syntax


1.4.9.1.1.1.3 Method TSAPxRFCvBlobStreamGS.Truncate

Class


Description

Discards all data in the BLOB field from the current position on. Do not call Truncate when the TSAPxRFCvBlobStream wascreated in bmRead mode.

Syntax

public procedure Truncate;


414

1

1.4.9.1.1.1.4 Method TSAPxRFCvBlobStreamGS.Write

Class


Description

Writes Count bytes from Buffer to the current position in the field and updates the current position by Count bytes. Do notcall Write when the TSAPxRFCvBlobStream was created in bmRead mode.

Syntax

public function Write(const Buffer; Count: Longint): Longint; override;

1.4.9.1.2 Class TSAPxRFCvClientConnectionGS Events

OnEnterBusy ( see page 522)

AfterConnect ( see page 522)

OnExitBusy ( see page 522)

AfterDisconnect ( see page 522)


BeforeConnect ( see page 522)

OnIdle ( see page 523)

BeforeDisconnect ( see page 523)

Class TSAPxRFCvClientConnectionGS










Unit


Legend

Constructor

All Members

Methods


ApplyOldConnected ( see page 519)


DefineProperties ( see page 519)


DoRfcConnectionAfterConnect ( see page 519)

DoRfcConnectionAfterDisconnect ( see page 519)


415

1

DoRfcConnectionBeforeConnect ( see page 520)

DoRfcConnectionBeforeDisconnect ( see page 520)

DoRfcConnectionEnterBusy ( see page 520)

DoRfcConnectionError ( see page 520)

DoRfcConnectionExitBusy ( see page 520)

DoRfcConnectionIdle ( see page 520)

GetRfcConnectionClass ( see page 520)

NotifyActiveChange ( see page 520)

RegisterActiveChangeHandler ( see page 521)

UnregisterActiveChangeHandler ( see page 521)



GetAliasList ( see page 429)




Loaded ( see page 429)


Properties


RfcConnection ( see page 521)

WaitCursor ( see page 521)









Events










416

1











Methods




















GetAliasList ( see page 429)






Properties




417

1










File

gsSAPxRFCvClient

Description

TSAPxRFCvClientConnectionGS provides a connection to a SAP R/3 system. It is a component class that encapsulatesTSAPxRFCClientConnectionGS connection object.

TSAPxRFCvClientConnectionGS is used in the client part of a SAP R/3 aware application to establish and maintain theconnection between the client and a remote SAP R/3 application server. Before opening a connection you should define itsparameters. There are two ways to specify a connection parameters.

1. Use an alias. In this way you define connection parameters in an alias file storage. Then you specify the alias file name with AliasFileName ( see page 430) property and determines the exact alias you would like to use with AliasName ( see page 430) property.

2. Specifying parameters. The way you need to specify each connection parameter individually using Params ( see page 431) property.

The first approach is more flexible because it doesn't have a hard-coded connection information. Thus it does not need tochange a code when connection parameters are modified. As well you can mix both the ways. It means that any parameterdefined by an alias can be overridden by the corresponding non-empty parameter from Params ( see page 431).RFCConnection.ResultAlias ( see page 108) contains result values of connection parameters.

Having specified connection parameters, you can open the connection setting Active ( see page 430) property in True. Ifyou want to substitute login procedure you have to assign your own event handler to OnLogin ( see page 433) event. Touse a standard Connect for SAP® login form LoginPrompt ( see page 430) should be set to True.

Use following methods to control transactions. StartTransaction ( see page 429) initiates a new transaction and gets atransaction identifier (TID) from SAP R/3 system. The EndTransaction ( see page 429) method completes an activetransaction. If an error occurs (almost only communication errors), the client program has to reconnect to SAP R/3 later andrepeat transaction with the specific TID. In this case the RestoreTransaction ( see page 430) method is used for restartinga failed transaction with old TID. This fact ensures that a transactional RFC function will be executed exactly once in the R/3system (see example ( see page 524)).

Syntax

public TSAPxRFCvClientConnectionGS = class(TSAPxRFCvCustomClientConnectionGS);

1.4.9.1.2.1 Methods

1.4.9.1.2.1.1 Constructor TSAPxRFCvClientConnectionGS.Create

Class

Class TSAPxRFCvClientConnectionGS ( see page 424)


418

1

Description

Creates a new TSAPxRFCvClientConnectionGS object.

Syntax

public constructor Create(AOwner: TComponent); override;

1.4.9.1.2.1.2 Method TSAPxRFCvClientConnectionGS.GetAliasList

Class


Description

Returns a new alias list of GetAliasStorageClass ( see page 106) class and set it FileName ( see page 113) property toAliasFileName ( see page 430) property value.

Syntax

public function GetAliasList: TSAPxRFCCustomAliasListGS;

1.4.9.1.2.1.3 Method TSAPxRFCvClientConnectionGS.ApplyOldConnected

Class


Syntax

protected procedure ApplyOldConnected(AValue: Boolean); override;

1.4.9.1.2.1.4 Method TSAPxRFCvClientConnectionGS.StartTransaction

Class


Description

Initiates a new transaction (see example ( see page 524)).

Syntax

public procedure StartTransaction;

1.4.9.1.2.1.5 Method TSAPxRFCvClientConnectionGS.EndTransaction

Class


Description

Completes an active transaction (see example ( see page 524)).

Syntax

public procedure EndTransaction;

1.4.9.1.2.1.6 Method TSAPxRFCvClientConnectionGS.Loaded

Class


Syntax

protected procedure Loaded; override;

1.4.9.1.2.1.7 Method TSAPxRFCvClientConnectionGS.RestoreTransaction

Class



419

1

Description

Restores a transaction with the specified TID (see example ( see page 524)).

Syntax

public procedure RestoreTransaction(ATID: String);


1.4.9.1.2.2.1 Property TSAPxRFCvClientConnectionGS.Active

Class


Description

Determines whether a connection has been established to the source of data. Active property can also control this process.

Syntax

published property Active: Boolean;

1.4.9.1.2.2.2 Property TSAPxRFCvClientConnectionGS.AliasFileName

Class


Description

Specifies a name of the file, which contains a set of aliases. See also AliasName ( see page 430).

Syntax

published property AliasFileName: String;

1.4.9.1.2.2.3 Property TSAPxRFCvClientConnectionGS.AliasName

Class


Description

Specifies a current connection alias name. See also AliasFileName ( see page 430).

Syntax

published property AliasName: String;

1.4.9.1.2.2.4 Property TSAPxRFCvClientConnectionGS.LoginPrompt

Class


Description

Determines if login form will be used to get user credentials before open a connection.

Syntax

published property LoginPrompt: Boolean;

1.4.9.1.2.2.5 Property TSAPxRFCvClientConnectionGS.Params

Class


Description

Specifies an initial set of connection parameters.


420

1

Syntax

published property Params: TSAPxRFCAliasGS;

1.4.9.1.2.2.6 Property TSAPxRFCvClientConnectionGS.RfcConnection

Class


Description

Returns a reference to encapsulated RFC client connection object.

Syntax

public property RfcConnection: TSAPxRFCClientConnectionGS;

1.4.9.1.2.2.7 Property TSAPxRFCvClientConnectionGS.WaitCursor

Class


Description

Specifies the mouse pointer cursor. It will be used when connection enters busy state.

Syntax

published property WaitCursor: TCursor;

1.4.9.1.2.3 Events

1.4.9.1.2.3.1 Event TSAPxRFCvClientConnectionGS.AfterConnect

Class


Description

Occurs after a connection is established.

Syntax

published property AfterConnect: TNotifyEvent;

1.4.9.1.2.3.2 Event TSAPxRFCvClientConnectionGS.AfterDisconnect

Class


Description

Occurs after the connection closes.

Syntax

published property AfterDisconnect: TNotifyEvent;

1.4.9.1.2.3.3 Event TSAPxRFCvClientConnectionGS.BeforeConnect

Class


Description

Occurs immediately before establishing a connection.

Syntax

published property BeforeConnect: TNotifyEvent;


421

1

1.4.9.1.2.3.4 Event TSAPxRFCvClientConnectionGS.BeforeDisconnect

Class


Description

Occurs immediately before closing a connection.

Syntax

published property BeforeDisconnect: TNotifyEvent;

1.4.9.1.2.3.5 Event TSAPxRFCvClientConnectionGS.OnEnterBusy

Class


Description

Occurs when a connection enters busy state. In most cases this happens at function execution. See also OnExitBusy ( seepage 432).

Syntax

published property OnEnterBusy: TNotifyEvent;

1.4.9.1.2.3.6 Event TSAPxRFCvClientConnectionGS.OnError

Class


Description

Occurs when an error happens either at call of connection methods or function execution.

Syntax

published property OnError: TSAPxRFCErrorEventGS;

1.4.9.1.2.3.7 Event TSAPxRFCvClientConnectionGS.OnExitBusy

Class


Description

Occurs when a connection leaves busy state. See also OnEnterBusy ( see page 432).

Syntax

published property OnExitBusy: TNotifyEvent;

1.4.9.1.2.3.8 Event TSAPxRFCvClientConnectionGS.OnIdle

Class


Description

Occurs while a connection is open and is in idle state.

Syntax

published property OnIdle: TNotifyEvent;

1.4.9.1.2.3.9 Event TSAPxRFCvClientConnectionGS.OnLogin

Class



422

1

Description

Occurs before opening a connection. Use this event to assign your own login procedure.

Syntax

published property OnLogin: TSAPxRFCConnectionLoginEventGS;

1.4.9.1.3 Class TSAPxRFCvCustomTableGS Unit


Legend

Constructor

All Members

Methods

AddFieldDesc ( see page 437)

AllocateTable ( see page 438)

AllocRecordBuffer ( see page 438)

BookmarkValid ( see page 438)

ClearCalcFields ( see page 438)

CloseBlob ( see page 438)

CompareBookmarks ( see page 439)


CreateBlobStream ( see page 439)

DataConvert ( see page 439)


FieldIdToField ( see page 440)

FreeRecordBuffer ( see page 440)

FreeTable ( see page 440)

GetBookmarkData ( see page 440)

GetBookmarkFlag ( see page 441)

GetCanModify ( see page 441)

GetCurrentRecord ( see page 441)

GetFieldData ( see page 441)


GetRecNo ( see page 442)

GetRecord ( see page 442)

GetRecordCount ( see page 442)

GetRecordSize ( see page 443)

InitRecord ( see page 443)

InternalAddRecord ( see page 443)

InternalCancel ( see page 443)


InternalDelete ( see page 444)

InternalEdit ( see page 444)

InternalFirst ( see page 444)

InternalGotoBookmark ( see page 444)


423

1

InternalHandleException ( see page 444)

InternalInitFieldDefs ( see page 444)

InternalInitRecord ( see page 445)

InternalInsert ( see page 445)

InternalLast ( see page 445)

InternalOpen ( see page 445)

InternalPost ( see page 445)

InternalRefresh ( see page 446)

InternalSetToRecord ( see page 446)

IsCursorOpen ( see page 446)

IsSequenced ( see page 446)

Locate ( see page 446)

LocateRecord ( see page 447)

Lookup ( see page 447)

ReleaseTable ( see page 447)

SetBookmarkData ( see page 447)

SetBookmarkFlag ( see page 448)

SetFieldData ( see page 448)

SetRecNo ( see page 448)

Properties

Func ( see page 448)


RemoteObject ( see page 449)

RFCTable ( see page 449)

Methods
























424

1






























Properties





File

gsSAPxRFCvClient

Description

TSAPxRFCvCustomTableGS handles SAP RFC internal table (ITAB). The class encapsulates TSAPxRFCTableGS ( seepage 351) object and represent it as TDataSet descendant.

Property RFCTable ( see page 449) returns a reference to TSAPxRFCTableGS ( see page 351) table object. PropertyFunc ( see page 448) references to TSAPxRFCvFunctionGS ( see page 449) component. If it is nil, then table isstandalone and acts like an in-memory table. If it is not nil, then table belongs to function and it controls table structure,transfers it data to / from SAP server, and so on.


425

1

TSAPxRFCvCustomTableGS is abstract base class for other Connect for SAP® datasets:

• TSAPxRFCvTableGS ( see page 486) - used with TSAPxRFCvFunctionGS ( see page 449) component to handle function tables.

• TSAPxRFCvParamsGS ( see page 455) - used with TSAPxRFCvFunctionGS ( see page 449) component to handle function parameters.

• TSAPxRFCvServerTableGS ( see page 474) - transfers data from SAP server table to client.

Most of methods and properties of TSAPxRFCvCustomTableGS are standard for TDataSet descendants. For example:Locate ( see page 446), Lookup ( see page 447), GetFieldData ( see page 441), SetFieldData ( see page 448).

Syntax

public TSAPxRFCvCustomTableGS = class(TDataSet);

1.4.9.1.3.1 Methods

1.4.9.1.3.1.1 Method TSAPxRFCvCustomTableGS.AddFieldDesc

Class

Class TSAPxRFCvCustomTableGS ( see page 433)

Description

Creates a new field definition object using TSAPxRFCFieldGS ( see page 281) properties, adds it to the AFieldDefs list andreturns the object.

AFieldDefs - List of fields definitions.

ASAPField - Field of SAP table.

AFieldID - Identifier of the SAP table field.

Returns new TFieldDef object.

Syntax

protected function AddFieldDesc(var AFieldDefs: TFieldDefs; ASAPField: TSAPxRFCFieldGS; var AFieldID: Integer): TFieldDef; virtual;

1.4.9.1.3.1.2 Method TSAPxRFCvCustomTableGS.AllocateTable

Class


Description

Introduces abstract method to create new RFC table.

Syntax

protected function AllocateTable: TSAPxRFCTableGS; virtual; abstract;

1.4.9.1.3.1.3 Method TSAPxRFCvCustomTableGS.AllocRecordBuffer

Class


Description

Implements virtual method, allocating internal TDataSet record buffer.


426

1

Syntax

protected function AllocRecordBuffer: TRecordBuffer; override;

1.4.9.1.3.1.4 Method TSAPxRFCvCustomTableGS.BookmarkValid

Class


Description

Method verifies a bookmark.

Bookmark - Bookmark to verify.

Returns True if a bookmark is valid.

Syntax

public function BookmarkValid(Bookmark: TBookmark): Boolean; override;

1.4.9.1.3.1.5 Method TSAPxRFCvCustomTableGS.ClearCalcFields

Class


Description

Implements virtual method to clear calculated fields in buffer.

Buffer - pointer to record buffer.

Syntax

protected procedure ClearCalcFields(Buffer: TRecordBuffer); override;

1.4.9.1.3.1.6 Method TSAPxRFCvCustomTableGS.CloseBlob

Class


Description

Implements virtual method.

Syntax

protected procedure CloseBlob(Field: TField); override;

1.4.9.1.3.1.7 Method TSAPxRFCvCustomTableGS.CompareBookmarks

Class


Description

Compares Bookmark1 and Bookmark2.

Bookmark1 - Bookmark to compare.

Bookmark2 - Bookmark to compare.

Returns a value less than 0 if Bookmark1 is less than Bookmark2, 0 if the bookmarks are identical, and a value greater than0 if Bookmark1 is greater than Bookmark2.


427

1

Syntax

public function CompareBookmarks(Bookmark1: TBookmark; Bookmark2: TBookmark): Integer; override;

1.4.9.1.3.1.8 Constructor TSAPxRFCvCustomTableGS.Create

Class


Description

Creates a new TSAPxRFCvCustomTableGS's descendant object.

Syntax


1.4.9.1.3.1.9 Method TSAPxRFCvCustomTableGS.CreateBlobStream

Class


Description

Implements virtual method. It creates a stream for specified BLOB field and opens it in specified mode.

Field - Blob field.

Mode - Stream mode.

Returns created BLOB stream.

Syntax

public function CreateBlobStream(Field: TField; Mode: TBlobStreamMode): TStream; override;

1.4.9.1.3.1.10 Method TSAPxRFCvCustomTableGS.DataConvert

Class


Syntax

protected procedure DataConvert(Field: TField; Source: TValueBuffer; Dest: TValueBuffer; ToNative: Boolean); override;

1.4.9.1.3.1.11 Destructor TSAPxRFCvCustomTableGS.Destroy

Class


Description

Destroys the TSAPxRFCvCustomTableGS's descendant object.

Syntax


1.4.9.1.3.1.12 Method TSAPxRFCvCustomTableGS.FieldIdToField

Class


Description

Maps TField.FieldNo to TSAPxRFCFieldGS (RFC table field) object.


428

1

AFieldID - Field identifier. Corresponds to TField.FieldNo.

Returns a RFC field object.

Syntax

public function FieldIdToField(AFieldID: Integer): TSAPxRFCFieldGS; virtual;

1.4.9.1.3.1.13 Method TSAPxRFCvCustomTableGS.FreeRecordBuffer

Class


Description

Implements a virtual method to free record buffer.

Buffer - pointer to buffer to free.

Syntax

protected procedure FreeRecordBuffer(var Buffer: TRecordBuffer); override;

1.4.9.1.3.1.14 Method TSAPxRFCvCustomTableGS.FreeTable

Class


Description

Introduces abstract method to free ATab table.

Syntax

protected procedure FreeTable(ATab: TSAPxRFCTableGS); virtual; abstract;

1.4.9.1.3.1.15 Method TSAPxRFCvCustomTableGS.GetBookmarkData

Class


Description

Implements virtual method. It returns a bookmark for specified record buffer.

Buffer - record buffer.

Data - pointer to buffer which will get bookmark.

Syntax

protected procedure GetBookmarkData(Buffer: PChar; Data: Pointer); override;

1.4.9.1.3.1.16 Method TSAPxRFCvCustomTableGS.GetBookmarkFlag

Class


Description

Implements virtual method. It returns a bookmark flag for specified record buffer.


Returns a bookmark flag.


429

1

Syntax

protected function GetBookmarkFlag(Buffer: TRecordBuffer): TBookmarkFlag; override;

1.4.9.1.3.1.17 Method TSAPxRFCvCustomTableGS.GetCanModify

Class


Description

Implements virtual method. It returns True if table data may be modified.

Syntax

protected function GetCanModify: Boolean; override;

1.4.9.1.3.1.18 Method TSAPxRFCvCustomTableGS.GetCurrentRecord

Class


Description

Implements virtual method. Copies current table record to Buffer.

Returns True, if current record exists

Syntax

public function GetCurrentRecord(Buffer: TRecordBuffer): Boolean; override;

1.4.9.1.3.1.19 Method TSAPxRFCvCustomTableGS.GetFieldData (Integer, TValueBuffer)

Class


Description

Implements virtual method. Copies data of specified field to buffer.

FieldNo - field number.

Buffer - Buffer for field data.

Returns True, if data was copied.

Syntax

public function GetFieldData(FieldNo: Integer; Buffer: TValueBuffer): Boolean; override; overload;

1.4.9.1.3.1.20 Method TSAPxRFCvCustomTableGS.GetFieldData (TField, TValueBuffer)

Class


Description

Implements virtual method. Copies data of specified field to buffer.

Field - field to get data.

Buffer - Buffer for field data.

Returns True, if data was copied.


430

1

Syntax

public function GetFieldData(Field: TField; Buffer: TValueBuffer): Boolean; override; overload;

1.4.9.1.3.1.21 Method TSAPxRFCvCustomTableGS.GetRecNo

Class


Description

Implements virtual method. Returns current record number.

Syntax

protected function GetRecNo: Integer; override;

1.4.9.1.3.1.22 Method TSAPxRFCvCustomTableGS.GetRecord

Class


Description

Implements virtual method. Depending on GetMode copies previous, current or next record into Buffer record buffer.

Buffer - record buffer to copy record to.

GetMode - defines which record to get.

DoCheck - if True and error happened, then exception will be raised, otherwise error code will be returned.

Returns completion status (EOF, BOF, Error or OK).

Syntax

protected function GetRecord(Buffer: TRecordBuffer; GetMode: TGetMode; DoCheck: Boolean): TGetResult; override;

1.4.9.1.3.1.23 Method TSAPxRFCvCustomTableGS.GetRecordCount

Class


Description

Implements virtual method. Returns number of records in table.

Syntax

protected function GetRecordCount: Integer; override;

1.4.9.1.3.1.24 Method TSAPxRFCvCustomTableGS.GetRecordSize

Class


Description

Implements virtual method. Returns size of record. See TSAPxRFCTableGS.RecordSize ( see page 364) property.

Syntax

protected function GetRecordSize: Word; override;


431

1

1.4.9.1.3.1.25 Method TSAPxRFCvCustomTableGS.InitRecord

Class


Description

Implements virtual method. Initializes a record buffer as a new record.

Syntax

protected procedure InitRecord(Buffer: TRecordBuffer); override;

1.4.9.1.3.1.26 Method TSAPxRFCvCustomTableGS.InternalAddRecord

Class


Description

Implements virtual method. TDataSet call this method to add new record to record storage.

Syntax

protected procedure InternalAddRecord(Buffer: Pointer; Append: Boolean); override;

1.4.9.1.3.1.27 Method TSAPxRFCvCustomTableGS.InternalCancel

Class


Description

Implements virtual method. TDataSet call this method to cancel all changes to current record.

Syntax

protected procedure InternalCancel; override;

1.4.9.1.3.1.28 Method TSAPxRFCvCustomTableGS.InternalClose

Class


Description

Implements virtual method. TDataSet call this method to close record storage.

Syntax

protected procedure InternalClose; override;

1.4.9.1.3.1.29 Method TSAPxRFCvCustomTableGS.InternalDelete

Class


Description

Implements virtual method. TDataSet call this method to delete current record from record storage.

Syntax

protected procedure InternalDelete; override;

1.4.9.1.3.1.30 Method TSAPxRFCvCustomTableGS.InternalEdit

Class



432

1

Description

Implements virtual method. TDataSet call this method to start current record editing.

Syntax

protected procedure InternalEdit; override;

1.4.9.1.3.1.31 Method TSAPxRFCvCustomTableGS.InternalFirst

Class


Description

Implements virtual method. TDataSet call this method to position current record pointer before first record.

Syntax

protected procedure InternalFirst; override;

1.4.9.1.3.1.32 Method TSAPxRFCvCustomTableGS.InternalGotoBookmark

Class


Description

Implements virtual method. TDataSet call this method to position current record pointer according bookmark.

Syntax

protected procedure InternalGotoBookmark(Bookmark: Pointer); override; overload;

1.4.9.1.3.1.33 Method TSAPxRFCvCustomTableGS.InternalHandleException

Class


Description

Implements virtual method. TDataSet call this method to handle an exception.

Syntax

protected procedure InternalHandleException; override;

1.4.9.1.3.1.34 Method TSAPxRFCvCustomTableGS.InternalInitFieldDefs

Class


Description

Implements virtual method. TDataSet call this method to initialize field definitions according to record storage layout.

Syntax

protected procedure InternalInitFieldDefs; override;

1.4.9.1.3.1.35 Method TSAPxRFCvCustomTableGS.InternalInitRecord

Class


Description

Implements virtual method. TDataSet call this method to erase all record fields.

Syntax

protected procedure InternalInitRecord(Buffer: TRecordBuffer); override;


433

1

1.4.9.1.3.1.36 Method TSAPxRFCvCustomTableGS.InternalInsert

Class


Description

Implements virtual method. TDataSet call this method to start insertion of new record.

Syntax

protected procedure InternalInsert; override;

1.4.9.1.3.1.37 Method TSAPxRFCvCustomTableGS.InternalLast

Class


Description

Implements virtual method. TDataSet call this method to position current record pointer after last record in record storage.

Syntax

protected procedure InternalLast; override;

1.4.9.1.3.1.38 Method TSAPxRFCvCustomTableGS.InternalOpen

Class


Description

Implements virtual method. TDataSet call this method to open a record storage.

Syntax

protected procedure InternalOpen; override;

1.4.9.1.3.1.39 Method TSAPxRFCvCustomTableGS.InternalPost

Class


Description

Implements virtual method. TDataSet call this method to finish addition or editing of record to record storage.

Syntax

protected procedure InternalPost; override;

1.4.9.1.3.1.40 Method TSAPxRFCvCustomTableGS.InternalRefresh

Class


Description

Implements virtual method. TDataSet call this method to refresh records in record storage.

Syntax

protected procedure InternalRefresh; override;

1.4.9.1.3.1.41 Method TSAPxRFCvCustomTableGS.InternalSetToRecord

Class



434

1

Description

Implements virtual method. TDataSet call this method to position current record pointer to record fetched into Buffer.

Syntax

protected procedure InternalSetToRecord(Buffer: TRecordBuffer); override;

1.4.9.1.3.1.42 Method TSAPxRFCvCustomTableGS.IsCursorOpen

Class


Description

Implements virtual method. TDataSet call this method to detect is record storage open or not.

Syntax

protected function IsCursorOpen: Boolean; override;

1.4.9.1.3.1.43 Method TSAPxRFCvCustomTableGS.IsSequenced

Class


Description

Indicates whether the underlying record storage uses record numbers to indicate the order of records.

Syntax

public function IsSequenced: Boolean; override;

1.4.9.1.3.1.44 Method TSAPxRFCvCustomTableGS.Locate

Class


Description

Implements a virtual method for searching a dataset for a specified record and making it the active record.

KeyFields - A string containing field names separated by ';'.

KeyValues - A variant array containing field values to search.

Options - Search options.

Returns True, if record found.

Syntax

public function Locate(const KeyFields: string; const KeyValues: Variant; Options: TLocateOptions): Boolean; override;

1.4.9.1.3.1.45 Method TSAPxRFCvCustomTableGS.LocateRecord

Class


Description

Implements Lookup ( see page 447) and Locate ( see page 446) methods.

Syntax

protected function LocateRecord(const KeyFields: string; const KeyValues: Variant; Options: TLocateOptions): Boolean;


435

1

1.4.9.1.3.1.46 Method TSAPxRFCvCustomTableGS.Lookup

Class


Description

Implements a virtual method to retrieve field values from a record that matches specified search values.

KeyFields - A string containing field names to search separated by ';'.

KeyValues - A variant array containing field values to search.

ResultFields - A string containing field names to return separated by ';'.

Returns a values of ResultFields.

Syntax

public function Lookup(const KeyFields: string; const KeyValues: Variant; const ResultFields: string): Variant; override;

1.4.9.1.3.1.47 Method TSAPxRFCvCustomTableGS.ReleaseTable

Class


Description

Releases internal table resources by freeing RFCTable ( see page 449) object.

Syntax

protected procedure ReleaseTable;

1.4.9.1.3.1.48 Method TSAPxRFCvCustomTableGS.SetBookmarkData

Class


Description

Implements virtual method. It writes a bookmark to a specified record buffer.


Data - pointer to buffer which will set bookmark.

Syntax

protected procedure SetBookmarkData(Buffer: PChar; Data: Pointer); override;

1.4.9.1.3.1.49 Method TSAPxRFCvCustomTableGS.SetBookmarkFlag

Class


Description

Implements virtual method. It writes a bookmark flag to a specified record buffer.


Value - bookmark flags to write.


436

1

Syntax

protected procedure SetBookmarkFlag(Buffer: TRecordBuffer; AValue: TBookmarkFlag); override;

1.4.9.1.3.1.50 Method TSAPxRFCvCustomTableGS.SetFieldData

Class


Description

Implements virtual method. Copies data of buffer to a specified field.

Field - Field to write data.

Buffer - Buffer with data.

Syntax

protected procedure SetFieldData(Field: TField; Buffer: TValueBuffer); override;

1.4.9.1.3.1.51 Method TSAPxRFCvCustomTableGS.SetRecNo

Class


Description

Implements virtual method. Moves current record pointer to a record with specified number.

Value - Record number.

Syntax

protected procedure SetRecNo(AValue: Integer); override;


1.4.9.1.3.2.1 Property TSAPxRFCvCustomTableGS.Func

Class


Description

References to TSAPxRFCvFunctionGS ( see page 449) component, whose table is managed byTSAPxRFCvCustomTableGS component.

Syntax

protected property Func: TSAPxRFCvFunctionGS;

1.4.9.1.3.2.2 Property TSAPxRFCvCustomTableGS.ReadOnly

Class


Description

Indicates whether or not table data can be modified.

Syntax



437

1

1.4.9.1.3.2.3 Property TSAPxRFCvCustomTableGS.RemoteObject

Class


Description

References to a component encapsulating a remote object, whose table data is managed by a TSAPxRFCvCustomTableGScomponent. In most cases it will be TSAPxRFCvFunctionGS ( see page 449) object.

Syntax

protected property RemoteObject: TSAPxRFCvRemoteObjectGS;

1.4.9.1.3.2.4 Property TSAPxRFCvCustomTableGS.RFCTable

Class


Description

Returns a reference to encapsulated Connect for SAP® internal table object.

Syntax

public property RFCTable: TSAPxRFCTableGS;

1.4.9.1.4 Class TSAPxRFCvFunctionGS Events

Class TSAPxRFCvRemoteObjectGS

AfterCall ( see page 473)

AfterPrepare ( see page 473)

AfterUnPrepare ( see page 473)

BeforeCall ( see page 473)

BeforePrepare ( see page 473)

BeforeUnPrepare ( see page 473)



Unit


Legend

Constructor

All Members

Methods




DoAfterCall ( see page 469)

DoAfterPrepare ( see page 469)

DoAfterUnPrepare ( see page 469)

DoBeforeCall ( see page 469)

DoBeforePrepare ( see page 470)

DoBeforeUnPrepare ( see page 470)


438

1



GetRemoteObjectClass ( see page 470)


Notification ( see page 471)



Class TSAPxRFCvFunctionGS



Properties





ObjName ( see page 472)


RFCRemoteObject ( see page 472)





RFCFunction ( see page 454)


Events










Methods











439

1











Properties












RFCFunction ( see page 454)


File

gsSAPxRFCvClient

Description

TSAPxRFCvCustomTableGS handles SAP RFC function. The class encapsulates TSAPxRFCFunctionGS ( see page 299)object and represent it as TComponent descendant.

Setting Prepared ( see page 472) property to True, Connect for SAP® will prepare function module for execution. Toexecute function, you have to initialize all required input parameters in the InParams ( see page 454) list and addnecessary records to the tables from the Tables ( see page 454) list. Then call ExecFunction ( see page 453) and if noerror happens, you will get output parameter values in the OutParams ( see page 454) list. Setting Prepared ( see page472) property to False, Connect for SAP® will release used resources.

Function module call may be as of transactional as of non-transactional type. This is defined CallType ( see page 454)property. If you use transactional function you cannot use output parameters. Unlike non-transactional functions thetransactional ones must be called within an active transaction. Use TSAPxRFCvClientConnectionGS ( see page 424)methods to start, restart and complete transaction. Also function module call may be as blocking as non-blocking. That iscontrolled by Async ( see page 471) property. In non-blocking mode, while SAP server executes function module, OnIdle( see page 474) event will be fired few times.


440

1

Example

The following example shows non-transactional function execution.

var FCFunction: TSAPxRFCvFunctionGS; procedure TfrmMain.btnExecuteClick(Sender: TObject);var iLoop: Integer;begin try iLoop := StrToInt(edtABAPLoop.Text); except memResult.Lines.Add('Wrong parameter "ALOOPNUM count"'); Exit; end; memResult.Lines.Clear; with FCFunction do begin Prepared := True; InParams.ParameterByName('ALOOPNUM').AsInteger := iLoop; try ExecFunction; except memResult.Lines.Add('Execution is aborted by system.'); btnDisconnectClick(nil); Exit; end; memResult.Lines.Add(OutParams.ParameterByName('AINFO').AsString); end;end;

Example

Unlike non-transactional functions the transactional ones must be called within an active transaction. UseTSAPxRFCvClientConnectionGS ( see page 424) methods to start, restart and complete transaction. The followingexample shows transactional function execution.

var FCConnection: TSAPxRFCvClientConnectionGS; FCTxFunction: TSAPxRFCvFunctionGS; FTID: String; procedure TfrmMain.btnStartClick(Sender: TObject);begin FCConnection.StartTransaction; try F_TID := FCConnection.RFCConnection.TID; FCTxFunction.ExecFunction; F_TID := ''; finally FCConnection.EndTransaction; end;end; procedure TfrmMain.btnReStartClick(Sender: TObject);begin FCConnection.RestoreTransaction(F_TID); try FCTxFunction.ExecFunction; F_TID := ''; finally FCConnection.EndTransaction; end;end;

Syntax

public TSAPxRFCvFunctionGS = class(TSAPxRFCvRemoteObjectGS);


441

1

1.4.9.1.4.1 Methods

1.4.9.1.4.1.1 Method TSAPxRFCvFunctionGS.ExecFunction

Class

Class TSAPxRFCvFunctionGS ( see page 449)

Description

Executes the specified function module in a SAP system.

Syntax

public function ExecFunction(AWaitForCompletion: Boolean = True): Boolean;

1.4.9.1.4.1.2 Method TSAPxRFCvFunctionGS.GetRemoteObjectClass

Class


Description

Implements a virtual method. Returns a reference to TSAPxRFCFunctionGS class.

Syntax

protected class function GetRemoteObjectClass: TSAPxRFCRemoteObjectClassGS; override;


1.4.9.1.4.2.1 Property TSAPxRFCvFunctionGS.CallType

Class


Description

Specifies how function module is called either as transactional either as non-transactional.

Syntax

published property CallType: TSAPxRFCFunctionCallTypeGS;

1.4.9.1.4.2.2 Property TSAPxRFCvFunctionGS.InParams

Class


Description

Holds a list of the input (passed to SAP) parameters.

Syntax

public property InParams: TSAPxRFCParametersListGS;

1.4.9.1.4.2.3 Property TSAPxRFCvFunctionGS.OutParams

Class


Description

Holds a list of output (received from SAP) parameters. Use OutParams array to access to the output parameters ofnon-transactional functions only.


442

1

Syntax

public property OutParams: TSAPxRFCParametersListGS;

1.4.9.1.4.2.4 Property TSAPxRFCvFunctionGS.RFCFunction

Class


Description

Returns a reference to encapsulated Connect for SAP® function object.

Syntax

public property RFCFunction: TSAPxRFCFunctionGS;

1.4.9.1.4.2.5 Property TSAPxRFCvFunctionGS.Tables

Class


Description

Holds an array of the tables used by the function.

Syntax


1.4.9.1.5 Class TSAPxRFCvParamsGS Events

Class TSAPxRFCvParamsGS

AfterCancel ( see page 464)

AfterClose ( see page 464)

AfterEdit ( see page 464)

AfterOpen ( see page 464)

AfterPost ( see page 464)

AfterRefresh ( see page 465)

BeforeCancel ( see page 465)

BeforeClose ( see page 465)

BeforeEdit ( see page 465)

BeforeOpen ( see page 465)

BeforePost ( see page 465)

BeforeRefresh ( see page 465)

OnCalcFields ( see page 466)

OnEditError ( see page 466)

OnPostError ( see page 466)

Unit


Legend

Constructor


443

1

All Members

Methods















































444

1












DoBeforeDelete ( see page 461)

DoBeforeInsert ( see page 461)


FieldIdToParam ( see page 461)






LoadParamValues ( see page 463)

SaveParamValues ( see page 463)

Properties







AutoCalcFields ( see page 463)


ObjectView ( see page 463)

ParamKinds ( see page 464)


Events













445

1






Methods











































446

1
















DoBeforeDelete ( see page 461)

DoBeforeInsert ( see page 461)


FieldIdToParam ( see page 461)






LoadParamValues ( see page 463)

SaveParamValues ( see page 463)

Properties









ObjectView ( see page 463)

ParamKinds ( see page 464)


File

gsSAPxRFCvClient

Description

TSAPxRFCvParamsGS encapsulates RFC function module parameters.

TSAPxRFCvParamsGS is used with TSAPxRFCvFunctionGS ( see page 449) to represent a set of function parameters.TSAPxRFCvParamsGS is inherited from TSAPxRFCvCustomTableGS ( see page 433) class. So, TSAPxRFCvParamsGSis a dataset, where each field corresponds to function parameters. Because that, you can display function parameter


447

1

descriptions and edit parameter values using data aware controls.

To use TSAPxRFCvParamsGS component, assign a function component TSAPxRFCvFunctionGS ( see page 449) toFunc ( see page 463) property. Set ParamKinds ( see page 464) property value to set of parameter kinds you need tohave in dataset. Set Active property to True to open dataset and get an access to parameters data.

Because of components nature, dataset always will have just single row. So, following methods are prohibited:

• Delete;

• Insert;

• Append;

• InsertRecord;

• AppendRecord.

Also, usage of navigate methods is irrational, although is not prohibited.

Syntax

public TSAPxRFCvParamsGS = class(TSAPxRFCvCustomTableGS);

1.4.9.1.5.1 Methods

1.4.9.1.5.1.1 Method TSAPxRFCvParamsGS.AddFieldDesc

Class

Class TSAPxRFCvParamsGS ( see page 455)

Syntax

protected function AddFieldDesc(var AFieldDefs: TFieldDefs; ASAPField: TSAPxRFCFieldGS; var AFieldID: Integer): TFieldDef; override;

1.4.9.1.5.1.2 Method TSAPxRFCvParamsGS.AllocateTable

Class


Description

Implements a virtual method of TSAPxRFCvCustomTableGS. Creates TSAPxRFCTableGS object, which will keepparameter values. Also see there ( see page 438).

Syntax

protected function AllocateTable: TSAPxRFCTableGS; override;

1.4.9.1.5.1.3 Constructor TSAPxRFCvParamsGS.Create

Class


Description

Creates a new TSAPxRFCvParamsGS object.

Syntax



448

1

1.4.9.1.5.1.4 Destructor TSAPxRFCvParamsGS.Destroy

Class


Description

Destroys the TSAPxRFCvParamsGS instance.

Syntax


1.4.9.1.5.1.5 Method TSAPxRFCvParamsGS.DoBeforeDelete

Class


Syntax

protected procedure DoBeforeDelete; override;

1.4.9.1.5.1.6 Method TSAPxRFCvParamsGS.DoBeforeInsert

Class


Syntax

protected procedure DoBeforeInsert; override;

1.4.9.1.5.1.7 Method TSAPxRFCvParamsGS.FieldIdToField

Class


Description

Maps TField.FieldNo to TSAPxRFCFieldGS (RFC table field) object.

AFieldID - Field identifier. Corresponds to TField.FieldNo.

Returns a RFC field object.

Syntax

public function FieldIdToField(AFieldID: Integer): TSAPxRFCFieldGS; override;

1.4.9.1.5.1.8 Method TSAPxRFCvParamsGS.FieldIdToParam

Class


Description

Maps a TField.FieldNo to a TSAPxRFCParameterGS ( see page 324) (function parameter) and TSAPxRFCFieldGS ( seepage 281) (sub field in case of structure typed parameter).

AFieldID - Dataset field identifier. Corresponds to TField.FieldNo.

AParam - Returns function parameter object.

ASubField - Returns parameter object sub field.

Returns parameter kind.


449

1

Syntax

public function FieldIdToParam(AFieldID: Integer; var AParam: TSAPxRFCParameterGS; var ASubField: TSAPxRFCFieldGS): TSAPxRFCvParamKindGS;

1.4.9.1.5.1.9 Method TSAPxRFCvParamsGS.FreeTable

Class


Description


Syntax

protected procedure FreeTable(ATab: TSAPxRFCTableGS); override;

1.4.9.1.5.1.10 Method TSAPxRFCvParamsGS.InternalAddRecord

Class


Description

Implements virtual method. TDataSet call this method to add new record to record storage.

Syntax

protected procedure InternalAddRecord(Buffer: Pointer; Append: Boolean); override;

1.4.9.1.5.1.11 Method TSAPxRFCvParamsGS.InternalPost

Class


Description

Implements virtual method. TDataSet call this method to finish addition or editing of record to record storage.

Syntax

protected procedure InternalPost; override;

1.4.9.1.5.1.12 Method TSAPxRFCvParamsGS.InternalRefresh

Class


Description

Implements virtual method. TDataSet call this method to refresh records in record storage.

Syntax

protected procedure InternalRefresh; override;

1.4.9.1.5.1.13 Method TSAPxRFCvParamsGS.IsCursorOpen

Class


Description

Implements virtual method. TDataSet call this method to detect is record storage open or not.

Syntax

protected function IsCursorOpen: Boolean; override;


450

1

1.4.9.1.5.1.14 Method TSAPxRFCvParamsGS.LoadParamValues

Class


Description

Loads the parameter values in the ATab fields.

Syntax

protected procedure LoadParamValues(ATab: TSAPxRFCTableGS);

1.4.9.1.5.1.15 Method TSAPxRFCvParamsGS.SaveParamValues

Class


Description

Saves a values of ATab fields to the parameters.

Syntax

protected procedure SaveParamValues(ATab: TSAPxRFCTableGS);


1.4.9.1.5.2.1 Property TSAPxRFCvParamsGS.Active

Class


Syntax

published property Active;

1.4.9.1.5.2.2 Property TSAPxRFCvParamsGS.AutoCalcFields

Class


Syntax

published property AutoCalcFields;

1.4.9.1.5.2.3 Property TSAPxRFCvParamsGS.Func

Class


Description

Specifies a reference to TSAPxRFCvFunctionGS component, which set of parameters will be represented by dataset.

Syntax

published property Func: TSAPxRFCvFunctionGS;

1.4.9.1.5.2.4 Property TSAPxRFCvParamsGS.ObjectView

Class


Syntax

published property ObjectView;


451

1

1.4.9.1.5.2.5 Property TSAPxRFCvParamsGS.ParamKinds

Class


Description

Defines a set of parameter kinds you need to have in dataset.

Syntax

published property ParamKinds: TSAPxRFCvParamKindsGS;

1.4.9.1.5.2.6 Property TSAPxRFCvParamsGS.ReadOnly

Class


Description


Syntax

published property ReadOnly: Boolean;

1.4.9.1.5.3 Events

1.4.9.1.5.3.1 Property TSAPxRFCvParamsGS.AfterCancel

Class


Syntax

published property AfterCancel;

1.4.9.1.5.3.2 Property TSAPxRFCvParamsGS.AfterClose

Class


Syntax

published property AfterClose;

1.4.9.1.5.3.3 Property TSAPxRFCvParamsGS.AfterEdit

Class


Syntax

published property AfterEdit;

1.4.9.1.5.3.4 Property TSAPxRFCvParamsGS.AfterOpen

Class


Syntax

published property AfterOpen;

1.4.9.1.5.3.5 Property TSAPxRFCvParamsGS.AfterPost

Class



452

1

Syntax

published property AfterPost;

1.4.9.1.5.3.6 Property TSAPxRFCvParamsGS.AfterRefresh

Class


Syntax

published property AfterRefresh;

1.4.9.1.5.3.7 Property TSAPxRFCvParamsGS.BeforeCancel

Class


Syntax

published property BeforeCancel;

1.4.9.1.5.3.8 Property TSAPxRFCvParamsGS.BeforeClose

Class


Syntax

published property BeforeClose;

1.4.9.1.5.3.9 Property TSAPxRFCvParamsGS.BeforeEdit

Class


Syntax

published property BeforeEdit;

1.4.9.1.5.3.10 Property TSAPxRFCvParamsGS.BeforeOpen

Class


Syntax

published property BeforeOpen;

1.4.9.1.5.3.11 Property TSAPxRFCvParamsGS.BeforePost

Class


Syntax

published property BeforePost;

1.4.9.1.5.3.12 Property TSAPxRFCvParamsGS.BeforeRefresh

Class


Syntax

published property BeforeRefresh;


453

1

1.4.9.1.5.3.13 Property TSAPxRFCvParamsGS.OnCalcFields

Class


Syntax

published property OnCalcFields;

1.4.9.1.5.3.14 Property TSAPxRFCvParamsGS.OnEditError

Class


Syntax

published property OnEditError;

1.4.9.1.5.3.15 Property TSAPxRFCvParamsGS.OnPostError

Class


Syntax

published property OnPostError;

1.4.9.1.6 Class TSAPxRFCvRemoteObjectGS Events










Unit


Legend

Constructor

All Members

Methods










454

1









Properties








Events










Methods


















455

1

Properties








File

gsSAPxRFCvClient

Description

TSAPxRFCvRemoteObjectGS is an abstract component class, that encapsulates callable remote SAP object. Maindescendant of TSAPxRFCvRemoteObjectGS is TSAPxRFCvFunctionGS ( see page 449) .

Property ObjName ( see page 472) specifies a name of remote SAP object. Connection ( see page 472) propertyreferences to TSAPxRFCvClientConnectionGS ( see page 424) component, handling an RFC connection to SAP server.When property Prepared ( see page 472) value is True, component has required set of meta information and is ready forexecution. After component is prepared, main action (like a ExecFunction ( see page 453)) may be performed. If propertyAsync ( see page 471) value is True, then action will be performed nonblocking and event OnIdle ( see page 474) firesfew times. Property RFCRemoteObject ( see page 472) returns reference to Connect for SAP® remote object.

Syntax

public TSAPxRFCvRemoteObjectGS = class(TSAPxRFCvCustomRemoteObjectGS);

1.4.9.1.6.1 Methods

1.4.9.1.6.1.1 Constructor TSAPxRFCvRemoteObjectGS.Create

Class

Class TSAPxRFCvRemoteObjectGS ( see page 466)

Description

Creates a new component. Do not create instance of TSAPxRFCvRemoteObjectGS. Instead use descendants ofTSAPxRFCvRemoteObjectGS such as TSAPxRFCvFunctionGS ( see page 449).

Syntax


1.4.9.1.6.1.2 Destructor TSAPxRFCvRemoteObjectGS.Destroy

Class


Description

Destroys the component.

Syntax


1.4.9.1.6.1.3 Method TSAPxRFCvRemoteObjectGS.DoAfterCall

Class



456

1

Description

Connect for SAP® software calls this method right after remote object call is finished. Calls AfterCall ( see page 473) eventhandler if it is assigned.

Syntax

protected procedure DoAfterCall(ASender: TObject); virtual;

1.4.9.1.6.1.4 Method TSAPxRFCvRemoteObjectGS.DoAfterPrepare

Class


Description

Connect for SAP® software calls this method right after component preparation is finished. Calls AfterPrepare ( see page473) event handler if it is assigned.

Syntax

protected procedure DoAfterPrepare(ASender: TObject); virtual;

1.4.9.1.6.1.5 Method TSAPxRFCvRemoteObjectGS.DoAfterUnPrepare

Class


Description

Connect for SAP® software calls this method right after component unpreparation is finished. Calls AfterUnPrepare ( seepage 473) event handler if it is assigned.

Syntax

protected procedure DoAfterUnPrepare(ASender: TObject); virtual;

1.4.9.1.6.1.6 Method TSAPxRFCvRemoteObjectGS.DoBeforeCall

Class


Description

Connect for SAP® software calls this method right before remote object will be called. Calls BeforeCall ( see page 473)event handler if it is assigned.

Syntax

protected procedure DoBeforeCall(ASender: TObject); virtual;

1.4.9.1.6.1.7 Method TSAPxRFCvRemoteObjectGS.DoBeforePrepare

Class


Description

Connect for SAP® software calls this method right before component will be prepared. Calls BeforePrepare ( see page473) event handler if it is assigned.

Syntax

protected procedure DoBeforePrepare(ASender: TObject); virtual;

1.4.9.1.6.1.8 Method TSAPxRFCvRemoteObjectGS.DoBeforeUnPrepare

Class



457

1

Description

Connect for SAP® software calls this method right before component will be unprepared. Calls BeforeUnprepare ( seepage 473) event handler if it is assigned.

Syntax

protected procedure DoBeforeUnPrepare(ASender: TObject); virtual;

1.4.9.1.6.1.9 Method TSAPxRFCvRemoteObjectGS.DoError

Class


Description

Connect for SAP® software calls this method if during SAP remote object execution error happened. Calls OnError ( seepage 474) event handler if it is assigned.

E - Exception object.

AErrAction - Returns error action.

Syntax

protected procedure DoError(ASender: TObject; E: Exception; var AErrAction: TSAPxRFCErrorActionGS); virtual;

1.4.9.1.6.1.10 Method TSAPxRFCvRemoteObjectGS.DoIdle

Class


Description

Connect for SAP® software calls this method when component is in idle state. Component may be idling if it was called inasynchronous mode (Async ( see page 471) = True). Method calls OnIdle ( see page 474) event handler if it is assigned.

Syntax

protected procedure DoIdle(ASender: TObject); virtual;

1.4.9.1.6.1.11 Method TSAPxRFCvRemoteObjectGS.GetRemoteObjectClass

Class


Description

Introduces abstract method to return class of Connect for SAP® remote object. Component creates instance of this classand assigns it to RFCRemoteObject ( see page 472) property.

Syntax

protected class function GetRemoteObjectClass: TSAPxRFCRemoteObjectClassGS; virtual;

1.4.9.1.6.1.12 Method TSAPxRFCvRemoteObjectGS.Loaded

Class


Syntax

protected procedure Loaded; override;


458

1

1.4.9.1.6.1.13 Method TSAPxRFCvRemoteObjectGS.Notification

Class


Syntax

protected procedure Notification(AComponent: TComponent; Operation: TOperation); override;

1.4.9.1.6.1.14 Method TSAPxRFCvRemoteObjectGS.Prepare

Class


Description

Prepares a component. After that it may be executed. Also method opens a Connection ( see page 472) if it is assignedand is not active.

Syntax

public procedure Prepare;

1.4.9.1.6.1.15 Method TSAPxRFCvRemoteObjectGS.Unprepare

Class


Description

Unprepares a component.

Syntax

public procedure Unprepare;


1.4.9.1.6.2.1 Property TSAPxRFCvRemoteObjectGS.Async

Class


Description

Indicates whether component uses asynchronous calling mode. When Async is True, then client software can perform someactions in OnIdle ( see page 474) event handler, while SAP remote object call is not finished. If Async is False, then clientsoftware will be blocked, until SAP remote object call is finished.

Syntax

published property Async: Boolean;

1.4.9.1.6.2.2 Property TSAPxRFCvRemoteObjectGS.Connection

Class


Description

Property references to component handling a connection with SAP server.

Syntax

published property Connection: TSAPxRFCvClientConnectionGS;


459

1

1.4.9.1.6.2.3 Property TSAPxRFCvRemoteObjectGS.DataFormat

Class


Description

Returns a reference to data format object, which controls mapping of RFC data type to Delphi data type.

Syntax


1.4.9.1.6.2.4 Property TSAPxRFCvRemoteObjectGS.ObjName

Class


Description

Specifies a SAP remote object name.

Syntax

published property ObjName: String;

1.4.9.1.6.2.5 Property TSAPxRFCvRemoteObjectGS.Prepared

Class


Description

Specifies whether or not a component is prepared for execution.

Syntax

published property Prepared: Boolean;

1.4.9.1.6.2.6 Property TSAPxRFCvRemoteObjectGS.RFCRemoteObject

Class


Description

Specifies a reference to Connect for SAP® remote object.

Syntax

public property RFCRemoteObject: TSAPxRFCRemoteObjectGS;

1.4.9.1.6.3 Events

1.4.9.1.6.3.1 Event TSAPxRFCvRemoteObjectGS.AfterCall

Class


Description

Event is fired right after SAP remote object is called.

Syntax

published property AfterCall: TNotifyEvent;


460

1

1.4.9.1.6.3.2 Event TSAPxRFCvRemoteObjectGS.AfterPrepare

Class


Description

Event is fired right after component is prepared.

Syntax

published property AfterPrepare: TNotifyEvent;

1.4.9.1.6.3.3 Event TSAPxRFCvRemoteObjectGS.AfterUnPrepare

Class


Description

Event is fired right after component is unprepared.

Syntax

published property AfterUnPrepare: TNotifyEvent;

1.4.9.1.6.3.4 Event TSAPxRFCvRemoteObjectGS.BeforeCall

Class


Description

Event is fired right before SAP remote object will be called.

Syntax

published property BeforeCall: TNotifyEvent;

1.4.9.1.6.3.5 Event TSAPxRFCvRemoteObjectGS.BeforePrepare

Class


Description

Event is fired right before component will be prepared.

Syntax

published property BeforePrepare: TNotifyEvent;

1.4.9.1.6.3.6 Event TSAPxRFCvRemoteObjectGS.BeforeUnPrepare

Class


Description

Event is fired right before component will be unprepared.

Syntax

published property BeforeUnPrepare: TNotifyEvent;

1.4.9.1.6.3.7 Event TSAPxRFCvRemoteObjectGS.OnError

Class



461

1

Description

Event is fired when an error is happened during SAP remote object call.

Syntax


1.4.9.1.6.3.8 Event TSAPxRFCvRemoteObjectGS.OnIdle

Class


Description

Event occurs when component is in idle state. Component may be idling if it was called in asynchronous mode (Async (see page 471) = True).

Syntax

published property OnIdle: TNotifyEvent;

1.4.9.1.7 Class TSAPxRFCvServerTableGS Events

Class TSAPxRFCvServerTableGS



AfterDelete ( see page 484)


AfterInsert ( see page 484)




AfterScroll ( see page 484)



BeforeDelete ( see page 485)


BeforeInsert ( see page 485)




BeforeScroll ( see page 486)


OnDeleteError ( see page 486)


OnNewRecord ( see page 486)


Unit


Legend

Constructor


462

1

All Members

Methods















































463

1












OpenCursor ( see page 481)

Properties











RFCEasyDataMove ( see page 482)




TableName ( see page 483)


Events


















464

1









Methods








































465

1



















OpenCursor ( see page 481)

Properties











RFCEasyDataMove ( see page 482)






File

gsSAPxRFCvClient

Description

TSAPxRFCvServerTableGS uses SAP RFC_READ_TABLE function module to transfer SAP server table data to client.Component is a TSAPxRFCvCustomTableGS descendant, so it is a dataset.

Connection ( see page 481) property references to TSAPxRFCvClientConnectionGS ( see page 424) component,handling an RFC connection to SAP server. TableName ( see page 483) property defines name of a SAP server table.Select ( see page 483) property specifies what fields are selected and Where ( see page 483) properties allow to limit aresult dataset. If Select ( see page 483) property is empty then the result dataset will contain all fields of the specified SAP


466

1

server table. The rowset may be limited by properties RowCount ( see page 482) and RowSkips ( see page 482). Firstone defines how many records to return to client. Second one defines how many records SAP server should skip beforereturning rowset to client.

Each of transferred records is actually character string. Where fields are of fixed sizes. The total record length cannotexceed 512 characters. If component fails with a conversion error to deliver the data, then depending on a SAP RFCversion, you may need to change DataFormat ( see page 482).ReadTable ( see page 256).

After definition all required properties you can open table using Active property or Open method. Navigating in aTSAPxRFCvServerTableGS component is the same as in the standard dataset. Use such methods as First, Next, Last andPrior to programmatically move the row pointer through the set of records.

Programmatically modifying data is the same, too. Methods like Insert and Edit put the TSAPxRFCvServerTableGS inediting mode. Post finalizes data changes and Cancel cancels any updates and reverts field values to their original values.TSAPxRFCvServerTableGS cant post changes back to SAP server, so all changes will remain on client only.

Example

Following example moves data from SAP server table to client DBase table.

var rfcSrvTab: TSAPxRFCvServerTableGS; tblDBF: TTable; procedure TfrmMain.btnOpenClick(Sender: TObject);begin rfcSrvTab.TableName := edtTabName.Text; rfcSrvTab.Select := mmFields.Lines; rfcSrvTab.Where := mmWhere.Lines; rfcSrvTab.Open;end; procedure TfrmMain.btnExportClick(Sender: TObject);var i: Integer;begin tblDBF.TableName := 'c:\' + rfcSrvTab.TableName + '.DBF'; tblDBF.TableType := ttFoxPro; tblDBF.TableLevel := 25; tblDBF.FieldDefs.Assign(rfcSrvTab.FieldDefs); tblDBF.CreateTable; tblDBF.Active := True; rfcSrvTab.DisableControls; tblDBF.DisableControls; try rfcSrvTab.First; while not rfcSrvTab.Eof do begin tblDBF.Append; for i := 0 to rfcSrvTab.FieldCount - 1 do tblDBF.Fields[i].Value := rfcSrvTab.Fields[i].Value; tblDBF.Post; rfcSrvTab.Next; end; finally rfcSrvTab.EnableControls; tblDBF.EnableControls; tblDBF.Active := False; end;end;


467

1

Syntax

public TSAPxRFCvServerTableGS = class(TSAPxRFCvCustomTableGS);

1.4.9.1.7.1 Methods

1.4.9.1.7.1.1 Method TSAPxRFCvServerTableGS.AllocateTable

Class

Class TSAPxRFCvServerTableGS ( see page 474)

Description


Syntax


1.4.9.1.7.1.2 Constructor TSAPxRFCvServerTableGS.Create

Class


Description

Creates a new TSAPxRFCvCustomTableGS's descendant object.

Syntax


1.4.9.1.7.1.3 Destructor TSAPxRFCvServerTableGS.Destroy

Class


Description

Destroys the TSAPxRFCvCustomTableGS's descendant object.

Syntax


1.4.9.1.7.1.4 Method TSAPxRFCvServerTableGS.FreeTable

Class


Description


Syntax


1.4.9.1.7.1.5 Method TSAPxRFCvServerTableGS.OpenCursor

Class


Syntax

protected procedure OpenCursor(InfoQuery: Boolean); override;



468

1

1.4.9.1.7.2.1 Property TSAPxRFCvServerTableGS.Active

Class


Syntax


1.4.9.1.7.2.2 Property TSAPxRFCvServerTableGS.AutoCalcFields

Class


Syntax


1.4.9.1.7.2.3 Property TSAPxRFCvServerTableGS.Connection

Class


Description

Property references to component handling a connection with SAP server.

Syntax

published property Connection: TSAPxRFCvClientConnectionGS;

1.4.9.1.7.2.4 Property TSAPxRFCvServerTableGS.DataFormat

Class


Description

Returns a reference to data format object, which controls mapping of RFC data type to Delphi data type.

Syntax


1.4.9.1.7.2.5 Property TSAPxRFCvServerTableGS.ReadOnly

Class


Description


Syntax


1.4.9.1.7.2.6 Property TSAPxRFCvServerTableGS.RFCEasyDataMove

Class


Description

Returns a reference to TSAPxRFCEasyDataMoveGS ( see page 121) data move object.

Syntax

public property RFCEasyDataMove: TSAPxRFCEasyDataMoveGS;


469

1

1.4.9.1.7.2.7 Property TSAPxRFCvServerTableGS.RowCount

Class


Description

Specified a maximum number of records to be returned in the result dataset. See also RowSkips ( see page 482) andWhere ( see page 483).

Syntax

published property RowCount: Integer;

1.4.9.1.7.2.8 Property TSAPxRFCvServerTableGS.RowSkips

Class


Description

Specified a number of records that have to be skipped in the result dataset before it to be returned. See also RowCount (see page 482).

Syntax

published property RowSkips: Integer;

1.4.9.1.7.2.9 Property TSAPxRFCvServerTableGS.Select

Class


Description

Contains the set of the SAP DB table fields, which will be included in the result dataset. Each field name is one string in theTStrings object. If Select property is empty then the result dataset will contain all fields of the specified SAP server table.

Syntax

published property Select: TStrings;

1.4.9.1.7.2.10 Property TSAPxRFCvServerTableGS.TableName

Class


Description

Specifies a name of SAP server table.

Syntax

published property TableName: String;

1.4.9.1.7.2.11 Property TSAPxRFCvServerTableGS.Where

Class


Description

Contains the set of conditions to limit result dataset. It follows to ANSI SQL WHERE clause syntax, but followingconstructions are not supported:

• functions;

• nested queries.


470

1

All non empty lines in TStrings object will be concatenated using AND clause.

Syntax

published property Where: TStrings;

1.4.9.1.7.3 Events

1.4.9.1.7.3.1 Property TSAPxRFCvServerTableGS.AfterCancel

Class


Syntax


1.4.9.1.7.3.2 Property TSAPxRFCvServerTableGS.AfterClose

Class


Syntax


1.4.9.1.7.3.3 Property TSAPxRFCvServerTableGS.AfterDelete

Class


Syntax

published property AfterDelete;

1.4.9.1.7.3.4 Property TSAPxRFCvServerTableGS.AfterEdit

Class


Syntax


1.4.9.1.7.3.5 Property TSAPxRFCvServerTableGS.AfterInsert

Class


Syntax

published property AfterInsert;

1.4.9.1.7.3.6 Property TSAPxRFCvServerTableGS.AfterOpen

Class


Syntax


1.4.9.1.7.3.7 Property TSAPxRFCvServerTableGS.AfterPost

Class



471

1

Syntax


1.4.9.1.7.3.8 Property TSAPxRFCvServerTableGS.AfterRefresh

Class


Syntax


1.4.9.1.7.3.9 Property TSAPxRFCvServerTableGS.AfterScroll

Class


Syntax

published property AfterScroll;

1.4.9.1.7.3.10 Property TSAPxRFCvServerTableGS.BeforeCancel

Class


Syntax


1.4.9.1.7.3.11 Property TSAPxRFCvServerTableGS.BeforeClose

Class


Syntax


1.4.9.1.7.3.12 Property TSAPxRFCvServerTableGS.BeforeDelete

Class


Syntax

published property BeforeDelete;

1.4.9.1.7.3.13 Property TSAPxRFCvServerTableGS.BeforeEdit

Class


Syntax


1.4.9.1.7.3.14 Property TSAPxRFCvServerTableGS.BeforeInsert

Class


Syntax

published property BeforeInsert;


472

1

1.4.9.1.7.3.15 Property TSAPxRFCvServerTableGS.BeforeOpen

Class


Syntax


1.4.9.1.7.3.16 Property TSAPxRFCvServerTableGS.BeforePost

Class


Syntax


1.4.9.1.7.3.17 Property TSAPxRFCvServerTableGS.BeforeRefresh

Class


Syntax


1.4.9.1.7.3.18 Property TSAPxRFCvServerTableGS.BeforeScroll

Class


Syntax

published property BeforeScroll;

1.4.9.1.7.3.19 Property TSAPxRFCvServerTableGS.OnCalcFields

Class


Syntax


1.4.9.1.7.3.20 Property TSAPxRFCvServerTableGS.OnDeleteError

Class


Syntax

published property OnDeleteError;

1.4.9.1.7.3.21 Property TSAPxRFCvServerTableGS.OnEditError

Class


Syntax


1.4.9.1.7.3.22 Property TSAPxRFCvServerTableGS.OnNewRecord

Class



473

1

Syntax

published property OnNewRecord;

1.4.9.1.7.3.23 Property TSAPxRFCvServerTableGS.OnPostError

Class


Syntax


1.4.9.1.8 Class TSAPxRFCvTableGS Events

Class TSAPxRFCvTableGS
























Unit


Legend

Constructor

All Members

Methods






474

1

















































475

1




Properties











Events

























Methods








476

1















































477

1




Properties











File

gsSAPxRFCvClient

Description

TSAPxRFCvTableGS encapsulates a table that is used with TSAPxRFCvFunctionGS. This component is descendant ofTSAPxRFCvCustomTableGS ( see page 433), so it is a dataset.

The TSAPxRFCvTableGS provides Delphi applications the ability to access data from a single table used in function. To useTSAPxRFCvTableGS component, assign a function component TSAPxRFCvFunctionGS ( see page 449) to Func ( seepage 492) property and specify the function's table name in the TableName ( see page 492) property. Use Active propertyto make the table data accessible.

After definition all required properties you can open table using Active property or Open method. Navigating in aTSAPxRFCvTableGS component is the same as in the standard dataset. Use such methods as First, Next, Last and Prior toprogrammatically move the row pointer through the set of records.

Programmatically modifying data is the same, too. Methods like Insert and Edit put the TSAPxRFCvTableGS in editingmode. Post finalizes data changes and Cancel cancels any updates and reverts field values to their original values.

Syntax

public TSAPxRFCvTableGS = class(TSAPxRFCvCustomTableGS);

1.4.9.1.8.1 Methods

1.4.9.1.8.1.1 Method TSAPxRFCvTableGS.AllocateTable

Class

Class TSAPxRFCvTableGS ( see page 486)

Description


Syntax



478

1

1.4.9.1.8.1.2 Method TSAPxRFCvTableGS.FreeTable

Class


Description


Syntax



1.4.9.1.8.2.1 Property TSAPxRFCvTableGS.Active

Class


Syntax


1.4.9.1.8.2.2 Property TSAPxRFCvTableGS.AutoCalcFields

Class


Syntax


1.4.9.1.8.2.3 Property TSAPxRFCvTableGS.Func

Class


Description

References to TSAPxRFCvFunctionGS ( see page 449) component, whose table is managed byTSAPxRFCvCustomTableGS component.

Syntax

published property Func: TSAPxRFCvFunctionGS;

1.4.9.1.8.2.4 Property TSAPxRFCvTableGS.ReadOnly

Class


Description


Syntax


1.4.9.1.8.2.5 Property TSAPxRFCvTableGS.TableName

Class


Description

Specifies a name of the function's table. The function is defined by Func ( see page 492) property.


479

1

Syntax

published property TableName: String;

1.4.9.1.8.3 Events

1.4.9.1.8.3.1 Property TSAPxRFCvTableGS.AfterCancel

Class


Syntax


1.4.9.1.8.3.2 Property TSAPxRFCvTableGS.AfterClose

Class


Syntax


1.4.9.1.8.3.3 Property TSAPxRFCvTableGS.AfterDelete

Class


Syntax

published property AfterDelete;

1.4.9.1.8.3.4 Property TSAPxRFCvTableGS.AfterEdit

Class


Syntax


1.4.9.1.8.3.5 Property TSAPxRFCvTableGS.AfterInsert

Class


Syntax

published property AfterInsert;

1.4.9.1.8.3.6 Property TSAPxRFCvTableGS.AfterOpen

Class


Syntax


1.4.9.1.8.3.7 Property TSAPxRFCvTableGS.AfterPost

Class


Syntax



480

1

1.4.9.1.8.3.8 Property TSAPxRFCvTableGS.AfterRefresh

Class


Syntax


1.4.9.1.8.3.9 Property TSAPxRFCvTableGS.AfterScroll

Class


Syntax

published property AfterScroll;

1.4.9.1.8.3.10 Property TSAPxRFCvTableGS.BeforeCancel

Class


Syntax


1.4.9.1.8.3.11 Property TSAPxRFCvTableGS.BeforeClose

Class


Syntax


1.4.9.1.8.3.12 Property TSAPxRFCvTableGS.BeforeDelete

Class


Syntax

published property BeforeDelete;

1.4.9.1.8.3.13 Property TSAPxRFCvTableGS.BeforeEdit

Class


Syntax


1.4.9.1.8.3.14 Property TSAPxRFCvTableGS.BeforeInsert

Class


Syntax

published property BeforeInsert;

1.4.9.1.8.3.15 Property TSAPxRFCvTableGS.BeforeOpen

Class



481

1

Syntax


1.4.9.1.8.3.16 Property TSAPxRFCvTableGS.BeforePost

Class


Syntax


1.4.9.1.8.3.17 Property TSAPxRFCvTableGS.BeforeRefresh

Class


Syntax


1.4.9.1.8.3.18 Property TSAPxRFCvTableGS.BeforeScroll

Class


Syntax

published property BeforeScroll;

1.4.9.1.8.3.19 Property TSAPxRFCvTableGS.OnCalcFields

Class


Syntax


1.4.9.1.8.3.20 Property TSAPxRFCvTableGS.OnDeleteError

Class


Syntax

published property OnDeleteError;

1.4.9.1.8.3.21 Property TSAPxRFCvTableGS.OnEditError

Class


Syntax


1.4.9.1.8.3.22 Property TSAPxRFCvTableGS.OnNewRecord

Class


Syntax

published property OnNewRecord;


482

1

1.4.9.1.8.3.23 Property TSAPxRFCvTableGS.OnPostError

Class


Syntax


1.4.9.1.9 Class TSAPxRFCvCustomClientConnectionGS Events









Unit


Legend

Constructor

All Members

Methods

















483

1



Properties




Events









Methods


















Properties





484

1

File

gsSAPxRFCvClient

Syntax

public TSAPxRFCvCustomClientConnectionGS = class(TSAPxRFCvCustomConnectionGS);

1.4.9.1.10 Class TSAPxRFCvCustomRemoteObjectGS Unit


File

gsSAPxRFCvClient

Syntax

public TSAPxRFCvCustomRemoteObjectGS = class(TSAPxRFCvCustomObjectGS);


1.4.9.2.1 Enumeration TSAPxRFCvParamKindGS All Members


ipNone Parameter is not set.

ipIn Input parameter.

ipOut Output parameter.

Unit


File

gsSAPxRFCvClient

Description

TSAPxRFCvParamKindGS values determine kind of parameter.

Syntax

public TSAPxRFCvParamKindGS = ( ipNone, ipIn, ipOut);

1.4.9.3 Types

1.4.9.3.1 Type TRecBuf Unit


File

gsSAPxRFCvClient


485

1

Syntax

TRecBuf = TRecordBuffer;

1.4.9.3.2 Type TRecordBuffer Unit


File

gsSAPxRFCvClient

Syntax

TRecordBuffer = PChar;

1.4.9.3.3 Type TSAPxRFCvParamKindsGS Unit


File

gsSAPxRFCvClient

Description

A set of TSAPxRFCvParamKindGS ( see page 498) values.

Syntax

TSAPxRFCvParamKindsGS = set of TSAPxRFCvParamSetKindGS;

1.4.9.3.4 Type TSAPxRFCvParamSetKindGS Unit


File

gsSAPxRFCvClient

Description

A set of TSAPxRFCvParamKindGS ( see page 498) values.

Syntax

TSAPxRFCvParamSetKindGS = ipIn .. ipOut ;

1.4.9.3.5 Type TValueBuffer Unit


File

gsSAPxRFCvClient

Syntax

TValueBuffer = Pointer;

1.4 Units Connect for SAP ® Unit gsSAPxRFCvServer

486

1

1.4.10 Unit gsSAPxRFCvServer

Classes

TSAPxRFCvServerConnectionGS ( see page 500)

TSAPxRFCvServerFunctionGS ( see page 507)

Group


Description

Unit gsSAPxRFCvServer contains a set of components to implement an external SAP server.

TSAPxRFCServerConnectionGS ( see page 141) is the main component to build non-SAP server program. It maintains aconnection between the external server and a SAP system. TSAPxRFCvServerFunctionGS ( see page 507) allows toimplement required server functionality using it event handlers.

1.4.10.1 Classes

1.4.10.1.1 Class TSAPxRFCvServerConnectionGS Events





OnCheckTID ( see page 506)





Unit

Unit gsSAPxRFCvServer ( see page 500)

Legend

Constructor

All Members

Methods








487

1

Properties




OnCommit ( see page 504)

OnConfirm ( see page 504)

OnRollback ( see page 504)




Events





OnCheckTID ( see page 506)





Methods







Properties




OnCommit ( see page 504)

OnConfirm ( see page 504)

OnRollback ( see page 504)




File

gsSAPxRFCvServer

Description

TSAPxRFCvServerConnectionGS component encapsulates a server connection object TSAPxRFCServerConnectionGS (see page 141). Thus the most of component methods and properties directly corresponds toTSAPxRFCServerConnectionGS ( see page 141) ones. Use this component if you need to implement a SAP serverprogram.


488

1

According to TSAPxRFCServerConnectionGS description, you need just define CommandLine ( see page 504) to get theserver connection working. This must be done before TSAPxRFCServerApplicationGS ( see page 130) server applicationobject will be started using Start ( see page 134) method.

Use OnCheckTID ( see page 506), OnCommit ( see page 504), OnRollback ( see page 504), OnConfirm ( see page504) events to control transactional calls within the server connection.

Syntax

public TSAPxRFCvServerConnectionGS = class(TSAPxRFCvCustomServerConnectionGS);

1.4.10.1.1.1 Methods

1.4.10.1.1.1.1 Constructor TSAPxRFCvServerConnectionGS.Create

Class

Class TSAPxRFCvServerConnectionGS ( see page 500)

Description

Creates a new TSAPxRFCvServerConnectionGS object.

Syntax


1.4.10.1.1.1.2 Destructor TSAPxRFCvServerConnectionGS.Destroy

Class


Description

Destroys the TSAPxRFCvServerConnectionGS instance.

Syntax


1.4.10.1.1.1.3 Method TSAPxRFCvServerConnectionGS.DoCheckTID

Class


Description

Procedure is called by Connect for SAP®, when a call to check TID is received from a SAP system. Procedure callsOnCheckTID ( see page 506) event handler.

ATID - Determines TID of checked transaction.

AResult - Indicates a check result.

Syntax

protected procedure DoCheckTID(Sender: TObject; const ATID: String; var AResult: TSAPxRFCCheckTIDResultGS);

1.4.10.1.1.1.4 Method TSAPxRFCvServerConnectionGS.DoCommit

Class


Description

Procedure is called by Connect for SAP®, when all RFC functions belonging to this transaction are done and the localtransaction can be completed. Procedure calls OnCommit ( see page 504) event handler.


489

1

ATID - Determines TID of committed transaction.

Syntax

protected procedure DoCommit(Sender: TObject; const ATID: String);

1.4.10.1.1.1.5 Method TSAPxRFCvServerConnectionGS.DoConfirm

Class


Description

Occurs when the local transaction is completed. You can use this event to delete all information about this TID.

Syntax

protected procedure DoConfirm(Sender: TObject; const ATID: String);

1.4.10.1.1.1.6 Method TSAPxRFCvServerConnectionGS.DoRollback

Class


Description

Procedure is called by Connect for SAP®, instead of the DoCommit ( see page 503) procedure, if there is an erroroccurring in the RFC library while processing the local transaction. Procedure calls OnRollback ( see page 504) eventhandler, if it is assigned.

ATID - Determines TID of rollbacked transaction.

Syntax

protected procedure DoRollback(Sender: TObject; const ATID: String);


1.4.10.1.1.2.1 Property TSAPxRFCvServerConnectionGS.Active

Class


Syntax


1.4.10.1.1.2.2 Property TSAPxRFCvServerConnectionGS.CommandLine

Class


Description

Contains SAP gateway connection information. Using it TSAPxRFCvServerConnectionGS ( see page 500) will registeritself as SAP server program with PROGID ( see page 140) program identifier.

Syntax

published property CommandLine: TSAPxRFCServerCommandLineGS;

1.4.10.1.1.2.3 Property TSAPxRFCvServerConnectionGS.DataFormat

Class



490

1

Description

Returns a reference to a data format object. The data format object controls how Delphi data types maps to the SAP RFCdata types.

Syntax


1.4.10.1.1.2.4 Property TSAPxRFCvServerConnectionGS.OnCommit

Class


Description

Occurs when a transaction is about to be committed. See TSAPxRFCServerConnectionGS.OnCommitEvent ( see page151) for details.

Syntax

published property OnCommit: TSAPxRFCTxCommitEventGS;

1.4.10.1.1.2.5 Property TSAPxRFCvServerConnectionGS.OnConfirm

Class


Description

Occurs when a transaction is completed (committed or rollbacked). See TSAPxRFCServerConnectionGS.OnConfirmEvent( see page 151) for details.

Syntax

published property OnConfirm: TSAPxRFCTxConfirmEventGS;

1.4.10.1.1.2.6 Property TSAPxRFCvServerConnectionGS.OnRollback

Class


Description

Occurs when a transaction is about to be rollbacked. See TSAPxRFCServerConnectionGS.OnRollbackEvent ( see page151) for details.

Syntax

published property OnRollback: TSAPxRFCTxRollbackEventGS;

1.4.10.1.1.2.7 Property TSAPxRFCvServerConnectionGS.RfcConnection

Class


Description

Returns a reference to encapsulated RFC server connection object.

Syntax

public property RfcConnection: TSAPxRFCServerConnectionGS;

1.4.10.1.1.2.8 Property TSAPxRFCvServerConnectionGS.Thread

Class



491

1

Description

Returns a reference to a thread, handling all client's request's to this connection. SeeTSAPxRFCServerConnectionGS.Thread ( see page 152) for details.

Syntax

public property Thread: TSAPxRFCSrvConnectionThreadGS;

1.4.10.1.1.2.9 Property TSAPxRFCvServerConnectionGS.WaitCursor

Class


Description

Specifies the mouse pointer cursor. It will be used when connection enters busy state.

Syntax

published property WaitCursor;

1.4.10.1.1.3 Events

1.4.10.1.1.3.1 Event TSAPxRFCvServerConnectionGS.AfterConnect

Class


Description

Event occurs right after a connection is established.

Syntax

published property AfterConnect;

1.4.10.1.1.3.2 Event TSAPxRFCvServerConnectionGS.AfterDisconnect

Class


Description

Event occurs right after the connection is closed.

Syntax

published property AfterDisconnect;

1.4.10.1.1.3.3 Event TSAPxRFCvServerConnectionGS.BeforeConnect

Class


Description

Event occurs immediately before establishing a connection.

Syntax

published property BeforeConnect;

1.4.10.1.1.3.4 Event TSAPxRFCvServerConnectionGS.BeforeDisconnect

Class



492

1

Description

Event occurs immediately before the connection will be closed.

Syntax

published property BeforeDisconnect;

1.4.10.1.1.3.5 Event TSAPxRFCvServerConnectionGS.OnCheckTID

Class


Description

The event occurs when a transaction is about to be started by SAP server and its TID will be checked. SeeTSAPxRFCServerConnectionGS.OnCheckTIDEvent ( see page 151) for details.

Syntax

published property OnCheckTID: TSAPxRFCTxCheckTIDEventGS;

1.4.10.1.1.3.6 Event TSAPxRFCvServerConnectionGS.OnEnterBusy

Class


Description

Event occurs when a connection enters busy state.

Syntax

published property OnEnterBusy;

1.4.10.1.1.3.7 Event TSAPxRFCvServerConnectionGS.OnError

Class


Description

Event occurs, if during an action, initiated by TSAPxRFCvServerFunctionGS ( see page 507) linked with this connection,an error is happened. The exception object will be assigned to E parameter.

Syntax

published property OnError;

1.4.10.1.1.3.8 Event TSAPxRFCvServerConnectionGS.OnExitBusy

Class


Description

Occurs when a connection leaves busy state.

Syntax

published property OnExitBusy;

1.4.10.1.1.3.9 Event TSAPxRFCvServerConnectionGS.OnIdle

Class


Description

Occurs while a connection is open and is in idle state. See TSAPxRFCCustomConnectionGS.OnIdleEvent ( see page 250)for details.


493

1

Syntax

published property OnIdle;

1.4.10.1.2 Class TSAPxRFCvServerFunctionGS Events







Unit

Unit gsSAPxRFCvServer ( see page 500)

Legend

Constructor

All Members

Methods









Properties








RfcServerFunction ( see page 513)


Events








494

1

Methods









Properties








RfcServerFunction ( see page 513)


File

gsSAPxRFCvServer

Description

TSAPxRFCvServerFunctionGS component encapsulates a server function object - TSAPxRFCServerFunctionGS ( seepage 155). See it description for details, because most of component methods and properties directly corresponds toTSAPxRFCServerFunctionGS ( see page 155) ones. Use this component if you need to implement function to be callableas RFC function module.

Property Connection ( see page 511) links function module to server program. Property ObjName ( see page 512)identifies function module for ABAP/4. Assign OnExecute ( see page 514) event handler and implement function moduleinside the handler. InParameters ( see page 512) receives input parameters during function module execution. Outputparameters are placed in OutParameters ( see page 512) array. Tables ( see page 513) property allows to operate thefunction module tables.

Example

var FSFunction: TSAPxRFCvServerFunctionGS; ... procedure TInfoServer.InitFunction;begin with FSFunction do begin Connection := FSConnection; ObjName := 'MY_SERVER_FUNCTION'; OnExecute := ExecuteHandler; with OutParameters.AddParameter do begin Name := 'SUM'; DataType := RFCTYPE_FLOAT; end; end;


495

1

end; procedure TInfoServer.ExecuteHandler(AFunction: TSAPxRFCServerFunctionGS);var s: String; oTable: TSAPxRFCTableGS;begin s := AFunction.InParameters.ParameterByName('INPUT').AsString; oTable := AFunction.Tables.TableByName('DATA'); oTable.First; while not oTable.EOF do begin { do something with table data } oTable.Next; end; AFunction.OutParameters.ParameterByName('SUM').AsDouble := Calculate(s);end;

Syntax

public TSAPxRFCvServerFunctionGS = class(TSAPxRFCvCustomServerFunctionGS);

1.4.10.1.2.1 Methods

1.4.10.1.2.1.1 Constructor TSAPxRFCvServerFunctionGS.Create

Class

Class TSAPxRFCvServerFunctionGS ( see page 507)

Description

Creates a new TSAPxRFCvServerFunctionGS component.

Syntax


1.4.10.1.2.1.2 Destructor TSAPxRFCvServerFunctionGS.Destroy

Class


Description

Destroys the TSAPxRFCvServerFunctionGS component instance.

Syntax


1.4.10.1.2.1.3 Method TSAPxRFCvServerFunctionGS.DoAfterPrepare

Class


Description

Connect for SAP® software calls this procedure right after server function module is prepared. Procedure calls AfterPrepare( see page 513) event handler if it is assigned.

Syntax

protected procedure DoAfterPrepare(ASender: TObject); virtual;

1.4.10.1.2.1.4 Method TSAPxRFCvServerFunctionGS.DoAfterUnPrepare

Class


Description

Connect for SAP® software calls this procedure right after server function module is unprepared. Procedure calls


496

1

AfterUnprepare ( see page 513) event handler if it is assigned.

Syntax

protected procedure DoAfterUnPrepare(ASender: TObject); virtual;

1.4.10.1.2.1.5 Method TSAPxRFCvServerFunctionGS.DoBeforePrepare

Class


Description

Connect for SAP® software calls this procedure right before server function module will be prepared. Procedure callsBeforePrepare ( see page 513)event handler if it is assigned.

Syntax

protected procedure DoBeforePrepare(ASender: TObject); virtual;

1.4.10.1.2.1.6 Method TSAPxRFCvServerFunctionGS.DoBeforeUnPrepare

Class


Description

Connect for SAP® software calls this procedure right before server function module will be unprepared. Procedure callsBeforeUnprepare ( see page 514) event handler if it is assigned.

Syntax

protected procedure DoBeforeUnPrepare(ASender: TObject); virtual;

1.4.10.1.2.1.7 Method TSAPxRFCvServerFunctionGS.DoError

Class


Description

Connect for SAP® calls this procedure, if during an OnExecute ( see page 514) event handler execution, an error ishappened. DoError procedure calls OnError ( see page 514) event handler if it is assigned.

E - exception object.

AErrAction - action to be executed after return from procedure.

Syntax

protected procedure DoError(ASender: TObject; E: Exception; var AErrAction: TSAPxRFCErrorActionGS); virtual;

1.4.10.1.2.1.8 Method TSAPxRFCvServerFunctionGS.DoExecute

Class


Description

Connect for SAP® calls this procedure when a function module receives a client request. Procedure calls OnExecute ( seepage 514) event handler if it is assigned.

Syntax

protected procedure DoExecute(AFunction: TSAPxRFCServerFunctionGS); virtual;



497

1

1.4.10.1.2.2.1 Property TSAPxRFCvServerFunctionGS.Connection

Class


Description

Refers to a server connection component, representing a SAP server program.

Syntax

published property Connection: TSAPxRFCvServerConnectionGS;

1.4.10.1.2.2.2 Property TSAPxRFCvServerFunctionGS.DataFormat

Class


Description

Returns reference to data format object.

Syntax


1.4.10.1.2.2.3 Property TSAPxRFCvServerFunctionGS.Docu

Class


Description

Specifies a short function module description about its parameters and actions. The descriptions can be requested by callingthe standard function module RFC_DOCU being available in every RFC server program.

Syntax

published property Docu: TStrings;

1.4.10.1.2.2.4 Property TSAPxRFCvServerFunctionGS.InParameters

Class


Description

Stores the input parameters (getting from client) of server function module. Programmer should fill the list before function willbe prepared. See also Prepare ( see page 512).

Syntax

public property InParameters: TSAPxRFCParametersListGS;

1.4.10.1.2.2.5 Property TSAPxRFCvServerFunctionGS.ObjName

Class


Description

Property identifies server function module for ABAP/4. Changing property value will unprepare function. See Prepared (see page 512) also.

Syntax

published property ObjName: string;


498

1

1.4.10.1.2.2.6 Property TSAPxRFCvServerFunctionGS.OutParameters

Class


Description

Stores the output parameters (returning to client) of server function module. Programmer should fill the list before functionwill be prepared. See also Prepare ( see page 512).

Syntax

public property OutParameters: TSAPxRFCParametersListGS;

1.4.10.1.2.2.7 Property TSAPxRFCvServerFunctionGS.Prepared

Class


Description

Property controls whether or not function module will receive client requests and handle them. Setting property value toTrue, Connect for SAP® will install function module as part of SAP server program. And will specify to SAP RFC Docu (see page 512) function description. Setting property value to False, Connect for SAP® uninstalls function module.

Syntax

published property Prepared: Boolean;

1.4.10.1.2.2.8 Property TSAPxRFCvServerFunctionGS.RfcServerFunction

Class


Description

References to encapsulated server function object.

Syntax

public property RfcServerFunction: TSAPxRFCServerFunctionGS;

1.4.10.1.2.2.9 Property TSAPxRFCvServerFunctionGS.Tables

Class


Description

Stores the server function module table list.

Syntax


1.4.10.1.2.3 Events

1.4.10.1.2.3.1 Event TSAPxRFCvServerFunctionGS.AfterPrepare

Class


Description

Event occurs after a server function module is prepared.

Syntax

published property AfterPrepare: TNotifyEvent;


499

1

1.4.10.1.2.3.2 Event TSAPxRFCvServerFunctionGS.AfterUnPrepare

Class


Description

Event occurs after a server function module is unprepared.

Syntax

published property AfterUnPrepare: TNotifyEvent;

1.4.10.1.2.3.3 Event TSAPxRFCvServerFunctionGS.BeforePrepare

Class


Description

Event occurs before a server function module will be prepared.

Syntax

published property BeforePrepare: TNotifyEvent;

1.4.10.1.2.3.4 Event TSAPxRFCvServerFunctionGS.BeforeUnPrepare

Class


Description

Event occurs before a server function module will be unprepared.

Syntax

published property BeforeUnPrepare: TNotifyEvent;

1.4.10.1.2.3.5 Event TSAPxRFCvServerFunctionGS.OnError

Class


Description

Event occurs, if during an OnExecute ( see page 514) event handler execution, an error is happened.

Syntax


1.4.10.1.2.3.6 Event TSAPxRFCvServerFunctionGS.OnExecute

Class


Description

Event occurs when a function module receives a client request. Assign handler to this event to provide the server functionmodule execution.

Syntax

published property OnExecute: TSAPxRFCServerFunctionExecuteEventGS;

1.4 Units Connect for SAP ® Unit gsSAPxRFCvStdObj

500

1

1.4.11 Unit gsSAPxRFCvStdObj

Classes

TSAPxMulticastActiveChangeEventGS ( see page 515)

TSAPxRFCvCustomConnectionGS ( see page 516)

TSAPxRFCvCustomObjectGS ( see page 523)

Group


Types

TSAPxRFCActiveChangeEventGS ( see page 523)

Description

Unit gsSAPxRFCvStdObj contains a set of internal base classes for both client and server components.

1.4.11.1 Classes

1.4.11.1.1 Class TSAPxMulticastActiveChangeEventGS Unit

Unit gsSAPxRFCvStdObj ( see page 514)

All Members

Methods

Add ( see page 407)




Class TSAPxMulticastActiveChangeEventGS

Add ( see page 516)



Properties



Methods

Add ( see page 407)





501

1

Class TSAPxMulticastActiveChangeEventGS

Add ( see page 516)



Properties



File

gsSAPxRFCvStdObj

Syntax

public TSAPxMulticastActiveChangeEventGS = class(TSAPxMulticastEventBaseGS);

1.4.11.1.1.1 Methods

1.4.11.1.1.1.1 Method TSAPxMulticastActiveChangeEventGS.Add

Class

Class TSAPxMulticastActiveChangeEventGS ( see page 515)

Syntax

public procedure Add(AHandler: TSAPxRFCActiveChangeEventGS);

1.4.11.1.1.1.2 Method TSAPxMulticastActiveChangeEventGS.Call

Class


Syntax

public procedure Call(Sender: TObject; Active: Boolean);

1.4.11.1.1.1.3 Method TSAPxMulticastActiveChangeEventGS.Remove

Class


Syntax

public procedure Remove(AHandler: TSAPxRFCActiveChangeEventGS);

1.4.11.1.2 Class TSAPxRFCvCustomConnectionGS Events









Unit



502

1

Legend

Constructor

All Members

Methods


















Properties




Events









Methods





503

1















Properties




File

gsSAPxRFCvStdObj

Description

The class is a base class for all Connect for SAP® connection component classes. It is rather an internal class.

Syntax

public TSAPxRFCvCustomConnectionGS = class(TComponent);

1.4.11.1.2.1 Methods

1.4.11.1.2.1.1 Method TSAPxRFCvCustomConnectionGS.AllowStartProgram

Class

Class TSAPxRFCvCustomConnectionGS ( see page 516)

Description

Specifies the external programs that the RFC client library can start, if required by an RFC partner. For example, if you areinvoking an RFC that internally invokes a program on the computer running the adapter client, you must specify the name ofthat program for this binding property.

If you are specifying multiple programs for this binding property, they must be separated by a semi-colon. For example, ifyou want to specify the sapftp and saphttp programs, you must specify them as sapftp;saphttp.


504

1

Also, make sure the following conditions are met:

• The external program required by the RFC is available on the computer running the adapter client.

• The location of the external program is present in the PATH variable on the computer running the adapter client.

For example, BAPI_DOCUMENT_CHECKOUTVIEW2 internally executes a program, sapftp. So, while invoking this RFC,you have to call the AllowStartProgram with APrograms parameter set to sapftp. You also have to ensure that the sapftpprogram is available locally, and the location of the sapftp program is added to the PATH variable on the computer runningthe client.

Syntax

public procedure AllowStartProgram(const APrograms: array of String);

1.4.11.1.2.1.2 Method TSAPxRFCvCustomConnectionGS.ApplyOldConnected

Class


Syntax

protected procedure ApplyOldConnected(AValue: Boolean); virtual;

1.4.11.1.2.1.3 Constructor TSAPxRFCvCustomConnectionGS.Create

Class


Syntax


1.4.11.1.2.1.4 Method TSAPxRFCvCustomConnectionGS.DefineProperties

Class


Syntax

protected procedure DefineProperties(AFiler: TFiler); override;

1.4.11.1.2.1.5 Destructor TSAPxRFCvCustomConnectionGS.Destroy

Class


Syntax


1.4.11.1.2.1.6 Method TSAPxRFCvCustomConnectionGS.DoRfcConnectionAfterConnect

Class


Syntax

protected procedure DoRfcConnectionAfterConnect(ASender: TObject);

1.4.11.1.2.1.7 Method TSAPxRFCvCustomConnectionGS.DoRfcConnectionAfterDisconnect

Class


Syntax

protected procedure DoRfcConnectionAfterDisconnect(ASender: TObject);


505

1

1.4.11.1.2.1.8 Method TSAPxRFCvCustomConnectionGS.DoRfcConnectionBeforeConnect

Class


Syntax

protected procedure DoRfcConnectionBeforeConnect(ASender: TObject);

1.4.11.1.2.1.9 Method TSAPxRFCvCustomConnectionGS.DoRfcConnectionBeforeDisconnect

Class


Syntax

protected procedure DoRfcConnectionBeforeDisconnect(ASender: TObject);

1.4.11.1.2.1.10 Method TSAPxRFCvCustomConnectionGS.DoRfcConnectionEnterBusy

Class


Syntax

protected procedure DoRfcConnectionEnterBusy(ASender: TObject); virtual;

1.4.11.1.2.1.11 Method TSAPxRFCvCustomConnectionGS.DoRfcConnectionError

Class


Syntax

protected procedure DoRfcConnectionError(ASender: TObject; E: Exception; var AErrAction: TSAPxRFCErrorActionGS); virtual;

1.4.11.1.2.1.12 Method TSAPxRFCvCustomConnectionGS.DoRfcConnectionExitBusy

Class


Syntax

protected procedure DoRfcConnectionExitBusy(ASender: TObject); virtual;

1.4.11.1.2.1.13 Method TSAPxRFCvCustomConnectionGS.DoRfcConnectionIdle

Class


Syntax

protected procedure DoRfcConnectionIdle(ASender: TObject); virtual;

1.4.11.1.2.1.14 Method TSAPxRFCvCustomConnectionGS.GetRfcConnectionClass

Class


Syntax

protected class function GetRfcConnectionClass: TSAPxRFCCustomConnectionClassGS; virtual;

1.4.11.1.2.1.15 Method TSAPxRFCvCustomConnectionGS.NotifyActiveChange

Class



506

1

Syntax

protected procedure NotifyActiveChange(AActive: Boolean);

1.4.11.1.2.1.16 Method TSAPxRFCvCustomConnectionGS.RegisterActiveChangeHandler

Class


Description

Registers the callback for getting a notification when Active flag of the connection is changed.

See UnregisterActiveChangeHandler ( see page 521).

Syntax

protected procedure RegisterActiveChangeHandler(AHandler: TSAPxRFCActiveChangeEventGS);

1.4.11.1.2.1.17 Method TSAPxRFCvCustomConnectionGS.UnregisterActiveChangeHandler

Class


Description

Unregisters the callback for getting a notification when Active flag of the connection is changed.

See RegisterActiveChangeHandler ( see page 521).

Syntax

protected procedure UnregisterActiveChangeHandler(AHandler: TSAPxRFCActiveChangeEventGS);


1.4.11.1.2.2.1 Property TSAPxRFCvCustomConnectionGS.Active

Class


Description

Property indicates if the connection is established.

Syntax

protected property Active: Boolean;

1.4.11.1.2.2.2 Property TSAPxRFCvCustomConnectionGS.RfcConnection

Class


Description

References to encapsulated connection object.

Syntax

protected property RfcConnection: TSAPxRFCCustomConnectionGS;

1.4.11.1.2.2.3 Property TSAPxRFCvCustomConnectionGS.WaitCursor

Class


Description

Specifies a cursor that will be assign to the mouse while the connection is in busy state.


507

1

Syntax

protected property WaitCursor: TCursor;

1.4.11.1.2.3 Events

1.4.11.1.2.3.1 Event TSAPxRFCvCustomConnectionGS.OnEnterBusy

Class


Description

The event is a delegate of the OnEnterBusyEvent ( see page 249) event.

Syntax

protected property OnEnterBusy: TNotifyEvent;

1.4.11.1.2.3.2 Event TSAPxRFCvCustomConnectionGS.AfterConnect

Class


Syntax

protected property AfterConnect: TNotifyEvent;

1.4.11.1.2.3.3 Event TSAPxRFCvCustomConnectionGS.OnExitBusy

Class


Description

The event is a delegate of the OnExitBusyEvent ( see page 250) event.

Syntax

protected property OnExitBusy: TNotifyEvent;

1.4.11.1.2.3.4 Event TSAPxRFCvCustomConnectionGS.AfterDisconnect

Class


Syntax

protected property AfterDisconnect: TNotifyEvent;

1.4.11.1.2.3.5 Event TSAPxRFCvCustomConnectionGS.OnError

Class


Description

The event is a delegate of the OnErrorEvent ( see page 250) event.

Syntax

protected property OnError: TSAPxRFCErrorEventGS;

1.4.11.1.2.3.6 Event TSAPxRFCvCustomConnectionGS.BeforeConnect

Class



508

1

Syntax

protected property BeforeConnect: TNotifyEvent;

1.4.11.1.2.3.7 Event TSAPxRFCvCustomConnectionGS.OnIdle

Class


Description

The event is a delegate of the OnIdleEvent ( see page 250) event.

Syntax

protected property OnIdle: TNotifyEvent;

1.4.11.1.2.3.8 Event TSAPxRFCvCustomConnectionGS.BeforeDisconnect

Class


Syntax

protected property BeforeDisconnect: TNotifyEvent;

1.4.11.1.3 Class TSAPxRFCvCustomObjectGS Unit


File

gsSAPxRFCvStdObj

Description

The class is a base class for some of Connect for SAP® component classes. It is rather an internal class.

Syntax

public TSAPxRFCvCustomObjectGS = class(TComponent);

1.4.11.2 Types

1.4.11.2.1 Type TSAPxRFCActiveChangeEventGS Unit


File

gsSAPxRFCvStdObj

Syntax

TSAPxRFCActiveChangeEventGS = procedure (Sender: TObject; Active: Boolean) of object;

1.5 Examples

1.5 Examples Connect for SAP ® Client transactional management

509

1

1.5.1 Client transactional management

Example

var TID: String; Connection: TSAPxRFCvClientConnectionGS; Function: TSAPxRFCvFunctionGS; procedure Main;begin ... Function.Connection := Connection; with Connection do begin with Params do begin CLIENT := '100'; USER := 'user_name'; LANG := 'en'; ASHOST := 'myserver.mydomain.com'; SYSNR := '00'; end; Connected := True; try if TID = '' then StartTransaction else RestoreTransaction(TID); finally Connected := False; end; end; ...end; procedure StartTransaction;begin Connection.StartTransaction; try TID := Connection.RFCConnection.TID; Function.ExecFunction; { some transaction actions }; finally Connection.EndTransaction; TID := ''; end;end; procedure ReStartTransaction;begin Connection.RestoreTransaction(FTID); try Function.ExecFunction; { some transaction actions }; finally Connection.EndTransaction; TID := ''; end;end;

1.5 Examples Connect for SAP ® Client transactional management

510

1

Index

___RFCTYPE_max_value_v4 Constant 68

__RFCTYPE_max_value_v6 Constant 69

_AddRef 305

TSAPxRFCFunctionGS Class 305

_Release 305


_RFCTYPE_differ_from_abap Constant 69

_RFCTYPE_illegal_wchar Constant 69

_RFCTYPE_max_value Variable 57

_RFCTYPE_the_last_line_without_colon Constant 69

AABAP_DEBUG 91

TSAPxRFCAliasGS Class 91

Abort 147

TSAPxRFCServerConnectionGS Class 147

AbortMessage 150


About Connect for SAP® 1

Active 107, 113, 127, 247, 362, 430, 463, 481, 492, 504, 521

TSAPxRFCClientConnectionGS Class 107

TSAPxRFCCustomAliasListGS Class 113

TSAPxRFCCustomConnectionGS Class 247

TSAPxRFCEasyDataMoveGS Class 127

TSAPxRFCTableGS Class 362

TSAPxRFCvClientConnectionGS Class 430

TSAPxRFCvCustomConnectionGS Class 521

TSAPxRFCvParamsGS Class 463

TSAPxRFCvServerConnectionGS Class 504

TSAPxRFCvServerTableGS Class 481

TSAPxRFCvTableGS Class 492

ActualBytesPerChar 254

TSAPxRFCDataFormatGS Class 254

ActualFloatType 254


ActualIntType 255


ActualReadTable 255


Add 110, 153, 163, 166, 222, 318, 338, 347, 407, 409, 516

TSAPxMulticastActiveChangeEventGS Class 516

TSAPxMulticastCheckTIDEventGS Class 163

TSAPxMulticastErrorEventGS Class 222

TSAPxMulticastEventBaseGS Class 407

TSAPxMulticastNotifyEventGS Class 409

TSAPxMulticastTIDEventGS Class 166


TSAPxRFCObjectsListGS Class 318

TSAPxRFCParametersListGS Class 338

TSAPxRFCServerConnectionListGS Class 153

TSAPxRFCStructureCacheGS Class 347

AddElement 379

TSAPxRFCTypeElementsListGS Class 379

AddField 296

TSAPxRFCFieldsListGS Class 296

AddFieldDesc 437, 460

TSAPxRFCvCustomTableGS Class 437


AddFieldEx 296


AddObject 242, 319



AddObjectEx 319


AddParameter 338


AddParameterEx 338


AddTable 368

TSAPxRFCTablesListGS Class 368

AddTableEx 368


AdjustIntLength 252


AfterCall 473

TSAPxRFCvRemoteObjectGS Class 473

AfterCallEvent 344

TSAPxRFCRemoteObjectGS Class 344

AfterCancel 464, 483, 492


a




AfterClose 464, 483, 493




AfterConnect 431, 505, 522




AfterConnectEvent 247


AfterDelete 484, 493



AfterDisconnect 431, 505, 522




AfterDisconnectEvent 247


AfterEdit 464, 484, 493




AfterInsert 484, 493



AfterOpen 464, 484, 493




AfterPost 464, 484, 493




AfterPrepare 473, 513


TSAPxRFCvServerFunctionGS Class 513

AfterPrepareEvent 227

TSAPxRFCConnectedObjectGS Class 227

AfterRefresh 465, 484, 493




AfterScroll 484, 494



AfterUnPrepare 473, 513



AfterUnprepareEvent 228


AliasByName 110


Aliases 113


AliasFileName 107, 430



AliasName 108, 430



AllocateTable 438, 460, 480, 491





AllocRecordBuffer 438


AllowStartProgram 242, 518



Append 356, 411

TSAPxRFCStringBuilderGS Class 411


ApplyOldConnected 429, 519



Argv 139

TSAPxRFCServerCommandLineGS Class 139

ArrangeOffsets 374

TSAPxRFCTypeElementGS Class 374


b

AsBCD 288, 330, 383

TSAPxRFCFieldGS Class 288

TSAPxRFCParameterGS Class 330

TSAPxRFCValueAdapterGS Class 383

AsByte 288, 330, 384




AsBytes 288, 331, 384




AsDate 289, 331, 384




AsDouble 289, 331, 384




ASHOST 91


AsInteger 289, 331, 384




AsNumber 289, 331, 385




Assign 89, 138, 252, 259, 286, 319, 328



TSAPxRFCDataObjectGS Class 259





AssignedValues 255


AssignValue 382


AsString 289, 332, 385




AsStruct 290, 332, 385




AsTime 290, 332, 385




AsVarBytes 290, 332, 385




AsVariant 290, 332, 385




AsVarString 290, 333, 386




AsWord 291, 333, 386




AsXMLString 291, 333, 386




Async 344, 471



Attributes 247


AutoCalcFields 463, 481, 492





c

BBeforeCall 473


BeforeCallEvent 345


BeforeCancel 465, 484, 494




BeforeClose 465, 485, 494




BeforeConnect 432, 506, 522




BeforeConnectEvent 247


BeforeDelete 485, 494



BeforeDisconnect 432, 506, 523




BeforeDisconnectEvent 248


BeforeEdit 465, 485, 494




BeforeInsert 485, 494



BeforeOpen 465, 485, 494




BeforePost 465, 485, 494




BeforePrepare 473, 513



BeforePrepareEvent 228


BeforeRefresh 465, 485, 495




BeforeScroll 486, 495



BeforeUnPrepare 473, 514



BeforeUnprepareEvent 228


BeginCall 103


BeginEvent 167

TSAPxRFCEventCounterGS Class 167

Bof 362


BookmarkValid 438


Busy 248, 345



BytesPerChar 255


CC_RFC_ERROR_APPLICATION_EXCEPTION Constant 70

C_RFC_ERROR_BUSY Constant 70

C_RFC_ERROR_CANCELLED Constant 70

C_RFC_ERROR_COMMUNICATION Constant 70

C_RFC_ERROR_INTERNAL Constant 70

C_RFC_ERROR_LOGON_FAILURE Constant 71

C_RFC_ERROR_PROGRAM Constant 71

C_RFC_ERROR_PROTOCOL Constant 71


d

C_RFC_ERROR_RESOURCE Constant 71

C_RFC_ERROR_SYSTEM_FAILURE Constant 71

C_SAPxRFC_V46 Constant 72








C_SAPxVersion Constant 421

C_TRFC_CANCEL Constant 74

C_TRFC_INTERNAL_ERROR Constant 74

C_TRFC_OK Constant 74

Call 163, 167, 222, 409, 516






CallType 309, 454


TSAPxRFCvFunctionGS Class 454

Cancel 111, 356



CanPause 133

TSAPxRFCServerApplicationGS Class 133

CanResume 133


CanStart 133


CanStop 134


Capacity 412


CharacterSize 291, 333, 375, 386





CheckActive 125, 242



CheckConnected 225


CheckDefinition 158, 286, 296, 305, 312, 319, 328, 357, 374




TSAPxRFCListObjectGS Class 312



TSAPxRFCServerFunctionGS Class 158



CheckInactive 125, 242



CheckNotPrepared 225


CheckPrepared 225


CheckTransActive 104


CheckTransInactive 104


Clear 89, 320, 411




ClearCalcFields 438


Client 231

TSAPxRFCConnectionAttributesGS Class 231

CLIENT 91


Client application architecture 8

Client transactional management 524

Close 105, 111, 125, 242, 357






e


CloseBlob 438


CODEPAGE 91


CommandLine 150, 504



CompareBookmarks 439


Component's description 3

ConnectedObjectByName 243


Connection 159, 228, 472, 481, 511






ConnectionCount 136


Connections 136


ConnectionString 91


CopyRecord 357


Count 113, 154, 323, 408





CPICConvID 231


Create 89, 105, 111, 126, 133, 147, 153, 158, 161, 168, 178, 182, 186, 191, 195, 199, 204, 209, 214, 226, 231, 243, 253, 259, 264, 286, 305, 320, 329, 343, 347, 350, 357, 374, 382, 411, 423, 429, 439, 460, 468, 480, 502, 510, 519










TSAPxRFCEnvironmentGS Class 264




TSAPxRFCFunctionSearchGS Class 178

TSAPxRFCGetFunctionInterfaceGS Class 182

TSAPxRFCGetFunctionInterfaceUSGS Class 186

TSAPxRFCGetStructureDefinitionGS Class 191

TSAPxRFCGetUnicodeStructureGS Class 195

TSAPxRFCGroupSearchGS Class 199



TSAPxRFCReadTableGS Class 204






TSAPxRFCSIStrGS Class 209

TSAPxRFCSrvConnectionThreadGS Class 161



TSAPxRFCStructureCacheItemGS Class 350

TSAPxRFCSystemInfoGS Class 214




TSAPxRFCvBlobStreamGS Class 423









CreateAliasStorage 106



f

CreateArgv 138


CreateBlobStream 439


CreateField 374


CreateGetStructureFunction 173

TSAPxRFCFunctionFactoryGS Class 173

CreateRegIni 111, 116, 118


TSAPxRFCFileAliasListGS Class 116

TSAPxRFCRegistryAliasListGS Class 118

CreateStandalone 357


CreateWithCode 220

ESAPxRFCNativeExceptionGS Class 220

CreateWithID 219

ESAPxRFCCustomExceptionGS Class 219

CSAPxRFCMaxNonFlatSize Constant 403

CSAPXRFCReadTabWASize Constant 214

DDataConvert 439


DataFormat 92, 150, 316, 386, 472, 482, 504, 511


TSAPxRFCObjectGS Class 316







DataLength 333


DataPtr 334


DataSize 291, 334, 351, 375, 387






DataType 292, 334, 376, 387





Decimals 292, 334, 376, 387





DecObjects 264


DefineParam 306


DefineProperties 519


DefineStructure 348


DefineTable 306


Delete 112, 320, 357




Description 313


DEST 92


Destination 232


Destroy 90, 106, 112, 126, 133, 139, 147, 154, 158, 161, 168, 226, 243, 265, 286, 306, 320, 329, 343, 348, 350, 358, 374, 382, 411, 424, 440, 461, 469, 481, 502, 510, 519











g

























DetectedBytesPerChar 248


DetectedFloatType 248


DetectedIntType 249


DisconnectObjects 243


DoAfterCall 469


DoAfterPrepare 469, 510



DoAfterUnPrepare 469, 510



DoBeforeCall 469


DoBeforeDelete 461


DoBeforeInsert 461


DoBeforePrepare 470, 510



DoBeforeUnPrepare 470, 511



DoChanged 253


DoChanging 253


DoCheckTID 148, 502



DoCommit 148, 503



DoConfirm 148, 503



Docu 159, 512



DoDetectActualDataFormat 106, 243



DoEnterBusy 244


DoError 226, 244, 470, 511





DoExecute 158, 511



DoExitBusy 244


DoGetData 382


h


DoIdle 244, 343, 470




DoRfcConnectionAfterConnect 519


DoRfcConnectionAfterDisconnect 519


DoRfcConnectionBeforeConnect 520


DoRfcConnectionBeforeDisconnect 520


DoRfcConnectionEnterBusy 520


DoRfcConnectionError 520


DoRfcConnectionExitBusy 520


DoRfcConnectionIdle 520


DoRollback 148, 503



DoSetData 383


EEarly and late function binding 7

Edit 358


Elements 351, 380



EndCall 104


EndEvent 168


EndTransaction 105, 429



EnterBusyState 245, 344



Eof 363


Erase 286, 296, 329, 339, 358, 368, 383








ErrorInfo 249



CreateWithID 219

ID 219

ESAPxRFCExceptionGS Class 21


CreateWithCode 220

RFCCode 221

ExecFunction 306, 453



Execute 161


ExID 376


ExID2TypeHandle 265


ExitBusyState 245, 344



ExternalRecordBuffer 298


FFActive 240


FAttributes 241


FDefinitionState 343


i


FDetectedBytesPerChar 241


FDetectedFloatType 241


FDetectedIntType 241


FErrInfo 280

TSAPxRFCErrorInfoGS Class 280

FErrorInfo 241


FetchRow 358


FHandle 241


FieldByName 297, 358



FieldIdToField 440, 461



FieldIdToParam 461


Fields 298, 363



FieldsRfcDataSize 299


FileName 113


FindAlias 112


FindConnectedObject 245


FindElement 379


FindField 297, 359



FindInParameter 307


FindObject 320


FindOutParameter 307


FindParameter 339


FindServerFunction 149


FindStructure 348


FindTable 307, 368



First 359


FloatType 255


ForceDisconnect 245


FPrepared 225


FreeArgv 139


FreeRecordBuffer 440


FreeRfcData 297, 321



FreeTable 440, 462, 481, 491





frmSAPxRFCLoginGS Variable 14

FSAPxRFCDllFileName Variable 57

FSAPxRFCEnableUnload Variable 57

FSAPxRFCEnvironment Variable 403

FSAPxRFChDll Variable 57

FSAPxRFCInitialized Variable 58

FSAPxRFCLibVersion Variable 58

FSAPxRFCLock Variable 58

FSAPxRFCLoginCallBack Variable 403

FSAPxRFCTraceProc Variable 58


j

Func 448, 463, 492




GGetAliasList 429


GetAliasStorageClass 106


GetBookmarkData 440


GetBookmarkFlag 441


GetCanModify 441


GetCurrentRecord 441


GetDataFormat 106, 133, 149, 226, 312, 316, 359








GetErrorHandler 307, 312, 316




GetFieldData 441, 442

TSAPxRFCvCustomTableGS Class 441, 442

GetInfo 107


GetItemsForAction 154


GetItemsForState 154


GetName 287, 312, 329, 359, 374






GetObjectClass 297, 321, 339, 369, 379






GetObjectRfcDataSize 321


GetParentDataFormat 149, 226, 313, 316, 359






GetRecNo 442


GetRecord 442


GetRecordCount 442


GetRecordSize 443


GetRemoteObjectClass 453, 470



GetRfcConnectionClass 520


GetRfcData 259, 287, 298, 321, 329, 360, 375








GetRfcDataSize 259, 287, 298, 321, 330, 360, 375






k




Group 281


GROUP 92


gsfSAPxRFCLogin Unit 13

gsSAPxRFCBase Unit 14

gsSAPxRFCClient Unit 86

gsSAPxRFCDataMove Unit 121

gsSAPxRFCServer Unit 128

gsSAPxRFCStdFunc Unit 172

gsSAPxRFCStdObj Unit 215

gsSAPxRFCUtil Unit 405

gsSAPxRFCvClient Unit 422

gsSAPxRFCvServer Unit 500

gsSAPxRFCvStdObj Unit 514

GWHOST 92, 139



GWSERV 92, 139



HHandle 249


IID 219


IncObjects 265


IndexOf 322, 407



IniDest 140


InitBuffer 360


Initialize 231


InitializeFieldList 379


InitRecord 443


InParameterByName 308


InParameters 159, 512



InParams 309, 454



Insert 360


Install 350


Installing components 2

InternalAddRecord 443, 462



InternalCancel 443


InternalClose 107, 245, 443




InternalDelete 444


InternalEdit 444


InternalFirst 444


InternalForceDisconnect 107, 149, 246




InternalGotoBookmark 444


InternalHandleException 444


InternalInitFieldDefs 444


l


InternalInitRecord 445


InternalInsert 445


InternalLast 445


InternalOpen 445


InternalPost 445, 462



InternalPrepare 126, 159, 227, 308





InternalRefresh 446, 462



InternalSetToRecord 446


InternalUnprepare 126, 159, 227, 308





IntPtr Type 418

IntType 256


ISAPxInterfaceBaseGS Type 398

ISAPxRFCErrorHandlerGS Interface 388

OnError 389

IsCursorOpen 446, 462



IsEmpty 407


IsNull 292, 334, 387




ISOLanguage 232


IsPartnerOlder46D 232


IsSequenced 446


IsSuspended 162


IsTerminated 162


IsValueOwn 253


ITAB_H Type 31

ITAB_NULL Constant 74

itAppLine 265


itAppLine Variable 59

itCpyLine 266


itCpyLine Variable 59

itCreate 266


itCreate Variable 59

itDelete 266


itDelete Variable 59

itDelLine 266


itDelLine Variable 59

Items 154, 323, 349




itFill 267


itFill Variable 60

itFree Variable 60

itGetLine 267


itGetLine Variable 60

itGupLine 267



m

itGupLine Variable 60

itInsLine 268


itInsLine Variable 60

itLeng Variable 61

itPutLine Variable 61

KKernelRel 232


Key 281


LLANG 93


Language 232


Last 360


Length 412


List 314


ListDataChanged 322


ListDataChanging 298, 322



Loaded 429, 471



LoadParamValues 463


Locate 446


LocateRecord 447


LoginPrompt 108, 430



Lookup 447


LookupStructure 348


MMapBCD 254


MapBCDToType 256


Mapping RFC data types 5

Message 281


Methods 408


Modify 112


MSHOST 93


NName 93, 228, 314, 363





Names 114


Next 361


Notification 471


NotifyActiveChange 520


OObjectCount 249


ObjectDataChanged 313


ObjectDataChanging 287, 313




n

ObjectDefined 344


Objects 249


ObjectView 463


ObjName 472, 512



Offset 292, 376



OnCalcFields 466, 486, 495




OnChanged 96, 257



OnChanging 96, 257



OnCheckTID 506


OnCheckTIDEvent 151


OnCommit 504


OnCommitEvent 151


OnConfirm 504


OnConfirmEvent 151


OnDeleteError 486, 495



OnEditError 466, 486, 495




OnEnterBusy 432, 506, 522




OnEnterBusyEvent 249


OnError 308, 389, 432, 474, 506, 514, 522

ISAPxRFCErrorHandlerGS Interface 389







OnErrorEvent 229, 250



OnExecute 160, 514



OnExitBusy 432, 507, 522




OnExitBusyEvent 250


OnGetData 388


OnGetDataFormat 388


OnIdle 432, 474, 507, 523





OnIdleEvent 250, 345



OnLogin 109, 433



OnNewRecord 486, 495



o


OnPostError 466, 486, 495




OnRollback 504


OnRollbackEvent 151


OnSetData 388


Open 104, 113, 127, 149, 246, 361







OpenCursor 481


OriginalName 93


OriginalNames 114


OutParameterByName 308


OutParameters 160, 512



OutParams 309, 454



OverrideBy 90, 254



Overview 4

OwnCodePage 232


OwnCodepagePCS 233


Owner 323


OwnHost 233


OwnRel 233


OwnType 233


PParameterByName 339


Parameters 340


ParameterType 334


ParamKinds 464


Params 108, 431



ParentDataFormat 316


ParentFormat 256


PartnerCodepage 233


PartnerHost 234


PartnerRel 234


PartnerType 234


PASSWD 93


PasswordMode 93


PasswordState 234


PathDelim Constant 421

PathSep Constant 421

Pause 135


PBoolean Type 31, 418


p

PCS 235


Pos Function 412

Post 361


ppRfc_char_t Type 32

PRawByteString Type 418

PreallocRows 363


Prepare 227, 471



Prepared 229, 472, 512




PrepareObjects 246


pRFC_ATTRIBUTES Type 32

pRFC_BCD Type 32

pRFC_BYTE Type 32

pRFC_CHAR Type 32

pRfc_char_t Type 33

pRFC_DATE Type 33

pRFC_ENV Type 33

pRFC_ERROR_INFO_EX Type 33

pRFC_FLOAT Type 33

pRFC_INT Type 34

pRFC_INT1 Type 34

pRFC_INT2 Type 34

pRFC_IUNKNOWN Type 34

pRFC_NUM Type 34

pRFC_PARAMETER Type 35

pRFC_STRING Type 35

pRFC_STRUCT_TYPE_ID Type 35

pRFC_TABLE Type 35

pRFC_TIME Type 35

pRFC_TYPE_ELEMENT Type 36

pRFC_UNICODE Type 36

pRFC_UNICODE_TYPE_ELEMENT Type 36

pRFC_WCHAR Type 36

pRFC_WSTRING Type 36

pRFC_XMLDATA Type 37

pRFC_XSTRING Type 37

Prior 361


PROGID 140


ProgName 235


pSAP_RFC_STATISTIC Type 37

PUInt64 Type 419

QQueryInterface 308


RR3NAME 94


RawByteString Type 419

ReadCfgFileName 268


ReadFrom 90


ReadFromBuffer 259, 287, 330




ReadOnly 292, 299, 363, 387, 449, 464, 482, 492









ReadTable 256


Realloc 411


RealPartnerCodepage 235



q

RecNo 364


RecordCount 364


RecordSize 364


Refresh 322, 362



RegisterActiveChangeHandler 521


ReleaseTable 447


RemoteObject 449


Remove 154, 163, 167, 222, 322, 408, 409, 516









RemoveObject 246


Requirements 2

RestoreDefaults 254


RestoreTransaction 105, 430



ResultAlias 108


Resume 134


RFC function architecture 4

RFC_ALLOCATE Type 37

RFC_ATTRIBUTES Record 22

RFC_BCD Type 37

RFC_BYTE Type 38

rfc_byte_t Type 38

RFC_CANCEL_CLOSE Constant 74

RFC_CANCEL_HARD Constant 75

RFC_CANCEL_SOFT Constant 75

RFC_CANCEL_TYPE Type 38

RFC_CHAR Type 38

rfc_char_t Type 39

RFC_CONV_ID_LN Constant 75

RFC_DATE Type 39

RFC_ENV Record 24

RFC_ERROR_GROUP Type 39

RFC_ERROR_HANDLER Type 39

RFC_ERROR_INFO_EX Record 24

RFC_FLOAT Type 39

RFC_FUNCTIONNAME Type 40

RFC_FUNCTIONNAME_LN Constant 75

RFC_FUNCTIONNAMEArr Type 40

RFC_HANDLE Type 40

RFC_HANDLE_NULL Constant 76

RFC_INT Type 40

RFC_INT1 Type 41

RFC_INT2 Type 41

RFC_ITMODE Enumeration 24

RFC_IUNKNOWN Type 41

RFC_NUM Type 41

RFC_ON_CHECK_TID Type 42

RFC_ON_CHECK_TID_EX Type 42

RFC_ON_COMMIT Type 42

RFC_ON_COMMIT_EX Type 42

RFC_ON_CONFIRM_TID Type 42

RFC_ON_CONFIRM_TID_EX Type 43

RFC_ON_ROLLBACK Type 43

RFC_ON_ROLLBACK_EX Type 43

RFC_ONCALL Type 43

RFC_PARAMETER Record 25

RFC_RC Enumeration 26

RFC_ROLE_Client Constant 76

RFC_ROLE_SERVER Constant 76

RFC_SERVER_EXT Constant 76

RFC_SERVER_EXT_REG Constant 76

RFC_SERVER_R2 Constant 77

RFC_SERVER_R3 Constant 77

RFC_STRING Type 43


r

RFC_STRING_MAX_LEN Constant 77

RFC_STRUCT_TYPE_ID Type 44

RFC_TABLE Record 28

RFC_TID Type 44

RFC_TID_LN Constant 77

RFC_TIDArr Type 44

RFC_TIME Type 44

RFC_TRACE 94, 140



RFC_TRACE_OFF Constant 77

RFC_TRACE_ON Constant 78

RFC_TYPE_ELEMENT Record 29

RFC_TYPEHANDLE Type 44

RFC_UNICODE Type 45

rfc_unicode_t Type 45

RFC_UNICODE_TYPE_ELEMENT Record 29

RFC_WCHAR Type 45

RFC_WSTRING Type 45

RFC_XMLDATA Type 46

RFC_XSTRING Record 29

RfcAbort 268


RfcAbort Variable 61

RfcAccept 268


RfcAccept Variable 61

RfcAllocString 269


RfcAllocString Variable 61



RfcAllowStartProgram Variable 62

RfcCall 269


RfcCall Variable 62

RfcCallReceive 269


RfcCallReceive Variable 62

RfcCancel 270


RfcCancel Variable 62

RfcClose 270


RfcClose Variable 62

RFCCode 221




RfcConfirmTransID Variable 63

RfcConnection 431, 505, 521






RfcConvertBCDToChar Variable 63



RfcConvertCharToBCD Variable 63

RfcCreateTransID 271


RfcCreateTransID Variable 63

RfcData 260, 323



RfcDataSize 299, 324



RfcDispatch 271


RfcDispatch Variable 63

RfcDispatchExt 272


RFCEasyDataMove 482


RfcEnvironment Variable 64

RfcExidToRfcType Variable 64

RfcFreeString 272


RfcFreeString Variable 64

RFCFunction 454


RfcGetAttributes 272


s


RfcGetAttributes Variable 64

RfcGetData 273


RfcGetData Variable 64

RfcGetName 273


RfcGetName Variable 65



RfcIndirectCallEx Variable 65



RfcInstallFunction Variable 65



RfcInstallFunctionExt Variable 65



RfcInstallStructure Variable 65



RfcInstallTransactionControl Variable 66

RfcInstallTransactionControl2 Variable 66

RfcInstallTransactionControlEx 275


RfcLastErrorEx 275


RfcLastErrorEx Variable 66

RfcListen 276


RfcListen Variable 66

RfcOpenEx 276


RfcOpenEx Variable 66

RfcRaise 276


RfcRaise Variable 67

RfcRaiseTables 277


RfcRaiseTables Variable 67

RfcReceive 277


RfcReceive Variable 67

RFCRemoteObject 472


RfcResizeXString 277


RfcResizeXString Variable 67

RfcRole 235


RfcSendData 277


RfcSendData Variable 67

RfcServerFunction 513


RfcStatistic 278


RfcStatistic Variable 68

RFCTable 449


RFCTYPE Type 46

RFCTYPE_ABAP4OBJECT Constant 78

RFCTYPE_BCD Constant 78

RFCTYPE_BLOB Constant 78

RFCTYPE_BYTE Constant 79

RFCTYPE_CHAR Constant 79

RFCTYPE_CORBA_OBJECT Constant 79

RFCTYPE_DATE Constant 79

RFCTYPE_DATE_1 Constant 80

RFCTYPE_DATE_2 Constant 80

RFCTYPE_FLOAT Constant 80

RFCTYPE_INT Constant 80

RFCTYPE_INT1 Constant 81

RFCTYPE_INT2 Constant 81

RFCTYPE_ITAB Constant 81

RFCTYPE_IUNKNOWN Constant 81

RFCTYPE_NULL Constant 82

RFCTYPE_NUM Constant 82

RFCTYPE_PADDING Constant 82

RFCTYPE_SAPAUTOMATION Constant 82

RFCTYPE_STRING Constant 83

RFCTYPE_STRUCTURE Constant 83

RFCTYPE_STUB Constant 83


t

RFCTYPE_TIME Constant 83

RFCTYPE_UNICODE Constant 84

RFCTYPE_WCHAR Constant 84

RFCTYPE_WIDE_2 Constant 84

RFCTYPE_WIDE_4 Constant 84

RFCTYPE_WIRE_OBJECT Constant 85

RFCTYPE_WSTRING Constant 85

RFCTYPE_XMLDATA Constant 85

RFCTYPE_XSTRING Constant 85



RfcUninstallFunction Variable 68



RfcWaitForRequest Variable 68

RowCount 127, 482



RowSkips 127, 482



SSAP_RFC_STATISTIC Record 30

SAP_UTF8 Type 46

SAPTYPE 94


SAPxRFCAnsiToUtf8 Function 413

SAPxRFCCharInSet Function 413

SAPxRFCCurrToStr Function 413

SAPxRFCDataType2Str Function 389

SAPxRFCFinalize Function 389

SAPxRFCFloatToStr Function 413

SAPxRFCGetModuleName Function 413

SAPxRFCGetSAPRFCINIFileName Function 390

SAPxRFCGetTracing Function 390

SAPxRFCGetVersionInfo Function 414

SAPxRFCInitialize Function 390

SAPxRFCIsNumEmpty Function 414

SAPxRFCIsStructType Function 390

SAPxRFCIsTextNum Function 414

SAPxRFCLoadLib Function 21

SAPxRFCMemFill Function 414

SAPxRFCMemMove Function 414

SAPxRFCPadLeft Function 415

SAPxRFCParameterType2Str Function 391

SAPxRFCRaiseCustomException Function 391

SAPxRFCRaiseException Function 391

SAPxRFCRaiseNativeException Function 391

SAPxRFCReverseBytes Function 415

SAPxRFCServerApplication Function 168

SAPxRFCSetTracing Function 391, 392

SAPxRFCStrToAPIStr Function 416

SAPxRFCStrToCh Function 416

SAPxRFCToolVer Function 416

SAPxRFCTrimAll Function 416

SAPxRFCUnLoadLib Function 21

SAPxRFCUtf8Decode Function 417

SAPxRFCUtf8Encode Function 417

SAPxRFCUtf8ToAnsi Function 417

SAPxRFCWideStrLen Function 417

SAPxRFCWStrCopy Function 418

SaveParamValues 463


Select 127, 483



Server application architecture 10

ServerFunctionByName 150


SetBookmarkData 447


SetBookmarkFlag 448


SetFieldData 448


SetName 288, 313, 330, 362, 375






SetRecNo 448



u

SetSize 411


sLineBreak Constant 421

SNC_LIB 94, 140



SNC_MODE 94


SNC_MYNAME 95, 141



SNC_PARTNERNAME 95


SNC_QOP 95


SSAPxRFCCfgKeyName Constant 403

SSAPxRFCCfgValName Constant 404

SSAPxRFCDefCfgFileName Constant 404

SSAPxRFCDefCfgKeyName Constant 404

SSAPxRFCDefRootKey Constant 404

SSAPxRFCDefRootKeyOld Constant 405

Start 134


StartTransaction 105, 429



State 364


Stop 135


StructName 335, 351, 364




StructureCache 279


SubFields 335


Suspended 136


SYSNR 95


SystemID 235


SystemNumber 236


TTable 128


TableByName 309, 369



TableFormat 365


TableHandle 365


TableMode 365


TableName 483, 492



Tables 160, 309, 369, 454, 513






TableType 365


TBytes Type 419

Terminated 135


TfrmSAPxRFCLoginGS Class 13

Thread 152, 505



TID 108


TimeOut 136, 152



ToBuffer 412



v

ToString 412


TPHOST 95


TPNAME 95


Trace 236, 278, 370



TSAPxRFCTracingObjectGS Class 370

TraceEnter 370


TraceExit 370


Tracer 280


TransActive 109


TRecBuf Type 499

TRecordBuffer Type 499

Truncate 424


TryBeginCall 104



Add 516

Call 516

Remove 516


Add 163

Call 163

Remove 163

TSAPxMulticastCommitEventGS Class 163

TSAPxMulticastConfirmEventGS Class 164


Add 222

Call 222

Remove 222


Add 407

Count 408

IndexOf 407

IsEmpty 407

Methods 408

Remove 408


Add 409

Call 409

Remove 409

TSAPxMulticastRollbackEventGS Class 165


Add 166

Call 167

Remove 167

TSAPxNativeInt Type 419

TSAPxNativeUInt Type 419

TSAPxRFCAbortGS Type 46

TSAPxRFCAcceptGS Type 46

TSAPxRFCActiveChangeEventGS Type 523


ABAP_DEBUG 91

ASHOST 91

Assign 89

Clear 89

CLIENT 91

CODEPAGE 91

ConnectionString 91

Create 89

DataFormat 92

DEST 92

Destroy 90

GROUP 92

GWHOST 92

GWSERV 92

LANG 93

MSHOST 93

Name 93

OnChanged 96

OnChanging 96

OriginalName 93

OverrideBy 90

PASSWD 93

PasswordMode 93

R3NAME 94


w

ReadFrom 90

RFC_TRACE 94

SAPTYPE 94

SNC_LIB 94

SNC_MODE 94

SNC_MYNAME 95

SNC_PARTNERNAME 95

SNC_QOP 95

SYSNR 95

TPHOST 95

TPNAME 95

USE_SAPGUI 96

USER 96

WAN_CONN 96

WriteTo 90

TSAPxRFCAliasPasswordModeGS Enumeration 119

TSAPxRFCAllocStringGS Type 47

TSAPxRfcAllowStartProgram Type 47

TSAPxRFCBytesPerCharGS Enumeration 392

TSAPxRFCCallGS Type 47

TSAPxRFCCallReceiveGS Type 47

TSAPxRFCCancelGS Type 47

TSAPxRFCCheckTIDResultGS Enumeration 169


Active 107

AliasFileName 107

AliasName 108

BeginCall 103

CheckTransActive 104

CheckTransInactive 104

Close 105

Create 105

CreateAliasStorage 106

Destroy 106

DoDetectActualDataFormat 106

EndCall 104

EndTransaction 105

GetAliasStorageClass 106

GetDataFormat 106

GetInfo 107

InternalClose 107

InternalForceDisconnect 107

LoginPrompt 108

OnLogin 109

Open 104

Params 108

RestoreTransaction 105

ResultAlias 108

StartTransaction 105

TID 108

TransActive 109

TryBeginCall 104

TSAPxRFCCloseGS Type 48

TSAPxRFCConfirmTransIDGS Type 48

TSAPxRFCConnectedObjectClassGS Type 398


AfterPrepareEvent 227

AfterUnprepareEvent 228

BeforePrepareEvent 228

BeforeUnprepareEvent 228

CheckConnected 225

CheckNotPrepared 225

CheckPrepared 225

Connection 228

Create 226

Destroy 226

DoError 226

FPrepared 225

GetDataFormat 226

GetParentDataFormat 226

InternalPrepare 227

InternalUnprepare 227

Name 228

OnErrorEvent 229

Prepare 227

Prepared 229

Unprepare 227


Client 231

CPICConvID 231

Create 231

Destination 232

Initialize 231

ISOLanguage 232


x

IsPartnerOlder46D 232

KernelRel 232

Language 232

OwnCodePage 232

OwnCodepagePCS 233

OwnHost 233

OwnRel 233

OwnType 233

PartnerCodepage 233

PartnerHost 234

PartnerRel 234

PartnerType 234

PasswordState 234

PCS 235

ProgName 235

RealPartnerCodepage 235

RfcRole 235

SystemID 235

SystemNumber 236

Trace 236

User 236

TSAPxRFCConnectionLoginEventGS Type 120

TSAPxRFCConvertBCDToCharGS Type 48

TSAPxRFCConvertCharToBCDGS Type 48

TSAPxRFCCreateTransIDGS Type 48

TSAPxRFCCustomAliasListClassGS Type 120


Active 113

Add 110

AliasByName 110

Aliases 113

Cancel 111

Close 111

Count 113

Create 111

CreateRegIni 111

Delete 112

Destroy 112

FileName 113

FindAlias 112

Modify 112

Names 114

Open 113

OriginalNames 114

TSAPxRFCCustomConnectionClassGS Type 399


Active 247

AddObject 242

AfterConnectEvent 247

AfterDisconnectEvent 247

AllowStartProgram 242

Attributes 247

BeforeConnectEvent 247

BeforeDisconnectEvent 248

Busy 248

CheckActive 242

CheckInactive 242

Close 242

ConnectedObjectByName 243

Create 243

Destroy 243

DetectedBytesPerChar 248

DetectedFloatType 248

DetectedIntType 249

DisconnectObjects 243

DoDetectActualDataFormat 243

DoEnterBusy 244

DoError 244

DoExitBusy 244

DoIdle 244

EnterBusyState 245

ErrorInfo 249

ExitBusyState 245

FActive 240

FAttributes 241

FDetectedBytesPerChar 241

FDetectedFloatType 241

FDetectedIntType 241

FErrorInfo 241

FHandle 241

FindConnectedObject 245

ForceDisconnect 245

Handle 249

InternalClose 245


y


ObjectCount 249

Objects 249

OnEnterBusyEvent 249

OnErrorEvent 250

OnExitBusyEvent 250

OnIdleEvent 250

Open 246

PrepareObjects 246

RemoveObject 246

UnprepareObjects 246


ActualBytesPerChar 254

ActualFloatType 254

ActualIntType 255

ActualReadTable 255

AdjustIntLength 252

Assign 252

AssignedValues 255

BytesPerChar 255

Create 253

DoChanged 253

DoChanging 253

FloatType 255

IntType 256

IsValueOwn 253

MapBCD 254

MapBCDToType 256

OnChanged 257

OnChanging 257

OverrideBy 254

ParentFormat 256

ReadTable 256

RestoreDefaults 254

TSAPxRFCDataFormatValueGS Enumeration 392

TSAPxRFCDataFormatValuesGS Type 399


Assign 259

Create 259

GetRfcData 259

GetRfcDataSize 259

ReadFromBuffer 259

RfcData 260

WriteToBuffer 260

TSAPxRFCDataTypeGS Enumeration 393

TSAPxRFCDispatchGS Type 49


Active 127

CheckActive 125

CheckInactive 125

Close 125

Create 126

Destroy 126

InternalPrepare 126


Open 127

RowCount 127

RowSkips 127

Select 127

Table 128

Where 128

TSAPxRFCEnumGS Type 49

TSAPxRFCEnvironment_prcGS Type 49


Create 264

DecObjects 264

Destroy 265

ExID2TypeHandle 265

IncObjects 265

itAppLine 265

itCpyLine 266

itCreate 266

itDelete 266

itDelLine 266

itFill 267

itGetLine 267

itGupLine 267

itInsLine 268

ReadCfgFileName 268

RfcAbort 268

RfcAccept 268

RfcAllocString 269


RfcCall 269


z

RfcCallReceive 269

RfcCancel 270

RfcClose 270




RfcCreateTransID 271

RfcDispatch 271

RfcDispatchExt 272

RfcFreeString 272

RfcGetAttributes 272

RfcGetData 273

RfcGetName 273






RfcInstallTransactionControlEx 275

RfcLastErrorEx 275

RfcListen 276

RfcOpenEx 276

RfcRaise 276

RfcRaiseTables 277

RfcReceive 277

RfcResizeXString 277

RfcSendData 277

RfcStatistic 278



StructureCache 279

Trace 278

Tracer 280

TypeHandle2ExID 279

WriteCfgFileName 279

TSAPxRFCErrorActionGS Enumeration 394

TSAPxRFCErrorEventGS Type 399


FErrInfo 280

Group 281

Key 281

Message 281


BeginEvent 167

Create 168

Destroy 168

EndEvent 168

Wait 168

TSAPxRfcExidToRfcTypeGS Type 49

TSAPxRFCFieldClassGS Type 400


AsBCD 288

AsByte 288

AsBytes 288

AsDate 289

AsDouble 289

AsInteger 289

AsNumber 289

Assign 286

AsString 289

AsStruct 290

AsTime 290

AsVarBytes 290

AsVariant 290

AsVarString 290

AsWord 291

AsXMLString 291

CharacterSize 291

CheckDefinition 286

Create 286

DataSize 291

DataType 292

Decimals 292

Destroy 286

Erase 286

GetName 287

GetRfcData 287

GetRfcDataSize 287

IsNull 292

ObjectDataChanging 287

Offset 292

ReadFromBuffer 287

ReadOnly 292

SetName 288


aa

TypeHandle 293

WriteToBuffer 288


AddField 296

AddFieldEx 296

CheckDefinition 296

Erase 296

ExternalRecordBuffer 298

FieldByName 297

Fields 298

FieldsRfcDataSize 299

FindField 297

FreeRfcData 297

GetObjectClass 297

GetRfcData 298

GetRfcDataSize 298

ListDataChanging 298

ReadOnly 299

RfcDataSize 299

TSAPxRFCFileAliasListGS Class 114

CreateRegIni 116

TSAPxRFCFloatTypeGS Enumeration 394

TSAPxRFCFreeStringGS Type 49

TSAPxRFCFunctionCallTypeGS Enumeration 395

TSAPxRFCFunctionFactoryGS Class 173

CreateGetStructureFunction 173


_AddRef 305

_Release 305

CallType 309

CheckDefinition 305

Create 305

DefineParam 306

DefineTable 306

Destroy 306

ExecFunction 306

FindInParameter 307

FindOutParameter 307

FindTable 307

GetErrorHandler 307

InParameterByName 308

InParams 309

InternalPrepare 308


OnError 308

OutParameterByName 308

OutParams 309

QueryInterface 308

TableByName 309

Tables 309

TSAPxRFCFunctionSearchGS Class 174

Create 178

TSAPxRFCFuncWrapperGS Class 409

TSAPxRFCGetAttributesGS Type 50

TSAPxRFCGetDataGS Type 50

TSAPxRFCGetFunctionInterfaceGS Class 178

Create 182

TSAPxRFCGetFunctionInterfaceUSGS Class 182

Create 186

TSAPxRFCGetNameGS Type 50

TSAPxRFCGetStructureDefinitionGS Class 187

Create 191

TSAPxRFCGetUnicodeStructureGS Class 191

Create 195

TSAPxRFCGroupSearchGS Class 195

Create 199

TSAPxRFCIndirectCallExGS Type 50

TSAPxRFCInstallFunctionExtGS Type 51

TSAPxRFCInstallFunctionGS Type 51

TSAPxRFCInstallStructureGS Type 51

TSAPxRFCInstallTransactionControl2GS Type 51

TSAPxRFCInstallTransactionControlGS Type 51

TSAPxRFCIntTypeGS Enumeration 395

TSAPxRFCitAppLineGS Type 52

TSAPxRFCitCpyLineGS Type 52

TSAPxRFCitCreateGS Type 52

TSAPxRFCitDeleteGS Type 52

TSAPxRFCitDelLineGS Type 52

TSAPxRFCitFillGS Type 53

TSAPxRFCitFreeGS Type 53

TSAPxRFCitGetLineGS Type 53

TSAPxRFCitGupLineGS Type 53

TSAPxRFCitInsLineGS Type 53

TSAPxRFCitLengGS Type 54


bb

TSAPxRFCitPutLineGS Type 54

TSAPxRFCLastErrorExGS Type 54

TSAPxRFCListenGS Type 54

TSAPxRFCListObjectClassGS Type 400


CheckDefinition 312

Description 313

GetDataFormat 312

GetErrorHandler 312

GetName 312


List 314

Name 314

ObjectDataChanged 313

ObjectDataChanging 313

SetName 313

TSAPxRFCLoginCallBackGS Type 400

TSAPxRFCMapBCDToTypeGS Enumeration 396

TSAPxRFCObjectBaseGS Class 314


DataFormat 316

GetDataFormat 316

GetErrorHandler 316


ParentDataFormat 316


Add 318

AddObject 319

AddObjectEx 319

Assign 319

CheckDefinition 319

Clear 320

Count 323

Create 320

Delete 320

Destroy 320

FindObject 320

FreeRfcData 321

GetObjectClass 321

GetObjectRfcDataSize 321

GetRfcData 321

GetRfcDataSize 321

IndexOf 322

Items 323

ListDataChanged 322

ListDataChanging 322

Owner 323

Refresh 322

Remove 322

RfcData 323

RfcDataSize 324

TSAPxRFCOpenExGS Type 54

TSAPxRFCParameterClassGS Type 400


AsBCD 330

AsByte 330

AsBytes 331

AsDate 331

AsDouble 331

AsInteger 331

AsNumber 331

Assign 328

AsString 332

AsStruct 332

AsTime 332

AsVarBytes 332

AsVariant 332

AsVarString 333

AsWord 333

AsXMLString 333

CharacterSize 333

CheckDefinition 328

Create 329

DataLength 333

DataPtr 334

DataSize 334

DataType 334

Decimals 334

Destroy 329

Erase 329

GetName 329

GetRfcData 329

GetRfcDataSize 330

IsNull 334


cc

ParameterType 334

ReadFromBuffer 330

SetName 330

StructName 335

SubFields 335

TypeHandle 335


Add 338

AddParameter 338

AddParameterEx 338

Erase 339

FindParameter 339

GetObjectClass 339

ParameterByName 339

Parameters 340

TSAPxRFCParameterTypeGS Enumeration 396

TSAPxRFCRaiseGS Type 55

TSAPxRFCRaiseTablesGS Type 55

TSAPxRFCReadTableFormatGS Enumeration 396

TSAPxRFCReadTableGS Class 200

Create 204

TSAPxRFCReceiveGS Type 55

TSAPxRFCRegistryAliasListGS Class 116

CreateRegIni 118

TSAPxRFCRemoteObjectClassGS Type 401

TSAPxRFCRemoteObjectDefinitionStateGS Enumeration 397


AfterCallEvent 344

Async 344

BeforeCallEvent 345

Busy 345

Create 343

Destroy 343

DoIdle 343

EnterBusyState 344

ExitBusyState 344

FDefinitionState 343

ObjectDefined 344

OnIdleEvent 345

TSAPxRFCResizeXStringGS Type 55

TSAPxRFCSapTypeGS Enumeration 119

TSAPxRFCSendDataGS Type 56


CanPause 133

CanResume 133

CanStart 133

CanStop 134

ConnectionCount 136

Connections 136

Create 133

Destroy 133

GetDataFormat 133

Pause 135

Resume 134

Start 134

Stop 135

Suspended 136

Terminated 135

TimeOut 136

UseTransactionControl 136


Argv 139

Assign 138

CreateArgv 138

Destroy 139

FreeArgv 139

GWHOST 139

GWSERV 139

IniDest 140

PROGID 140

RFC_TRACE 140

SNC_LIB 140

SNC_MYNAME 141


Abort 147

AbortMessage 150

CommandLine 150

Create 147

DataFormat 150

Destroy 147

DoCheckTID 148

DoCommit 148

DoConfirm 148

DoRollback 148


dd

FindServerFunction 149

GetDataFormat 149



OnCheckTIDEvent 151

OnCommitEvent 151

OnConfirmEvent 151

OnRollbackEvent 151

Open 149

ServerFunctionByName 150

Thread 152

TimeOut 152


Add 153

Count 154

Create 153

Destroy 154

GetItemsForAction 154

GetItemsForState 154

Items 154

Remove 154

TSAPxRFCServerFunctionExecuteEventGS Type 170


CheckDefinition 158

Connection 159

Create 158

Destroy 158

Docu 159

DoExecute 158

InParameters 159

InternalPrepare 159


OnExecute 160

OutParameters 160

Tables 160

TSAPxRFCSIStrGS Class 205

Create 209

TSAPxRFCSncQopGS Enumeration 119

TSAPxRFCSrvAppActionGS Enumeration 169

TSAPxRFCSrvAppStateGS Enumeration 169

TSAPxRFCSrvAppStatesGS Type 171


Create 161

Destroy 161

Execute 161

IsSuspended 162

IsTerminated 162

TSAPxRFCSrvConThreadStateGS Enumeration 170

TSAPxRFCStatisticGS Type 56


Append 411

Capacity 412

Clear 411

Create 411

Destroy 411

Length 412

Realloc 411

SetSize 411

ToBuffer 412

ToString 412

Write 412


Add 347

Create 347

DefineStructure 348

Destroy 348

FindStructure 348

Items 349

LookupStructure 348


Create 350

DataSize 351

Destroy 350

Elements 351

Install 350

StructName 351

TypeHandle 351

TSAPxRFCSystemInfoGS Class 209

Create 214

TSAPxRFCTableClassGS Type 401


Active 362

Append 356

Bof 362


ee

Cancel 356

CheckDefinition 357

Close 357

CopyRecord 357

Create 357

CreateStandalone 357

Delete 357

Destroy 358

Edit 358

Eof 363

Erase 358

FetchRow 358

FieldByName 358

Fields 363

FindField 359

First 359

GetDataFormat 359

GetName 359


GetRfcData 360

GetRfcDataSize 360

InitBuffer 360

Insert 360

Last 360

Name 363

Next 361

Open 361

Post 361

PreallocRows 363

Prior 361

ReadOnly 363

RecNo 364

RecordCount 364

RecordSize 364

Refresh 362

SetName 362

State 364

StructName 364

TableFormat 365

TableHandle 365

TableMode 365

TableType 365

TypeHandle 365


AddTable 368

AddTableEx 368

Erase 368

FindTable 368

GetObjectClass 369

TableByName 369

Tables 369

TSAPxRFCTableStateGS Enumeration 397

TSAPxRFCTraceProcGS Type 56


Trace 370

TraceEnter 370

TraceExit 370

TSAPxRFCTreeStateGS Enumeration 398

TSAPxRFCTxCheckTIDEventGS Type 171

TSAPxRFCTxCommitEventGS Type 171

TSAPxRFCTxConfirmEventGS Type 171

TSAPxRFCTxRollbackEventGS Type 172

TSAPxRFCTxTIDEventGS Type 172


ArrangeOffsets 374

CharacterSize 375

CheckDefinition 374

Create 374

CreateField 374

DataSize 375

DataType 376

Decimals 376

Destroy 374

ExID 376

GetName 374

GetRfcData 375

GetRfcDataSize 375

Offset 376

SetName 375

TypeHandle 376


AddElement 379

Elements 380

FindElement 379


ff

GetObjectClass 379

InitializeFieldList 379

TSAPxRFCUninstallFunctionGS Type 56

TSAPxRFCUseSapGUIGS Enumeration 120

TSAPxRFCValueAdapterGetDataFormatEventGS Type 401

TSAPxRFCValueAdapterGetEventGS Type 402


AsBCD 383

AsByte 384

AsBytes 384

AsDate 384

AsDouble 384

AsInteger 384

AsNumber 385

AssignValue 382

AsString 385

AsStruct 385

AsTime 385

AsVarBytes 385

AsVariant 385

AsVarString 386

AsWord 386

AsXMLString 386

CharacterSize 386

Create 382

DataFormat 386

DataSize 387

DataType 387

Decimals 387

Destroy 382

DoGetData 382

DoSetData 383

Erase 383

IsNull 387

OnGetData 388

OnGetDataFormat 388

OnSetData 388

ReadOnly 387

TypeHandle 387

ValueFormat 388

TSAPxRFCValueAdapterSetEventGS Type 402

TSAPxRFCValueFormatGS Enumeration 398


Create 423

Destroy 424

Truncate 424

Write 424


Active 430

AfterConnect 431

AfterDisconnect 431

AliasFileName 430

AliasName 430

ApplyOldConnected 429

BeforeConnect 432

BeforeDisconnect 432

Create 429

EndTransaction 429

GetAliasList 429

Loaded 429

LoginPrompt 430

OnEnterBusy 432

OnError 432

OnExitBusy 432

OnIdle 432

OnLogin 433

Params 431

RestoreTransaction 430

RfcConnection 431

StartTransaction 429

WaitCursor 431

TSAPxRFCvCustomClientConnectionGS Class 496


Active 521

AfterConnect 522

AfterDisconnect 522

AllowStartProgram 518

ApplyOldConnected 519

BeforeConnect 522


Create 519

DefineProperties 519

Destroy 519

DoRfcConnectionAfterConnect 519


gg

DoRfcConnectionAfterDisconnect 519

DoRfcConnectionBeforeConnect 520

DoRfcConnectionBeforeDisconnect 520

DoRfcConnectionEnterBusy 520

DoRfcConnectionError 520

DoRfcConnectionExitBusy 520

DoRfcConnectionIdle 520

GetRfcConnectionClass 520

NotifyActiveChange 520

OnEnterBusy 522

OnError 522

OnExitBusy 522

OnIdle 523

RegisterActiveChangeHandler 521

RfcConnection 521

UnregisterActiveChangeHandler 521

WaitCursor 521

TSAPxRFCvCustomObjectGS Class 523

TSAPxRFCvCustomRemoteObjectGS Class 498


AddFieldDesc 437

AllocateTable 438

AllocRecordBuffer 438

BookmarkValid 438

ClearCalcFields 438

CloseBlob 438

CompareBookmarks 439

Create 439

CreateBlobStream 439

DataConvert 439

Destroy 440

FieldIdToField 440

FreeRecordBuffer 440

FreeTable 440

Func 448

GetBookmarkData 440

GetBookmarkFlag 441

GetCanModify 441

GetCurrentRecord 441

GetFieldData 441, 442

GetRecNo 442

GetRecord 442

GetRecordCount 442

GetRecordSize 443

InitRecord 443

InternalAddRecord 443

InternalCancel 443

InternalClose 443

InternalDelete 444

InternalEdit 444

InternalFirst 444

InternalGotoBookmark 444

InternalHandleException 444

InternalInitFieldDefs 444

InternalInitRecord 445

InternalInsert 445

InternalLast 445

InternalOpen 445

InternalPost 445

InternalRefresh 446

InternalSetToRecord 446

IsCursorOpen 446

IsSequenced 446

Locate 446

LocateRecord 447

Lookup 447

ReadOnly 449

ReleaseTable 447

RemoteObject 449

RFCTable 449

SetBookmarkData 447

SetBookmarkFlag 448

SetFieldData 448

SetRecNo 448


CallType 454

ExecFunction 453

GetRemoteObjectClass 453

InParams 454

OutParams 454

RFCFunction 454

Tables 454

TSAPxRFCvParamKindGS Enumeration 498

TSAPxRFCvParamKindsGS Type 499


hh

TSAPxRFCvParamSetKindGS Type 499


Active 463

AddFieldDesc 460

AfterCancel 464

AfterClose 464

AfterEdit 464

AfterOpen 464

AfterPost 464

AfterRefresh 465

AllocateTable 460

AutoCalcFields 463

BeforeCancel 465

BeforeClose 465

BeforeEdit 465

BeforeOpen 465

BeforePost 465

BeforeRefresh 465

Create 460

Destroy 461

DoBeforeDelete 461

DoBeforeInsert 461

FieldIdToField 461

FieldIdToParam 461

FreeTable 462

Func 463

InternalAddRecord 462

InternalPost 462

InternalRefresh 462

IsCursorOpen 462

LoadParamValues 463

ObjectView 463

OnCalcFields 466

OnEditError 466

OnPostError 466

ParamKinds 464

ReadOnly 464

SaveParamValues 463


AfterCall 473

AfterPrepare 473

AfterUnPrepare 473

Async 471

BeforeCall 473

BeforePrepare 473

BeforeUnPrepare 473

Connection 472

Create 468

DataFormat 472

Destroy 469

DoAfterCall 469

DoAfterPrepare 469

DoAfterUnPrepare 469

DoBeforeCall 469

DoBeforePrepare 470

DoBeforeUnPrepare 470

DoError 470

DoIdle 470

GetRemoteObjectClass 470

Loaded 471

Notification 471

ObjName 472

OnError 474

OnIdle 474

Prepare 471

Prepared 472

RFCRemoteObject 472

Unprepare 471


Active 504

AfterConnect 505

AfterDisconnect 505

BeforeConnect 506


CommandLine 504

Create 502

DataFormat 504

Destroy 502

DoCheckTID 502

DoCommit 503

DoConfirm 503

DoRollback 503

OnCheckTID 506

OnCommit 504


ii

OnConfirm 504

OnEnterBusy 506

OnError 506

OnExitBusy 507

OnIdle 507

OnRollback 504

RfcConnection 505

Thread 505

WaitCursor 505


AfterPrepare 513

AfterUnPrepare 513

BeforePrepare 513

BeforeUnPrepare 514

Connection 511

Create 510

DataFormat 511

Destroy 510

DoAfterPrepare 510

DoAfterUnPrepare 510

DoBeforePrepare 510

DoBeforeUnPrepare 511

Docu 512

DoError 511

DoExecute 511

InParameters 512

ObjName 512

OnError 514

OnExecute 514

OutParameters 512

Prepared 512

RfcServerFunction 513

Tables 513


Active 481

AfterCancel 483

AfterClose 483

AfterDelete 484

AfterEdit 484

AfterInsert 484

AfterOpen 484

AfterPost 484

AfterRefresh 484

AfterScroll 484

AllocateTable 480

AutoCalcFields 481

BeforeCancel 484

BeforeClose 485

BeforeDelete 485

BeforeEdit 485

BeforeInsert 485

BeforeOpen 485

BeforePost 485

BeforeRefresh 485

BeforeScroll 486

Connection 481

Create 480

DataFormat 482

Destroy 481

FreeTable 481

OnCalcFields 486

OnDeleteError 486

OnEditError 486

OnNewRecord 486

OnPostError 486

OpenCursor 481

ReadOnly 482

RFCEasyDataMove 482

RowCount 482

RowSkips 482

Select 483

TableName 483

Where 483


Active 492

AfterCancel 492

AfterClose 493

AfterDelete 493

AfterEdit 493

AfterInsert 493

AfterOpen 493

AfterPost 493

AfterRefresh 493

AfterScroll 494


jj

AllocateTable 491

AutoCalcFields 492

BeforeCancel 494

BeforeClose 494

BeforeDelete 494

BeforeEdit 494

BeforeInsert 494

BeforeOpen 494

BeforePost 494

BeforeRefresh 495

BeforeScroll 495

FreeTable 491

Func 492

OnCalcFields 495

OnDeleteError 495

OnEditError 495

OnNewRecord 495

OnPostError 495

ReadOnly 492

TableName 492

TSAPxRFCWaitEventGS Type 402

TSAPxRFCWaitForRequestGS Type 56

TSysCharSet Type 420

TValueBuffer Type 499

TypeHandle 293, 335, 351, 365, 376, 387







TypeHandle2ExID 279


UUInt64 Type 420

UnicodeString Type 420

Units 13

Unprepare 227, 471



UnprepareObjects 246


UnregisterActiveChangeHandler 521


USE_SAPGUI 96


User 236


USER 96


UseTransactionControl 136


UTF8String Type 420

VValueFormat 388


WWait 168


WaitCursor 431, 505, 521




WAN_CONN 96


Where 128, 483



Write 412, 424



WriteCfgFileName 279


WriteTo 90


WriteToBuffer 260, 288




kk

connect for sap ® - gs-soft€¦ · connect for sap ® v. ... applications as well as receiving...

Documents