CRMActivityAttachment.Retrieve Method
The Retrieve method retrieves an activity attachment.
Syntax
[Visual Basic .NET]
Public Function Retrieve(
ByVal Caller As CUserAuth,
ByVal EntityId As String,
ByVal ColumnSet As String
) As String
[C#]
public string Retrieve(
CUserAuth Caller,
string EntityId,
string ColumnSet
);
[C++]
public: String* Retrieve(
CUserAuth* Caller,
String* EntityId,
String* ColumnSet
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadActivity privilege to perform this action. See CUserAuth.
EntityId
Specifies the ID of the attachment to retrieve.
ColumnSet
Specifies an XML string describing the set of columns that is to be retrieved. Passing "" or null returns all columns. You can find the valid column names in activitymimeattachment.xsd. See also ColumnSetXML Schema.
Return Value
Returns a String type that specifies the XML data containing the requested attachment. The fields that are returned depend on what fields are specified in the ColumnSet parameter. The XML schema is described by activitymimeattachment.xsd.
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";
// CRMActivityAttachment proxy object
Microsoft.CRM.Proxy.CRMActivityAttachment activityAttachment = new Microsoft.CRM.Proxy.CRMActivityAttachment ();
activityAttachment.Credentials = System.Net.CredentialCache.DefaultCredentials;
activityAttachment.Url = strDir + "CRMActivityAttachment.srf";
string strErrorMsg;
string strAttachmentId = "{6E2931EE-2C63-452D-ACD3-195103AB5BD5}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Retrieve the attachment. Passing a null string for ColumnSet retrieves all columns
string strAttachmentXml = activityAttachment.Retrieve(userAuth, strAttachmentId, "");
}
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