CRMActivityAttachment.RetrieveByObject Method
The RetrieveByObject method retrieves activity attachments associated with a particular activity.
Syntax
[Visual Basic .NET]
Public Function RetrieveByObject(
ByVal Caller As CUserAuth,
ByVal Entity As CObjectName,
ByVal ColumnSet As String
) As String
[C#]
public string RetrieveByObject(
CUserAuth Caller,
CObjectName Entity,
string ColumnSet
);
[C++]
public: String* RetrieveByObject(
CUserAuth* Caller,
CObjectName* Entity,
String* ColumnSet
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadActivity privilege to perform this action. See CUserAuth.
Entity
Specifies the object to search for. Retrieve all attachments for this object. See CObjectName.
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 attachments. 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 strActivityId = "{33A081D8-ABFF-4103-9E9B-DB0A4B1FD48E}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
Microsoft.CRM.Proxy.CObjectName objectName = new Microsoft.CRM.Proxy.CObjectName();
objectName.Id = strActivityId;
objectName.Type = Microsoft.CRM.Proxy.ObjectType.otActivity;
// Set up the columns that you want to retrieve
strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>activitymimeattachmentid</column>";
strColumnSetXml += "<column>filename</column>";
strColumnSetXml += "</columnset>";
// Retrieve all the attachments for this object
string strResultsXml = activityAttachment.RetrieveByObject(userAuth, objectName, strColumnSetXml);
}
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