TestConnection Method
Tests connectivity of the IIS Transform Manager service to the Scheduler object.
Namespace: Microsoft.Web.Media.TransformManager
Assembly: Microsoft.Web.Media.TransformManager.ServiceLibrary (in Microsoft.Web.Media.TransformManager.ServiceLibrary.dll)
Syntax
'Declaration
<OperationContractAttribute> _
Function TestConnection ( _
scheduler As JobScheduler, _
credential As Credential _
) As Boolean
'Usage
Dim instance As IManagementService
Dim scheduler As JobScheduler
Dim credential As Credential
Dim returnValue As Boolean
returnValue = instance.TestConnection(scheduler, _
credential)
[OperationContractAttribute]
bool TestConnection(
JobScheduler scheduler,
Credential credential
)
[OperationContractAttribute]
bool TestConnection(
JobScheduler^ scheduler,
Credential^ credential
)
[<OperationContractAttribute>]
abstract TestConnection :
scheduler:JobScheduler *
credential:Credential -> bool
function TestConnection(
scheduler : JobScheduler,
credential : Credential
) : boolean
Parameters
- scheduler
Type: Microsoft.Web.Media.TransformManager. . :: . .JobScheduler
The Scheduler object to test.
- credential
Type: Microsoft.Web.Media.TransformManager. . :: . .Credential
The Credential object that is required in order to run jobs and access resources.
Return Value
Type: System. . :: . .Boolean
true if the IIS Transform Manager service is able to connect to the Scheduler object; otherwise, false.
Exceptions
| Exception | Condition |
|---|---|
| InvalidOperationException | The test connection is not valid for a local scheduler. |
| FileNotFoundException | HPC client utilities are not installed. |
| InvalidDataException | The scheduler is not responding. |
Remarks
By default, IIS Transform Manager uses the task scheduler on the local server, but it also supports using an HPC scheduler. A credential is required in order to run jobs and access resources on the HPC cluster. That credential can be different from the credential that the IIS Transform Manager service is running under on the local server.