SPRunningJobCollection.GetInstance-Methode

Artikel
05/06/2015

Ruft eine Instanz eines SPRunningJob -Objekts ab, oder löst eine Ausnahme aus, wenn dieses Objekt nicht vorhanden ist.

Namespace: Microsoft.SharePoint.Administration
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Public Function GetInstance ( _
    jobDefinitionId As Guid, _
    serverName As String _
) As SPRunningJob
'Usage
Dim instance As SPRunningJobCollection
Dim jobDefinitionId As Guid
Dim serverName As String
Dim returnValue As SPRunningJob

returnValue = instance.GetInstance(jobDefinitionId, _
    serverName)

public SPRunningJob GetInstance(
    Guid jobDefinitionId,
    string serverName
)

Parameter

jobDefinitionId
Typ: System.Guid

Guid des SPJobDefinition -Objekts, das den Auftrag darstellt, der ausgeführt wird.

serverName
Typ: System.String

Eine String , die den Namen des der SPServer darstellt, auf dem der Auftrag ausgeführt wird.

Rückgabewert

Typ: Microsoft.SharePoint.Administration.SPRunningJob
Ein SPRunningJob -Objekt, das diese Instanz darstellt.

Ausnahmen

Ausnahme	Bedingung
ArgumentOutOfRangeException	Ungültiger Parameter oder Auftrag wurde soeben gelöscht.

Hinweise

Es möglicherweise mehrere Instanzen auf mehreren Servern oder konnte der Auftrag auf eine ausgeführte Instanz in der Farm beschränkt werden.

Beispiele

Im folgenden Codebeispiel wird durchlaufen und die Dienste in einer Farm SharePoint Foundation , um Informationen zu jedem Auftrag anzuzeigen, die für jeden Dienst ausgeführt wird, oder noch nicht aus der einzelnen Dienste zugeordnet SPRunningJobCollection gelöscht wurde. SPRunningJob -Objekte werden alle programmgesteuerte Interaktion mit Eigenschaften. Methoden stehen zur Verfügung, in das SPRunningJobCollection -Objekt, das die Implementierung für die Interaktion mit einer bestimmten Instanz eines SPRunningJob -Objekts zuzulassen.

[C#]

SPFarm farm = SPFarm.Local.Farm;
SPServiceCollection services = SPFarm.Local.Services;
int rand_job;
Guid jobdefid;
SPRunningJob rj;
string servername;
string svc_name = string.Empty;
 foreach (SPService service in services) {
  SPRunningJobCollection runningJobs = service.RunningJobs;
  if (runningJobs.Count > 0) {
    if (svc_name == string.Empty) {
       svc_name = service.Name;
    }
    Console.WriteLine("****Job Collection Count is     " + runningJobs.Count);
    Console.WriteLine("****Job Collection Service is   " + runningJobs.Service);
    // For the GetInstance method, save off job information at random
    rand_job = runningJobs.Count / 2;
    Console.WriteLine("****Collection member " + rand_job + " is " + runningJobs[rand_job].JobDefinition);
    jobdefid = runningJobs[rand_job].JobDefinitionId;
    servername = runningJobs[rand_job].ServerName;
  }
  else {
    jobdefid = Guid.Empty;
    servername = null;
  }
  foreach (SPRunningJob runningJob in runningJobs) {
    Console.WriteLine("****Job Id is           " + runningJob.JobDefinitionId);
  }
  if (jobdefid != Guid.Empty) {
    // random jobdef from collection 
    // getinstance method
    rj = runningJobs.GetInstance(jobdefid, servername);
    Console.WriteLine("*@@* Job Definition is   " + rj.JobDefinition);
    Console.WriteLine("*@@* Job Id is           " + rj.JobDefinitionId);
    Console.WriteLine("*@@* Job Title is        " + rj.JobDefinitionTitle);
  }
}