ALM Site Administration API Type Library
GetAllDomains Method
Returns the properties of all domains.
Visual Basic
Public Function GetAllDomains() As String
Return Type

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

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

  • DOMAIN_ID    -    The domain ID.
  • DOMAIN_NAME    -    The domain name.
  • PASSWORD    -    Not in use.
  • ADMIN_PASSWORD    -    Not in use.
  • PHYSICAL_DIRECTORY    -    The physical directory of the domain.
  • COMPANY_NAME    -    The company name.
  • CONTACT_NAME    -    The contact name.
  • CONTACT_EMAIL    -    The contact email.
  • USERS_QUOTA    -    The maximum number of concurrent connections to all Projects in domain. -1 indicates an unlimited number of connections.
  • DEFECTS_QUOTA    -    Not in use.
  • PROJECTS_QUOTA    -    Not in use.
  • FILESYSTEM_QUOTA    -    Not in use.
  • USERS_VERSION    -    For internal use.
  • PROJECTS_LIST    XML Root    The domain projects are in this list.

If a domain includes projects, the following project properties are displayed:

  • PROJECT_NAME    -    The project name.
  • PR_IS_ACTIVE    -    Indicates if the project is active (Y/N).
  • SAQ_IS_ACTIVE    -    Indicates if SEND ALL QUALIFIED is active (Y/N).
Return Value Example
<?xml version="1.0"?>
            C:\ProgramData\Micro Focus\ALM\Repository\qc\Default\
Private Sub GetAllDomains()

'The following Visual Basic example gets all the domains
' and their properties.
    Dim sReply As String

    On Error GoTo err
    sReply = m_SAClient.GetAllDomains
    MsgBox sReply
    Exit Sub

    MsgBox "Program failed:" + err.Description
End Sub
See Also