Session.Close Method (Boolean)

Closes the session and optionally finishes the job for the session and deletes the response messages.


Namespace: Microsoft.Hpc.Scheduler.Session
Assembly: Microsoft.Hpc.Scheduler.Session (in Microsoft.Hpc.Scheduler.Session.dll)

'Usage
Dim instance As Session
Dim purge As Boolean

instance.Close(purge)

public void Close (
	bool purge
)
public void Close (
	boolean purge
)
public function Close (
	purge : boolean
)

Parameters

purge

A Boolean object that specifies whether to finish the job for the session and delete the response messages. True finishes the job for the session and deletes the response messages. False indicates that the method should not finish the job for the session and should not delete the response messages.

When you create a session, you will also start a new job. To close the job and the session, use Close(Boolean)(true). To close the job but keep the durable session active, use Close(Boolean)(false). If you use Close(Boolean)(false) on a durable session, you will still be able to attach to the session after the job completes by using the AttachSession method.

Calling this method with the purge parameter set to false is equivalent to calling the Close method.

The default timeout period for finishing the job and deleting the response messages is 60,000 milliseconds. To specify a specific length for the timeout period, use the Close(Boolean,Int32) method instead.

Platform Note: This method was introduced in Windows HPC Server 2008 R2 and is not supported in earlier versions.


No members of this type are thread safe.

Development Platforms

Windows XP, Windows Vista, Windows 7, Windows 8, Windows Server 2003, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012

Target Platforms

Windows XP, Windows Vista, Windows 7, Windows 8, Windows Server 2003, Windows Server 2003 R2, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012, with HPC Pack Client Utilities




Build Date:

2013-04-22
Show: