ALM Site Administration API Type Library
GetConnections Method
Returns the properties of all connections to the server.
Visual Basic
Public Function GetConnections() As String
Return Type

On success, returns an XML string containing the connection properties.

Return Value Details
The properties of the GetConnections XML return string:

  • LOGIN_SESSION_ID    -     The connection ID assigned when user authenticated.
  • PROJECT_SESSION_ID    -     The ID assigned when the user is logged on to this project.
  • DOMAIN          -    The domain name.
  • HOSTNAME      -    The server name.
  • PROJECT          -    The project name.
  • USERNAME      -    The user name.
  • CLIENTTYPE    -    The type of client logged on. For example, UI, OTA, or testing tool.
  • LOGINTIME      -    The login time.
  • HOSTNAME       -    The host name.
  • LASTACTION    -    The time of the last action.
  • LASTPING        -    The time of the last ping.
  • LOGINTIME      -    The time this connection was made.
  • DEFECTS          -    Defects module license usage.
  • TESTLAB           -    TestLab module license usage.
  • REQUIREMENTS -    Requirements module license usage.
Return Value Example
<?xml version="1.0"?>

     <LASTPING>2007-07-05 12:41:57</LASTPING>
     <LASTACTION>2007-07-05 12:41:57</LASTACTION>
     <LOGINTIME>2007-07-05 12:41:57</LOGINTIME>
     <LASTPING>2007-07-05 12:43:25</LASTPING>
     <LASTACTION>2007-07-05 12:43:25</LASTACTION>
     <LOGINTIME>2007-07-05 12:43:24</LOGINTIME>

Private Sub GetConnections()

'The following Visual Basic example gets all connections
' to a Quality Center server.
    Dim sReply As String
    On Error GoTo err
    sReply = m_SAClient.GetConnections
    MsgBox sReply
    Exit Sub
    MsgBox "Program failed:" + err.Description
End Sub
See Also