IJob.SetExtendedJobTerm Method

Article
04/17/2009

Sets the application-defined extended term on the job.

Namespace: Microsoft.ComputeCluster
Assembly: CcpAPI (in ccpapi.dll)

Usage

Syntax

'Declaration
Sub SetExtendedJobTerm ( _
    termName As String, _
    termValue As String _
)

void SetExtendedJobTerm (
    string termName,
    string termValue
)

void SetExtendedJobTerm (
    String^ termName, 
    String^ termValue
)

void SetExtendedJobTerm (
    String termName, 
    String termValue
)

function SetExtendedJobTerm (
    termName : String, 
    termValue : String
)

Parameters

termName
The name of the extended term to add. The term is limited to 80 Unicode characters.

termValue
The value of the extended term. The value is limited to 1,024 Unicode characters.

Remarks

Use this method to add or update your own terms that are passed to the submission and activation filters. For a list of predefined job terms, see the Remarks section of ICluster.ModifyJobTerm.

After adding the job to the cluster, use the Cluster.ModifyJobTerm to add or update the extended job terms.

To retrieve the current extended terms, access the IJob.ExtendedJobTerms property.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Microsoft Windows Compute Cluster Server 2003, Windows Server 2003, Windows XP

Target Platforms

Microsoft Windows Compute Cluster Server 2003, Windows Server 2003 with Compute Cluster Pack Client Utilities, Windows XP with Compute Cluster Pack Client Utilities