Share via


CRMFiscalCalendar.Update Method

The Update method updates a fiscal calendar.

Syntax

[Visual Basic .NET]
Public Sub Update(
  ByVal Caller As CUserAuth,
  ByVal CalendarType As Integer,
  ByVal EntityId As String,
  ByVal EntityXml As String
)
[C#]
public void Update(
  CUserAuth  Caller,
  int  CalendarType,
  string  EntityId,
  string  EntityXml
);
[C++]
public: void Update(
  CUserAuth*  Caller,
  long  CalendarType,
  String*  EntityId,
  String*  EntityXml
);

Parameters

Caller

Specifies the identity of the caller. To perform this action, the caller must have the prvWriteUser privilege and access rights on the object to be updated. See CUserAuth.

CalendarType

Specifies the calendar type. This is one of the following in the ObjectType class: otAnnualFiscalCalendar, otFixedMonthlyFiscalCalendar, otMonthlyFiscalCalendar, otQuarterlyFiscalCalendar, or otSemiAnnualFiscalCalendar.

EntityId

Specifies the ID of the calendar to be updated.

EntityXml

Specifies an XML string containing the fiscal calendar information. Depending on the value of CalendarType, the XML schema is described by one of the following: annualfiscalcalendar.xsd, fixedmonthlyfiscalcalendar.xsd, monthlyfiscalcalendar.xsd, quarterlyfiscalcalendar.xsd, or semiannualfiscalcalendar.xsd.

Return Value

No return value.

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.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";

// CRMFiscalCalendar proxy object
Microsoft.Crm.Platform.Proxy.CRMFiscalCalendar  fiscalcalendar  = new Microsoft.Crm.Platform.Proxy.CRMFiscalCalendar();
fiscalcalendar.Credentials = System.Net.CredentialCache.DefaultCredentials;
fiscalcalendar.Url = strDir + "CRMFiscalcalendar.srf";

string strErrorMsg;
try
{
   Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   string strFiscalCalendarId = "{6B4C1C0D-B62C-4BBF-A1EB-AAEE09ECE4C3}";

   string xml = "<semiannualfiscalcalendar>";
   xml += "<firsthalf>124.00</firsthalf>";
   xml += "</semiannualfiscalcalendar>";

   int type = Microsoft.Crm.Platform.Types.ObjectType.otSemiAnnualFiscalCalendar;
   
   // Update the fiscal calendar
   fiscalcalendar.Update(userAuth, type, strFiscalCalendarId, xml);
}
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

© 2005 Microsoft Corporation. All rights reserved.