CRMCustomization.RetrieveState Method
The RetrieveState method retrieves state codes and the state code names for the specified object type.
Syntax
[Visual Basic .NET]
Public Function RetrieveState(
ByVal Caller As CUserAuth,
ByVal ObjectTypeCode As Integer
) As String
[C#]
public string RetrieveState(
CUserAuth Caller,
int ObjectTypeCode
);
[C++]
public: String* RetrieveState(
CUserAuth* Caller,
long ObjectTypeCode
);
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.
Return Value
Returns a String type that specifies the XML data containing the state codes and the state code names.
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 = "https://" + 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 state values
string strResultsXml = customization.RetrieveState (userAuth, Microsoft.CRM.Flags.ObjectType.otAccount);
}
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