ReportingService2005.GetScheduleProperties Method

Article
12/03/2008

Returns the properties of a shared schedule.

Namespace: Microsoft.WSSUX.ReportingServicesWebService.RSManagementService2005
Assembly: ReportService2005 (in reportingservice2005.dll)

Syntax

'Declaration
<SoapHeaderAttribute("ServerInfoHeaderValue", Direction:=SoapHeaderDirection.Out)> _
<SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/GetScheduleProperties", RequestNamespace:="https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", ResponseNamespace:="https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", Use:=SoapBindingUse.Literal, ParameterStyle:=SoapParameterStyle.Wrapped)> _
Public Function GetScheduleProperties ( _
    ScheduleID As String _
) As Schedule

[SoapHeaderAttribute("ServerInfoHeaderValue", Direction=SoapHeaderDirection.Out)] 
[SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/GetScheduleProperties", RequestNamespace="https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", ResponseNamespace="https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", Use=SoapBindingUse.Literal, ParameterStyle=SoapParameterStyle.Wrapped)] 
public Schedule GetScheduleProperties (
    string ScheduleID
)

[SoapHeaderAttribute(L"ServerInfoHeaderValue", Direction=SoapHeaderDirection::Out)] 
[SoapDocumentMethodAttribute(L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/GetScheduleProperties", RequestNamespace=L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", ResponseNamespace=L"https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", Use=SoapBindingUse::Literal, ParameterStyle=SoapParameterStyle::Wrapped)] 
public:
Schedule^ GetScheduleProperties (
    String^ ScheduleID
)

/** @attribute SoapHeaderAttribute("ServerInfoHeaderValue", Direction=SoapHeaderDirection.Out) */ 
/** @attribute SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/GetScheduleProperties", RequestNamespace="https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", ResponseNamespace="https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", Use=SoapBindingUse.Literal, ParameterStyle=SoapParameterStyle.Wrapped) */ 
public Schedule GetScheduleProperties (
    String ScheduleID
)

SoapHeaderAttribute("ServerInfoHeaderValue", Direction=SoapHeaderDirection.Out) 
SoapDocumentMethodAttribute("https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices/GetScheduleProperties", RequestNamespace="https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", ResponseNamespace="https://schemas.microsoft.com/sqlserver/2005/06/30/reporting/reportingservices", Use=SoapBindingUse.Literal, ParameterStyle=SoapParameterStyle.Wrapped) 
public function GetScheduleProperties (
    ScheduleID : String
) : Schedule

Parameters

ScheduleID
The ID of the schedule.

Return Value

A Schedule object that contains state information and the schedule definition for a single schedule.

Example

To compile this code example, you must reference the Reporting Services WSDL and import certain namespaces. For more information, see Compiling and Running Code Examples. The following code example creates a shared schedule and then uses the GetScheduleProperties method to retrieve the properties of the newly created schedule:

Imports System
Imports System.Web.Services.Protocols

Class Sample
    Public Shared Sub Main()
      Dim rs As New ReportingService2005()
      rs.Credentials = System.Net.CredentialCache.DefaultCredentials

      Dim definition As New ScheduleDefinition()
      Dim scheduleID As String
      ' Create the schedule definition.
      definition.StartDateTime = New DateTime(2003, 3, 1, 14, 0, 0)
      Dim recurrence As New WeeklyRecurrence()
      Dim days As New DaysOfWeekSelector()
      days.Monday = True
      days.Tuesday = True
      days.Wednesday = True
      days.Thursday = True
      days.Friday = True
      days.Saturday = False
      days.Sunday = False
      recurrence.DaysOfWeek = days
      recurrence.WeeksInterval = 1
      recurrence.WeeksIntervalSpecified = True
      definition.Item = recurrence

      Try
         scheduleID = rs.CreateSchedule("My Schedule", definition)
         Console.WriteLine("Schedule created with ID {0}", scheduleID)

         rs.GetScheduleProperties(scheduleID)

         recurrence = CType(definition.Item, WeeklyRecurrence)
         Console.WriteLine(definition.StartDateTime)
         Console.WriteLine(definition.EndDate)

         days = recurrence.DaysOfWeek
         Console.WriteLine("Monday: {0}", days.Monday)
         Console.WriteLine("Tuesday: {0}", days.Tuesday)
         Console.WriteLine("Wednesday: {0}", days.Wednesday)
         Console.WriteLine("Thursday: {0}", days.Thursday)
         Console.WriteLine("Friday: {0}", days.Friday)
         Console.WriteLine("Saturday: {0}", days.Saturday)
         Console.WriteLine("Sunday: {0}", days.Sunday)
         Console.WriteLine("Weeks Interval: {0}", recurrence.WeeksInterval)

      Catch e As SoapException
         Console.WriteLine(e.Detail.InnerXml.ToString())
      End Try
   End Sub 'Main
End Class 'Sample

using System;
using System.Web.Services.Protocols;

class Sample
{
   public static void Main()
   {
      ReportingService2005 rs = new ReportingService2005();
      rs.Credentials = System.Net.CredentialCache.DefaultCredentials;

      ScheduleDefinition definition = new ScheduleDefinition();
      string scheduleID;
      // Create the schedule definition.
      definition.StartDateTime = new DateTime(2003, 3, 1, 14, 0, 0);
      WeeklyRecurrence recurrence = new WeeklyRecurrence();
      DaysOfWeekSelector days = new DaysOfWeekSelector();
      days.Monday = true;
      days.Tuesday = true;
      days.Wednesday = true;
      days.Thursday = true;
      days.Friday = true;
      days.Saturday = false;
      days.Sunday = false;
      recurrence.DaysOfWeek = days;
      recurrence.WeeksInterval = 1;
      recurrence.WeeksIntervalSpecified = true;
      definition.Item = recurrence;

      try
      {
         scheduleID = rs.CreateSchedule("My Schedule", definition);
         Console.WriteLine("Schedule created with ID {0}", scheduleID);

         rs.GetScheduleProperties(scheduleID);

         recurrence = (WeeklyRecurrence) definition.Item;
         Console.WriteLine(definition.StartDateTime);
         Console.WriteLine(definition.EndDate);

         days = recurrence.DaysOfWeek;
         Console.WriteLine("Monday: {0}", days.Monday);
         Console.WriteLine("Tuesday: {0}", days.Tuesday);
         Console.WriteLine("Wednesday: {0}", days.Wednesday);
         Console.WriteLine("Thursday: {0}", days.Thursday);
         Console.WriteLine("Friday: {0}", days.Friday);
         Console.WriteLine("Saturday: {0}", days.Saturday);
         Console.WriteLine("Sunday: {0}", days.Sunday);
         Console.WriteLine("Weeks Interval: {0}", recurrence.WeeksInterval);
      }

      catch ( SoapException e )
      {
         Console.WriteLine( e.Detail.InnerXml.ToString() );
      }
   }
}

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms