Метод SPRunningJobCollection.GetInstance

Статья
05/13/2015

Возвращает экземпляр объекта SPRunningJob или создает исключение, если этот объект не существует.

Пространство имен: Microsoft.SharePoint.Administration
Сборка: Microsoft.SharePoint (в Microsoft.SharePoint.dll)

Синтаксис

'Декларация
Public Function GetInstance ( _
    jobDefinitionId As Guid, _
    serverName As String _
) As SPRunningJob
'Применение
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
)

Параметры

jobDefinitionId
Тип: System.Guid

Guid SPJobDefinition объект, представляющий задания, на котором работает.

serverName
Тип: System.String

String , представляющий имя SPServer , на котором выполняется задание.

Возвращаемое значение

Тип: Microsoft.SharePoint.Administration.SPRunningJob
Объект SPRunningJob , который представляет этот экземпляр.

Исключения

Исключение	Условие
ArgumentOutOfRangeException	Недопустимый параметр или задания только что был удален.

Замечания

Может существовать несколько экземпляров на нескольких серверах или задача может быть только один экземпляр работает в ферме за раз.

Примеры

В следующем примере кода выполняется итерация по служб на ферме SharePoint Foundation для отображения сведений о каждое задание, которое выполняется для каждой службы или еще не были удалены из SPRunningJobCollection , связанные с каждой службы. Для объектов SPRunningJob все программного взаимодействия — это со свойствами; методы доступны в объекте SPRunningJobCollection , позволяющие разработчику взаимодействуют с экземпляром определенного объекта SPRunningJob .

[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);
  }
}