Cluster.SubmitJob Method

Article
04/17/2009

Adds the specified job to the scheduling queue.

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

Usage

Syntax

'Declaration
Public Sub SubmitJob ( _
    jobId As Integer, _
    userName As String, _
    password As String, _
    isConsole As Boolean, _
    hwndParent As Integer _
)

public void SubmitJob (
    int jobId,
    string userName,
    string password,
    bool isConsole,
    int hwndParent
)

public:
virtual void SubmitJob (
    int jobId, 
    String^ userName, 
    String^ password, 
    bool isConsole, 
    int hwndParent
) sealed

public final void SubmitJob (
    int jobId, 
    String userName, 
    String password, 
    boolean isConsole, 
    int hwndParent
)

public final function SubmitJob (
    jobId : int, 
    userName : String, 
    password : String, 
    isConsole : boolean, 
    hwndParent : int
)

Parameters

jobId
The job identifier. The Cluster.AddJob method returns this value. If you have a job object that has already been added to the cluster, you can access the Job.Id property to get the identifier.

userName
The name of the RunAs user, in the form domain\username. The user name is limited to 80 Unicode characters.

If userName is NULL, empty, or not valid, the service searches the credential cache for the credentials to use. If the cache contains only one credential, that credential is used. However, if multiple credentials exist in the cache, the user is prompted for the credentials.

password
The RunAs user's password. The password is limited to 127 Unicode characters. If this parameter is NULL or empty, the method uses the cached credentials (see Cluster.SetCachedCredentials). If the credentials are not cached, the current user is prompted for the credentials. If the isConsole parameter is true, the user is prompted in the console window; otherwise, the standard credentials dialog box is used.

isConsole
Set the value to true if the application is a console-mode application. Set the value to false if the application is a GUI application.

hwndParent
The handle to use as the parent window for the modal credentials dialog box. If 0, HWND_DESKTOP is used. The handle is ignored if isConsole is true.

Remarks

If the operation succeeds, the state of the job is Queued (see JobStatus). The job moves to the Running state when all required resources are available and the scheduler starts the job. Tasks are started in the order in which they were added to the job, except if there is a dependency (see Task.Depend).

You can submit a job that does not contain tasks to reserve resources for the job. If the Job.RunUntilCanceled property is true, the job is scheduled and runs indefinitely or until it exceeds the run-time limit set in the Job.Runtime property (then the job is canceled). If the RunUntilCanceled property is false, the state of the job moves to the finished status.

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