ReportingService2006.SetSubscriptionProperties Method

  • [アーティクル]

サブスクリプションのプロパティを設定します。

名前空間: ReportService2006
アセンブリ: ReportService2006 (reportservice2006.dll 内)

構文

'宣言
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[]
)

パラメータ

  • SubscriptionID
    サブスクリプションの ID です。
  • ExtensionSettings
    配信拡張機能固有の設定の一覧を格納した ExtensionSettings オブジェクトです。
  • Description
    ユーザーに対して表示される説明文です。
  • EventType
    サブスクリプションを開始するイベントの種類です。
  • MatchData
    指定した種類のイベントに関連付けられているデータです。このデータは、サブスクリプションと発生したイベントの照合のために、イベント処理拡張機能で使用されます。
  • Parameters
    レポートのパラメータの一覧を表す ParameterValue オブジェクトの配列です。

解説

EventType パラメータの値は、レポート サーバーで構成されたイベント処理拡張機能に対応する必要があります。イベントの種類がイベント処理拡張機能で処理されない場合、SOAP 例外がエラー コード rsInvalidEvent でスローされます。このイベントの種類は、通知を作成するイベント処理拡張機能で処理される必要があります。EventType パラメータの値を受信すると、イベント処理拡張機能のクエリが実行され、イベントが通知を作成するかどうかが決まります。通知を作成しない場合、SOAP 例外がエラー コード rsEventNonSubscribeable でスローされます。

MatchData パラメータの値は、イベントの種類によって異なります。イベントが TimedSubscription イベントである場合は、MatchData パラメータとして ScheduleDefinition オブジェクトが必要です。ScheduleDefinition オブジェクトを文字列値として渡し、スケジュールに基づくサブスクリプションを作成するには、まずこのオブジェクトを XML としてシリアル化する必要があります。XML 構造は、次の例のようになります。

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

StartDateTime 要素を XML 文字列として渡すときの値は、ISO 8601 の日付形式に対応する必要があります。この国際日時標準は拡張形式 CCYY-MM-DDThh:mm:ss+/-Z となっており、"CCYY" が年、"MM" が月、"DD" が日を表します。文字 "T" は日付と時刻の区切り記号を表し、"hh"、"mm"、"ss" はそれぞれ時、分、秒を表します。協定世界時 (UTC) を表す場合には、すぐ後ろに "Z" を付けます。ローカル時刻と協定世界時の差でタイム ゾーンを示すには、"Z" の前に "+"記号か "-" 記号を付け、"Z" の後ろに UTC との差を hh:mm の形式で表します。

TimedSubscription のスケジュール定義が共有スケジュールである場合、共有スケジュールの ID を MatchData パラメータとして渡す必要があります。スケジュール ID は、"4608ac1b-fc75-4149-9e15-5a8b5781b843" のように、String として渡されます。スケジュール ID は、ListSchedules メソッドを呼び出すことにより取得されます。

イベントがスナップショット更新サブスクリプションである場合は、MatchData パラメータに NULL (Visual Basic では Nothing) を設定します。

SharePoint 管理者以外のユーザーの SharePoint ユーザー情報である "勤務先の電子メール" プロパティは、電子メール配信拡張機能で設定した宛先である必要があります。

スレッド セーフ

この型の public static (Microsoft Visual Basic では共有 ) メンバは、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

開発プラットフォーム

サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。

対象プラットフォーム

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, サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。, Windows Vista, Windows Mobile 5.0, Windows Mobile 2003 for Pocket PC, Windows CE 5.0

参照

関連項目

ReportingService2006 Class
ReportingService2006 Members
ReportService2006 Namespace