SessionBase.GetProperty Method

Gets the value of a backend-specific property for a session.


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

'Usage
Dim instance As SessionBase
Dim name As String
Dim returnValue As T

returnValue = instance.GetProperty(name)

public T GetProperty<T> (
	string name
)
J# supports the use of generic APIs, but not the declaration of new ones.
JScript does not support generic types or methods.

GenericParameters

T

The data type of the property for which you want to get the value. For information about the properties for which you can get a value and their data types, see the description for the name parameter.

Parameters

name

String that specifies the name of the property for which you want to get the value. The property names that you can specify are HPC_ServiceJobId, HPC_Headnode, and HPC_ServiceJobStatus, which is a string that indicates the current status of the service job for the session.

Return Value

An item with the data type that the T type parameter specifies and which contains the value of the property that the name parameter specifies. The following table describes the return values and their types for the properties for which you can get values.
Property name Type Description

HPC_ServiceJobId

int

Indicates the identifier of the service job for the session.

HPC_Headnode

string

Indicates the head node of the HPC cluster on which the session runs.

HPC_ServiceJobStatus

string

Indicates the current state of the service job for the session. The possible values for this state are the same as the names of the constants in the JobState enumeration.

This method does not support getting the values of custom properties.

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

Community Additions

ADD
Show: