CRMCustomization.RetrievePicklist Method
The RetrievePicklist method retrieves the drop-down list (picklist) values and their associated names for the specified object type.
Syntax
[Visual Basic .NET]
Public Function RetrievePicklist(
ByVal Caller As CUserAuth,
ByVal ObjectTypeCode As Integer,
ByVal AttributeName As String
) As String
[C#]
public string RetrievePicklist(
CUserAuth Caller,
int ObjectTypeCode,
string AttributeName
);
[C++]
public: String* RetrievePicklist(
CUserAuth* Caller,
long ObjectTypeCode,
String* AttributeName
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvReadCustomization privilege. See CUserAuth.
ObjectTypeCode
Specifies the type of the object. See ObjectType.
AttributeName
Specifies the name of the drop-down list (picklist).
Return Value
Returns a String type that specifies the XML data containing the drop down list (picklist) values and their associated 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";
// strVirtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
String strVirtualDirectory = "mscrmservices";
String strDir = String.Concat("https://", strServer, "/",
strVirtualDirectory, "/");
// BizUser proxy object
Microsoft.Crm.Platform.Proxy.BizUser bizUser
= new Microsoft.Crm.Platform.Proxy.BizUser();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = String.Concat(strDir, "BizUser.srf");
// CRMCustomization proxy object
Microsoft.Crm.Platform.Proxy.CRMCustomization customization
= new Microsoft.Crm.Platform.Proxy.CRMCustomization();
customization.Credentials = System.Net.CredentialCache.DefaultCredentials;
customization.Url = String.Concat(strDir, "CRMCustomization.srf");
String strErrorMsg;
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Retrieve the drop-down list values
String strResultsXml = customization.RetrievePicklist(userAuth,
Microsoft.Crm.Platform.Types.ObjectType.otAccount,
"paymenttermscode");
}
catch (System.Web.Services.Protocols.SoapException err)
{
// Process the platform error here
strErrorMsg = String.Concat("ErrorMessage: ", err.Message, " ",
err.Detail.OuterXml, " Source: ", err.Source);
}
Requirements
Namespace: Microsoft.Crm.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also