Cluster.QueueJob Method

Article
04/17/2009

Adds the specified job to the cluster and scheduling queue.

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

Usage

Syntax

'Declaration
Public Function QueueJob ( _
    job As IJob, _
    userName As String, _
    password As String, _
    isConsole As Boolean, _
    hwndParent As Integer _
) As Integer

public int QueueJob (
    IJob job,
    string userName,
    string password,
    bool isConsole,
    int hwndParent
)

public:
virtual int QueueJob (
    IJob^ job, 
    String^ userName, 
    String^ password, 
    bool isConsole, 
    int hwndParent
) sealed

public final int QueueJob (
    IJob job, 
    String userName, 
    String password, 
    boolean isConsole, 
    int hwndParent
)

public final function QueueJob (
    job : IJob, 
    userName : String, 
    password : String, 
    isConsole : boolean, 
    hwndParent : int
) : int

Parameters

job
A class that implements the IJob interface. To get a job object, call the Cluster.CreateJob method.

userName
The name of the RunAs user under which the job will run. The name is in the form domain\username. The user name is limited to 80 Unicode characters.

If userName is NULL, empty, or not valid, the cluster searches the calling user's credential cache for the credentials to use. If the cache contains only one credential, that credential is used. If the cache does not exist or contains multiple credentials, 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.

Return Value

The job identifier. The identifier is unique within the cluster. Note that identifiers for jobs that are no longer in the cluster are reused.

Remarks

The Job class implements the IJob interface.

Calling this method is the same as calling both the Cluster.AddJob and Cluster.SubmitJob methods.

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