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

DomainName

The domain name.

ProjectName

The project name.

GetSchema

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

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

GetVersion

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)

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

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

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.

<TDXItem>
    <PROJECT_ID>96</PROJECT_ID>
    <PROJECT_NAME>ggg</PROJECT_NAME>
    <DESCRIPTION>Created on Thursday, 29 August, 2002</DESCRIPTION>
    <DOMAIN_ID>1</DOMAIN_ID>
    <DOMAIN_NAME>DEFAULT</DOMAIN_NAME>
    <DB_NAME>default_ggg_db</DB_NAME>
    <DB_TYPE>1</DB_TYPE>
    <CREATE_FROM_PROJECT>ggg</CREATE_FROM_PROJECT>
    <CREATE_FROM_DOMAIN>default</CREATE_FROM_DOMAIN>
            <PHYSICAL_DIRECTORY>\\camaro\td_dir\default\ggg\
                </PHYSICAL_DIRECTORY>
    <DB_USER />
    <DB_USER_PASS />
    <DBSERVER_NAME>LOCAL</DBSERVER_NAME>
    <DB_CONNSTR_FORMAT>PROVIDER=Microsoft.Jet.OLEDB.4.0;USER
            ID=;PASSWORD=;DATA
            SOURCE=MDB_FILENAME</DB_CONNSTR_FORMAT>
    <DB_ENCRYPTED_CONNSTR>PROVIDER=Microsoft.Jet.OLEDB.4.0;USER
            ID=;PASSWORD=;DATA
            SOURCE=\\camaro\td_dir\default\ggg\\TestDir.MDB
            </DB_ENCRYPTED_CONNSTR>
    <PR_IS_ACTIVE>N</PR_IS_ACTIVE>
    <SAQ_IS_ACTIVE>N</SAQ_IS_ACTIVE>
    <PR_HAS_VCSDB>N</PR_HAS_VCSDB>
    <USERS_QUOTA>-1</USERS_QUOTA>
    <VERSION>76</VERSION>
    <VM_REPOSITORY/>
    <PROJECT_VERSION>7.6</PROJECT_VERSION>
    <PROJECT_LANG>English</PROJECT_LANG>
    <PROJECT_SCHEMA>
            <TDXItem>
                <TABLE_NAME>ACTIONS</TABLE_NAME>
                <TABLE_TYPE>TABLE</TABLE_TYPE>
                <DATE_CREATED>3/6/2002 2:51:38 PM</DATE_CREATED>
                <DATE_MODIFIED>6/25/2002 1:20:47 PM</DATE_MODIFIED>
            </TDXItem>

Example (Visual Basic)

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

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

SAapi Object | SAapi Members