SapGuiGetPropertyCollection Function

Action

This function reads the return value of a previous call of SapGuiInvokeMethod and provides the value as a collection.

Include file

SapGui.bdh

Syntax

SapGuiGetPropertyCollection( in  sControlId : string,
                             in  sProperty  : string,
                             out nIterator  : number ) : boolean;

Parameter	Description
sControlId	The control’s unique id.
sProperty	The name of the property to be read.
nIterator	This parameter will be assigned the handle to the collection iterator.

Return value

true if successful
false otherwise

Example

transaction TMain
  var
    sConnID   : string;
    i         : number;
    nIterator : number;
    nType     : number;
    nObject   : 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);
    SapGuiObjectGetType(nObject, sStr1, sStr2);
    SapGuiObjectFree(nObject);
    Print(string(nType) + " " + sValue);
  end;
    SapGuiIteratorRelease(nIterator);
  end TMain;