Visual Basic |
---|
Public Function SetDomainProperty( _ ByVal DomainName As String, _ ByVal PropertyNumber As Long, _ ByVal PropertyValue As String _ ) As String |
- DomainName
- The domain name.
- PropertyNumber
The property number you want to change. You can use the following constants or their values:
- SA_DOMAIN_CONTACT_NAME (value :5)
- SA_DOMAIN_CONTACT_EMAIL (value :6)
- SA_DOMAIN_USERS_QUOTA (value :7)
The other domain properties in SA_DOMAIN_PROPERTY_OPTIONS are read-only.
- PropertyValue
- The property value.
On success, returns an XML string containing the domain properties.
The following are the domain details:
- 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. (Not used by ALM.)
- CONTACT_NAME - The contact name. (Not used by ALM.)
- CONTACT_EMAIL - The contact email. (Not used by ALM.)
- USERS_QUOTA - The maximum number of concurrent connections in all projects of the 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 - Not in use.
- PROJECTS_LIST XML Root The domain projects are in this list.
The following are the domain properties of the displayed projects:
- PROJECT_NAME - The project name.
- PR_IS_ACTIVE - Indicates if the project is active (Y/N).
- SAQ_IS_ACTIVE - Indicates if SEND ALL QUALIFIED (defect email notifications) is active (Y/N).
<DOMAIN_ID>17</DOMAIN_ID>
<DOMAIN_NAME>TEST</DOMAIN_NAME>
<PASSWORD>455704</PASSWORD>
<ADMIN_PASSWORD>455362</ADMIN_PASSWORD>
<PHYSICAL_DIRECTORY>66666\</PHYSICAL_DIRECTORY>
<COMPANY_NAME>MyCompany</COMPANY_NAME>
<CONTACT_NAME>Paul</CONTACT_NAME>
<CONTACT_EMAIL>paul@anywhere.com</CONTACT_EMAIL>
<USERS_QUOTA>-1</USERS_QUOTA>
<DEFECTS_QUOTA>13</DEFECTS_QUOTA>
<PROJECTS_QUOTA>14</PROJECTS_QUOTA>
<FILESYSTEM_QUOTA>51201</FILESYSTEM_QUOTA>
<PROJECTS_LIST>
<TDXItem>
<PROJECT_NAME>LoadTest</PROJECT_NAME>
<PR_IS_ACTIVE>N</PR_IS_ACTIVE>
<SAQ_IS_ACTIVE>N</SAQ_IS_ACTIVE>
</TDXItem>
</PROJECTS_LIST>
<USERS_VERSION>0</USERS_VERSION>
</SetDomainProperty>
Private Sub SetDomainProperty() 'The following Visual Basic example changes the contact ' name in the domain property. Dim sDomainName As String Dim sReply As String On Error GoTo err sDomainName = "MyDomain" sReply = m_SAClient.SetDomainProperty(sDomainName, _ SA_DOMAIN_CONTACT_NAME, "Alex") MsgBox sReply Exit Sub err: MsgBox "Program failed:" + err.Description End Sub