CRMRichClientSync.GetDatabaseInfo Method
The GetDatabaseInfo method gets the database information for Microsoft SQL Server replication.
Syntax
[Visual Basic .NET]
Public Function GetDatabaseInfo(
ByVal Caller As CUserAuth,
ByRef MetabaseName As String,
ByRef DatabaseName As String
) As String
[C#]
public string GetDatabaseInfo(
CUserAuth Caller,
out string MetabaseName,
out string DatabaseName
);
[C++]
public: String* GetDatabaseInfo(
CUserAuth* Caller,
String** MetabaseName,
String** DatabaseName
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadOrganization, prvReadBusinessUnit, prvReadUser, prvReadUserSettings, prvReadTeam, prvReadRole, and prvReadLicense privileges to perform this action. See CUserAuth.
MetabaseName
[out] Specifies the name of the metabase.
DatabaseName
[out] Specifies the name of the database.
Return Value
Returns a String type that specifies the name of the computer on which the database is located.
Remarks
If there is an error, SOAP throws an exception and the error message is reported in System.Web.Services.Protocols.SoapException.Detail.OuterXml.
All IDs passed to the platform are GUIDs wrapped in braces. For example: {6522D89A-A752-4455-A2B0-51494C6957C3}
Example
[C#]
// strServer should be set with the name of the platform Web server
string strServer = "myservername";
// virtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string virtualDirectory = "mscrmservices";
string strDir = "https://" + strServer + "/" + virtualDirectory + "/";
// BizUser proxy object
Microsoft.CRM.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMRichClientSync proxy object
Microsoft.CRM.Proxy.CRMRichClientSync richclientsync = new Microsoft.CRM.Proxy.CRMRichClientSync();
richclientsync.Credentials = System.Net.CredentialCache.DefaultCredentials;
richclientsync.Url = strDir + "CRMRichclientsync..srf";
string strErrorMsg;
string strMetaName = "MetaName";
string strDatabaseName = "master";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Get the database information
string strDatabaseInfo = richclientsync.GetDatabaseInfo (userAuth, out strMetaName, out strDatabaseName);
}
catch (System.Web.Services.Protocols.SoapException err)
{
// Process the platform error here
strErrorMsg = ("ErrorMessage: " + err.Message + " " + err.Detail.OuterXml + " Source: " + err.Source );
}
catch (Exception err)
{
// Process other errors here
strErrorMsg = ("ErrorMessage: " + err.Message );
}
Requirements
Namespace: Microsoft.CRM.Proxy
Assembly: microsoft.crm.proxy.dll
See Also