SapGuiObjectGetPropertyObject Function

Action

This functions reads an object’s property where the value to be read is an object.

Include file

SapGui.bdh

Syntax

SapGuiObjectGetPropertyObject( in  nObject   : number, 
                               in  sProperty : string, 
                               out nOutProp  : number ) : boolean;
Parameter Description
nObject The handle to the object
sProperty The name of the property to be read.
nOutProp This parameter will be assigned the handle to the object read.

Return value

  • true if successful
  • false otherwise

Example

transaction TMain
  var
    sConnID   : string;
    i         : number;
    nIterator : number;
    nType     : number;
    nObject   : number;
    nObject2  : 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);
    SapGuiGetPropertyCollection("wnd[0]", "Children", nIterator);
  
    while (SapGuiIteratorHasMore(nIterator)) do
      SapGuiIteratorFetchNext(nIterator);
      SapGuiIteratorGetObject(nIterator, nObject);
      SapGuiObjectSetBoolean(nObject, true);
      SapGuiObjectInvokeMethod(nObject, "method");
      SapGuiObjectGetBoolean(nObject, bRet);
      SapGuiObjectGetPropertyObject(nObject, "sProp", nObject2);

      // use nObject2 here
      SapGuiObjectFree(nObject2);
      SapGuiObjectFree(nObject);
    end;
  
    SapGuiIteratorRelease(nIterator);
  end TMain;