CRMActivityAttachment.UpdateAndRetrieve Method
The UpdateAndRetrieve method updates and then retrieves an activity attachment.
Syntax
[Visual Basic .NET]
Public Function UpdateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal EntityId As String,
ByVal EntityXml As String,
ByVal ColumnSet As String
) As String
[C#]
public string UpdateAndRetrieve(
CUserAuth Caller,
string EntityId,
string EntityXml,
string ColumnSet
);
[C++]
public: String* UpdateAndRetrieve(
CUserAuth* Caller,
String* EntityId,
String* EntityXml,
String* ColumnSet
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvWriteActivity and prvReadActivity privileges and access rights on the object being modified. See CUserAuth.
EntityId
Specifies the ID of the attachment to update.
EntityXml
Specifies an XML string describing the attachment. The XML schema is described by activitymimeattachment.xsd.
ColumnSet
Specifies an XML string describing the set of columns to be retrieved. Passing an empty string or null returns all columns (Nothing or "" in VB .NET). 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
This method always returns a single object so any filter criteria specified in the ColumnSet parameter are ignored.
The XML string returned from this method does not contain elements for fields where the value is null or contains empty strings. This improves performance by not sending more XML data than is necessary from the server to the client.
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.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMActivityAttachment proxy object
Microsoft.Crm.Platform.Proxy.CRMActivityAttachment activityAttachment = new Microsoft.Crm.Platform.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.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the XML string for the update
string strXml = "<activitymimeattachment>";
strXml += "<subject>My New Subject</subject>";
strXml += "</activitymimeattachment>";
// Set up which columns are to be retrieved
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>activityid</column>";
strColumnSetXml += "<column>activitymimeattachmentid</column>";
strColumnSetXml += "<column>attachmentnumber</column>";
strColumnSetXml += "<column>subject</column>";
strColumnSetXml += "</columnset>";
// Now update the activity attachment, and then retrieve it
string strResultsXml = activityAttachment.UpdateAndRetrieve(userAuth, strAttachmentId, strXml, 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.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also