SapGuiTableGetColumns Function

Action

This function returns the collection of columns for the specified table. Each entry in the collection is of type GuiTableColumn.

Include file

SapGui.bdh

Syntax

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

Parameter	Description
sControlId	The control’s unique id.
nIterator	This parameter will be assigned 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);
    SapGuiTableGetColumns("table[0]", nIterator);
    while
      (SapGuiIteratorHasMore(nIterator)) do
      SapGuiIteratorFetchNext(nIterator);
      SapGuiIteratorGetObject(nIterator, nObject);
      SapGuiObjectGetType(nObject, sStr1, sStr2);
    if sStr1 = "GuiTableColumn"then
      Print("GuiTableColumn");
    end;
      SapGuiObjectFree(nObject);
    end;
      SapGuiIteratorRelease(nIterator);
  end TMain;