CRMCustomization.RetrieveStatus Method

The RetrieveStatus method retrieves the status codes for the specified object (and also the status code names if the status is the default status for the given state).

Syntax

[Visual Basic .NET]
Public Function RetrieveStatus(
  ByVal Caller As CUserAuth,
  ByVal ObjectTypeCode As Integer,
  ByVal State As Integer
) As String
[C#]
public string RetrieveStatus(
  CUserAuth  Caller,
  int  ObjectTypeCode,
  int  State
);
[C++]
public: String* RetrieveStatus(
  CUserAuth*  Caller,
  long  ObjectTypeCode,
  long  State
);

Parameters

Caller

Specifies the identity of the caller. The caller must have the prvReadCustomization privilege to perform this action. See CUserAuth.

ObjectTypeCode

Specifies the type of the object. See ObjectType.

State

Specifies the state of the object.

Return Value

Returns a String type that specifies the XML data containing the status codes, the status code names, and information about whether the status is the default status.

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#]
// strServerName should be set with the name of the platform Web server
string strServerName = "myservername";

// virtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string virtualDirectory = "mscrmservices";
string strDir = "http://" + strServerName + "/" + 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";

// CRMCustomization proxy object
Microsoft.CRM.Proxy.CRMCustomization    customization = new Microsoft.CRM.Proxy.CRMCustomization();
customization.Credentials = System.Net.CredentialCache.DefaultCredentials;
customization.Url = strDir + "CRMCustomization.srf";

string strErrorMsg;

try
{
   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Retrieve the status values
   string strResultsXml = customization.RetrieveStatus (userAuth, Microsoft.CRM.Flags.ObjectType.otAccount, 1);

}
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

© 2003 Microsoft Corporation. All rights reserved.