SapGuiGetHandleFromControlId Function

Action

This function returns a handle for the control specified. The returned handle has to be free by calling SapGuiObjectFree.

Include file

SapGui.bdh

Syntax

SapGuiGetHandleFromControlId( in  sControlId : string,
                              out nObject    : number ) : boolean;

Parameter	Description
sControlId	The control’s unique id.
nObject	This parameter will be assigned the handle to the object.

Return value

true if successful
false otherwise

Example

transaction TMain
  var
    sConnID   : string;
    i         : number;
    nIterator : number;
    nType     : number;
    nObj      : number;
    bRet      : boolean;
    sStr1, sStr2 : string;
  begin
    // Connecting to SAP
    sConnID := SapGuiOpenConnection(" /SAP_CODEPAGE=1100 /FULLMENU 10.5.2.198 0 /3");
    SapGuiSetActiveConnection(sConnID);
    SapGuiSetActiveSession("ses[0]");
  
    // SAP
    SapGuiSetActiveWindow("wnd[0]", "SAP", SAPGUI_MATCH_Exact);
    SapGuiWindowAction(SAPGUI_WND_MAXIMIZE);
  
    // Logon to SAP System
    SapGuiIgnoreError(SAPENGINE_STATUSBAR_CHANGED, SEVERITY_SUCCESS);
    ThinkTime(2.8);
    SapGuiLogon("ddic", "minisap", "000", ""); 
 
    // Copyright
    ThinkTime(2.1);
    SapGuiSetActiveWindow("wnd[1]", "Copyright", SAPGUI_MATCH_Exact);
    SapGuiPressButton("tbar[0]/btn[0]");
  
    // SAP Easy Access
    ThinkTime(9.9);
    SapGuiSetActiveWindow("wnd[0]", "SAP Easy Access", SAPGUI_MATCH_Exact);
    SapGuiGetHandleFromControlId("wnd[0]", nObj);

    // Here nObj can be used.
    // That means be passed as parameter to all SapGuiObject... functions
    SapGuiObjectFree(nObj); // Don't forget to free the object handle!
  end TMain;