Class: WMI::Win32_ScheduledJob

Inherits:
Base
  • Object
show all
Defined in:
lib/Win32_ScheduledJob.rb

Overview

Win32_ScheduledJob クラスは、ネットワーク管理スケジュール サービス機能 ("ジョブ" および "AT コマンド" 機能) を使用するスケジュールされたジョブを表します。これは、Windows 2000 タスク スケジューラを使ってスケジュールしたタスクと異なることに注意してください。このクラスは Windows NT 4.0 以降でのみ使用されます。スケジュール サービスに対してスケジュールされた各ジョブは、持続的に格納され (スケジューラにより再起動後もジョブの開始が認知されます)、週と月の指定された日時に実行されます。コンピュータが動作していないか、またはスケジュール サービスが指定されたジョブ時間に実行していない場合、スケジュール サービスにより指定された時間で次の日に指定されたジョブが実行されます。スケジュールされたジョブは、協定世界時 (UTC) に関連して、たとえば GMT からのずれオフセットでスケジュールされます。これは、タイム ゾーン仕様を使用してジョブを指定できることを意味します。Win32_ScheduledJob により、オブジェクトが列挙されるときに UTC オフセットでローカル タイムが返され、新しいジョブが作成されるときにローカル タイムに変換されます。たとえば、ボストンで太平洋標準時で月曜の午後 10:30 に実行するように指定されたジョブは、ローカルでは東部標準時で火曜の午前 1:30 に実行されるようにスケジュールされます。夏時間でローカル コンピュータを操作しているかどうかをクライアントは考慮する必要があることに注意し、操作している場合 UTC オフセットから 60 分のずれを引いてください。

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from Base

#AddRef, #AssociatorsAsync_, #Associators_, #Clone_, #CompareTo_, #DeleteAsync_, #Delete_, #Derivation_, #ExecMethodAsync_, #ExecMethod_, #GetIDsOfNames, #GetObjectText_, #GetText_, #GetTypeInfo, #GetTypeInfoCount, #InstancesAsync_, #Instances_, #Invoke, #Methods_, #Path_, #Properties_, #PutAsync_, #Put_, #Qualifiers_, #QueryInterface, #ReferencesAsync_, #References_, #Refresh_, #Release, #Security_, #SetFromText_, #SpawnDerivedClass_, #SpawnInstance_, #SubclassesAsync_, #Subclasses_, #SystemProperties_

Instance Attribute Details

- (string) Caption (readonly)

Caption プロパティは、オブジェクトについての簡単な説明 (1 行分の文字列) です。

Returns:

  • (string)

    Caption



83
84
85
# File 'lib/Win32_ScheduledJob.rb', line 83

def Caption
  @Caption
end

- (string) Command (readonly)

Command パラメータには、スケジュール サービスがジョブを開始するために使用するコマンド、バッチ プログラム、またはバイナリ ファイルの名前がコマンド ラインの引数と共に含まれています。

 

Returns:

  • (string)

    Command



90
91
92
# File 'lib/Win32_ScheduledJob.rb', line 90

def Command
  @Command
end

- (uint32) DaysOfMonth (readonly)

DaysOfMonth パラメータは、ジョブの実行がスケジュールされている月の日を示します。

Returns:

  • (uint32)

    DaysOfMonth



95
96
97
# File 'lib/Win32_ScheduledJob.rb', line 95

def DaysOfMonth
  @DaysOfMonth
end

- (uint32) DaysOfWeek (readonly)

DaysOfWeek パラメータは、ジョブの実行がスケジュールされている曜日を示します。

Returns:

  • (uint32)

    DaysOfWeek



101
102
103
# File 'lib/Win32_ScheduledJob.rb', line 101

def DaysOfWeek
  @DaysOfWeek
end

- (string) Description (readonly)

Description プロパティでオブジェクトの説明が提供されます。

Returns:

  • (string)

    Description



107
108
109
# File 'lib/Win32_ScheduledJob.rb', line 107

def Description
  @Description
end

- (datetime) ElapsedTime (readonly)

ジョブが実行されている時間の長さです。

Returns:

  • (datetime)

    ElapsedTime



112
113
114
# File 'lib/Win32_ScheduledJob.rb', line 112

def ElapsedTime
  @ElapsedTime
end

- (datetime) InstallDate (readonly)

InstallDate プロパティは、オブジェクトがインストールされた日時を示す値です。

 

Returns:

  • (datetime)

    InstallDate



118
119
120
# File 'lib/Win32_ScheduledJob.rb', line 118

def InstallDate
  @InstallDate
end

- (boolean) InteractWithDesktop (readonly)

InteractWithDesktop プロパティにより、指定されたジョブを対話型にすることできます。

 

Returns:

  • (boolean)

    InteractWithDesktop



128
129
130
# File 'lib/Win32_ScheduledJob.rb', line 128

def InteractWithDesktop
  @InteractWithDesktop
end

- (uint32) JobId (readonly)

JobId プロパティは、ジョブの識別子番号を表します。

 

Returns:

  • (uint32)

    JobId



134
135
136
# File 'lib/Win32_ScheduledJob.rb', line 134

def JobId
  @JobId
end

- (string) JobStatus (readonly)

JobStatus プロパティは、このジョブが前回、実行されることになっていたときに、スケジュールされたサービスが正常に実行されたかどうかを示します。

Returns:

  • (string)

    JobStatus



139
140
141
# File 'lib/Win32_ScheduledJob.rb', line 139

def JobStatus
  @JobStatus
end

- (string) Name (readonly)

Name プロパティで、オブジェクトを認識するラベルを定義します。

 

Returns:

  • (string)

    Name



145
146
147
# File 'lib/Win32_ScheduledJob.rb', line 145

def Name
  @Name
end

- (string) Notify (readonly)

ジョブの完了または失敗が通知されるユーザーです

Returns:

  • (string)

    Notify



150
151
152
# File 'lib/Win32_ScheduledJob.rb', line 150

def Notify
  @Notify
end

- (string) Owner (readonly)

ジョブを送信したユーザーです。

Returns:

  • (string)

    Owner



155
156
157
# File 'lib/Win32_ScheduledJob.rb', line 155

def Owner
  @Owner
end

- (uint32) Priority (readonly)

優先順位は、ジョブ実行の緊急性または重要性を示します。

Returns:

  • (uint32)

    Priority



160
161
162
# File 'lib/Win32_ScheduledJob.rb', line 160

def Priority
  @Priority
end

- (boolean) RunRepeatedly (readonly)

RunRepeatedly プロパティは、スケジュールされたジョブがスケジュールされた日に繰り返し実行される必要があるかどうかを示します。

 

Returns:

  • (boolean)

    RunRepeatedly



169
170
171
# File 'lib/Win32_ScheduledJob.rb', line 169

def RunRepeatedly
  @RunRepeatedly
end

- (datetime) StartTime (readonly)

StartTime プロパティは、ジョブを実行する UTC 時間を YYYYMMDDHHMMSS.MMMMMM(+-)OOO の形式で表され、YYYYMMDD は ******** で置き換わる必要があります。

 

Returns:

  • (datetime)

    StartTime



178
179
180
# File 'lib/Win32_ScheduledJob.rb', line 178

def StartTime
  @StartTime
end

- (string) Status (readonly)

Status プロパティはオブジェクトの現在の状態を示す文字列です。

 

Returns:

  • (string)

    Status



191
192
193
# File 'lib/Win32_ScheduledJob.rb', line 191

def Status
  @Status
end

- (datetime) TimeSubmitted (readonly)

ジョブを送信した時刻です。

Returns:

  • (datetime)

    TimeSubmitted



196
197
198
# File 'lib/Win32_ScheduledJob.rb', line 196

def TimeSubmitted
  @TimeSubmitted
end

- (datetime) UntilTime (readonly)

ジョブが無効または停止する時刻です。

Returns:

  • (datetime)

    UntilTime



201
202
203
# File 'lib/Win32_ScheduledJob.rb', line 201

def UntilTime
  @UntilTime
end

Instance Method Details

- (uint32) Create(Command, DaysOfMonth, DaysOfWeek, InteractWithDesktop, RunRepeatedly, StartTime)

Create 関数は、ジョブを指定した今後の時刻で実行するようにオペレーティング システムに送信します。 この関数は、スケジュール サービスがジョブを送信するコンピュータで開始することを必要とします。 メソッドは次のように変換される整数値を返します: 0 - 正常に完了しました。

1 - サポートされていません。

2 - アクセスが拒否されました。

8 - 不明なエラーです。

9 - パスが見つかりません。

21 - パラメータが無効です。

22 - サービスは開始していません。

その他 - 上の一覧以外の整数値については Win32 エラー コードのドキュメントを参照してください。

Parameters:

  • (string, #read) Command

    Command パラメータには、スケジュール サービスがジョブを開始するために使用するコマンド、バッチ プログラム、またはバイナリ ファイルの名前がコマンド ラインのパラメータと共に含まれています。

    例: defrag /q /f

  • (uint32, #read) DaysOfMonth

    DaysOfMonth パラメータは、ジョブの実行がスケジュールされている月の日を示します。

     RunRepeatedly 
  • (uint32, #read) DaysOfWeek

    DaysOfWeek パラメータは、ジョブの実行がスケジュールされている曜日を示します。

     RunRepeatedly 
  • (boolean, #read) InteractWithDesktop

    InteractWithDesktop パラメータは、指定されたジョブが対話型の必要があるかどうかを示します。 対話型というのは、ユーザーがスケジュールされたジョブの実行中にこのジョブに対して入力処理を行うことができることを意味します。

    値は、TRUE または FALSE です。 TRUE の場合、ジョブは繰り返し実行されます。 このパラメータの既定値は FALSE です。

  • (boolean, #read) RunRepeatedly

    RunRepeatedly パラメータは、スケジュールされたジョブがスケジュールされた日に繰り返し実行される必要があるかどうかを示します。

    値: TRUE または FALSE です。 TRUE の場合、DaysOfWeek と DaysOfMonth パラメータによりジョブが繰り返し実行されます。 値が与えられていない場合、パラメータの既定値は FALSE です。

  • (datetime, #read) StartTime

    StartTime パラメータは、ジョブを実行する UTC 時間を表します。 これは、YYYYMMDDHHMMSS.MMMMMM(+-)OOO の形式になり、YYYYMMDD は ******** に置き換わります。

    例: ********123000.000000-420 は夏時間が有効になっているときの 12:30 pm PST を示します。

  • (uint32, #write) JobId

    JobId パラメータは、ジョブの識別子番号を表します。 このパラメータは、このコンピュータにスケジュールされているジョブへのハンドルです。

Returns:

  • (uint32)


55
56
# File 'lib/Win32_ScheduledJob.rb', line 55

def Create Command, DaysOfMonth, DaysOfWeek, InteractWithDesktop, RunRepeatedly, StartTime
end

- (uint32) Delete

Delete メソッドはスケジュールされたジョブを削除します。 メソッドは次のように変換される整数値を返します: 0 - 正常に完了しました。

1 - サポートされていません。

2 - アクセスが拒否されました。

8 - 不明なエラーです。

9 - パスが見つかりません。

21 - パラメータが無効です。

22 - サービスは開始していません。

その他 - 上の一覧以外の整数値については Win32 エラー コードのドキュメントを参照してください。

Returns:

  • (uint32)


77
78
# File 'lib/Win32_ScheduledJob.rb', line 77

def Delete 
end