ReportingService2006.SetSubscriptionProperties Method

Artikel
12/15/2008

Sets the properties of a subscription.

Namespace: ReportService2006
Assembly : ReportService2006 (in reportservice2006.dll)

Syntax

'Declaration
Public Sub SetSubscriptionProperties ( _
    SubscriptionID As String, _
    ExtensionSettings As ExtensionSettings, _
    Description As String, _
    EventType As String, _
    MatchData As String, _
    Parameters As ParameterValue() _
)

public void SetSubscriptionProperties (
    string SubscriptionID,
    ExtensionSettings ExtensionSettings,
    string Description,
    string EventType,
    string MatchData,
    ParameterValue[] Parameters
)

public:
void SetSubscriptionProperties (
    String^ SubscriptionID, 
    ExtensionSettings^ ExtensionSettings, 
    String^ Description, 
    String^ EventType, 
    String^ MatchData, 
    array<ParameterValue^>^ Parameters
)

public void SetSubscriptionProperties (
    String SubscriptionID, 
    ExtensionSettings ExtensionSettings, 
    String Description, 
    String EventType, 
    String MatchData, 
    ParameterValue[] Parameters
)

public function SetSubscriptionProperties (
    SubscriptionID : String, 
    ExtensionSettings : ExtensionSettings, 
    Description : String, 
    EventType : String, 
    MatchData : String, 
    Parameters : ParameterValue[]
)

Parameter

SubscriptionID
The ID of the subscription.

ExtensionSettings
An ExtensionSettings object that contains a list of settings that are specific to the delivery extension.

Description
A meaningful description that is displayed to users.

EventType
The type of event that triggers the subscription.

MatchData
The data that is associated with the specified type of event. This data is used by an event processing extension to match the subscription with an event that has fired.

Parameters
An array of ParameterValue objects that contains a list of parameters for the report.

Hinweise

The value of the EventType parameter must correspond to an event processing extension that is configured on the report server. If the event type is not handled by an event processing extension, a SOAP exception is thrown with the error code rsInvalidEvent. The event type must be handled by an event processing extension that creates notifications. When a value for the EventType parameter is received, the event processing extension is queried to determine whether the event creates notifications. If it does not, a SOAP exception is thrown with the error code rsEventNonSubscribeable.

The value of the MatchData parameter depends on the event type. If the event is a TimedSubscription event, a ScheduleDefinition object is required as the MatchData parameter. You must first serialize the ScheduleDefinition object as XML in order to pass it as a string value and create a subscription based on the schedule. The XML structure might resemble the one in the following example:

<ScheduleDefinition>
   <WeeklyRecurrence>
      <StartDateTime>2003-02-24T09:00:00-08:00</StartDateTime>
      <WeeksInterval>1</WeeksInterval>
      <DaysOfWeek>
         <Monday>True</Monday>
         </DaysOfWeek>
   </WeeklyRecurrence>
</ScheduleDefinition>

The value of the StartDateTime element when it is passed as an XML string should correspond to the date format ISO 8601. This international date and time standard is the extended format CCYY-MM-DDThh:mm:ss+/-Z where "CC" represents the century, "YY" the year, "MM" the month and "DD" the day. The letter "T" is the date and time separator and "hh", "mm", "ss" represent hour, minute and second respectively. This representation can be immediately followed by a "Z" to indicate Coordinated Universal Time (UTC). To indicate the time zone, represented as the difference between the local time and Coordinated Universal Time, "Z" is preceded by a "+" or "-" sign, followed by the difference from UTC represented as hh:mm.

If the schedule definition for a TimedSubscription is a shared schedule, you must pass the schedule ID of the shared schedule as the MatchData parameter. The schedule ID is passed as a String, for example, "4608ac1b-fc75-4149-9e15-5a8b5781b843". The schedule ID can be obtained by calling the ListSchedules method.

If the event is a snapshot update subscription, set MatchData parameter to null (Nothing in Visual Basic).

A SharePoint non-administrative user’s ‘Work e-mail’ property in their SharePoint User Information should be the TO e-mail delivery extension setting

Threadsicherheit

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.

Plattformen

Entwicklungsplattformen

Eine Liste der unterstützten Plattformen finden Sie unterHardware- und Softwareanforderungen für die Installation von SQL Server 2005.

Zielplattforme

Windows 98, Windows 2000, Windows 2000 Server, Windows CE, Windows Server 2008, Windows 98 Second Edition, Pocket PC, Smart Phone, Windows Server 2003, Windows XP Professional with Service Pack 2 (SP2), Windows 2000 Professional, Windows 2000 Advanced Server, Windows XP Home Edition, Eine Liste der unterstützten Plattformen finden Sie unterHardware- und Softwareanforderungen für die Installation von SQL Server 2005., Windows Vista, Windows Mobile 5.0, Windows Mobile 2003 for Pocket PC, Windows CE 5.0

Siehe auch

Verweis

ReportingService2006 Class
ReportingService2006 Members
ReportService2006 Namespace

Freigeben über