ALM Site Administration API Type Library
GetProjectExtendedData Method
Returns project properties and database information.
Visual Basic
Public Function GetProjectExtendedData( _
   ByVal DomainName As String, _
   ByVal ProjectName As String, _
   ByVal GetSchema As Integer, _
   ByVal GetVersion As Integer _
) As String
The domain name.
The project name.

If the schema (database tables) is returned you can use the following constants or their values:

  • SA_FALSE (value: 0)
  • SA_TRUE (value: 1)

If the project version and language is returned you can use the following constants or their values:

  • SA_FALSE (value: 0)
  • SA_TRUE (value: 1)
Return Type

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

The extended data is optional and returns only if selected by the user.

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

  • PROJECT_NAME    -     The project name.
  • DESCRIPTION    -    The project description.
  • DOMAIN_ID    -    The domain ID number.
  • DOMAIN_NAME    -    The domain name.
  • DB_NAME    -    The database name.
  • DB_TYPE    -    The database type number: MS SQL (2), Oracle(3).
  • CREATE_FROM_PROJECT    -    The source project of the created project.
  • CREATE_FROM_DOMAIN    -    The source domain of the created project.
  • PHYSICAL_DIRECTORY    -    The physical directory of the project.
  • DB_USER    -    The database administrator user name.
  • DB_USER_PASS    -    The database administrator password.
  • DBSERVER_NAME    -    The database server name.
  • DB_CONNSTR_FORMAT    -    The database connection string.
  • DB_ENCRYPTED_CONNSTR    -    For internal use.
  • PR_IS_ACTIVE    -    Indicates if the project is active (Y/N).
  • SAQ_IS_ACTIVE    -    Indicates if SEND ALL QUALIFIED is active (Y/N).
  • PR_HAS_VCSDB    -    Indicates if the project includes version control: (Y)es, (N)o, (D)isabled. This field appears only if version control is available.
  • USERS_QUOTA    -    The maximum number of concurrent connections. -1 indicates an unlimited number of connections.
  • VERSION    -    The version of the project.
  • VM_REPOSITORY    -    Repository for VMWare integration.


If version is selected, the following fields are displayed:

  • PROJECT_VERSION    -    The version of the project.
  • PROJECT_LANG    -    The language of the project.


If schema is selected, the following fields are displayed:

  • PROJECT_SCHEMA    -    All the table data is displayed.
  • TABLE_NAME    -    The table name.
  • TABLE_TYPE    -    For internal use.
  • DATE_CREATED    -    The table creation date.
  • DATE_MODIFIED    -    The date the table was last modification.
Return Value Example
    <DESCRIPTION>Created on Thursday, 29 August, 2002</DESCRIPTION>
    <DB_USER />
    <DB_USER_PASS />
                <DATE_CREATED>3/6/2002 2:51:38 PM</DATE_CREATED>
                <DATE_MODIFIED>6/25/2002 1:20:47 PM</DATE_MODIFIED>
Private Sub GetProjectExtendedData()

' The following example gets the project, properties,
' table schema, project version, and language.

    Dim sDomainName As String
    Dim sProjectName As String
    Dim sReply As String

    On Error GoTo err
    sDomainName = "MyDomain"
    sProjectName = "MyProject"
    sReply = m_SAClient.GetProjectExtendedData _
        (sDomainName, sProjectName, SA_TRUE, SA_TRUE)
    MsgBox sReply
    Exit Sub

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