org.virtualbox_5_1
Enum GuestSessionWaitResult

java.lang.Object
  extended by java.lang.Enum<GuestSessionWaitResult>
      extended by org.virtualbox_5_1.GuestSessionWaitResult
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<GuestSessionWaitResult>

public enum GuestSessionWaitResult
extends java.lang.Enum<GuestSessionWaitResult>

Guest session waiting results. Depending on the session waiting flags (for more information seeGuestSessionWaitForFlag) the waiting result can vary based on the session's current status. To wait for a guest session to terminate after it has been created byIGuest.createSession(String,String,String,String)one would specify GuestSessionWaitResult_Terminate. Interface ID: {C0F6A8A5-FDB6-42BF-A582-56C6F82BCD2D}


Enum Constant Summary
Error
          Error while executing the process.
None
          No result was returned.
Start
          The guest session has been started.
Status
          The guest session has changed its status.
Terminate
          The guest session has been terminated.
Timeout
          The waiting operation timed out.
WaitFlagNotSupported
          A waiting flag specified in theIGuestSession.waitFor(Long,Long)call is not supported by the guest.
 
Method Summary
static GuestSessionWaitResult fromValue(long v)
           
static GuestSessionWaitResult fromValue(java.lang.String v)
           
 int value()
           
static GuestSessionWaitResult valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static GuestSessionWaitResult[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

None

public static final GuestSessionWaitResult None
No result was returned. Not being used.


Start

public static final GuestSessionWaitResult Start
The guest session has been started.


Terminate

public static final GuestSessionWaitResult Terminate
The guest session has been terminated.


Status

public static final GuestSessionWaitResult Status
The guest session has changed its status. The status then can be retrieved viaIGuestSession.getStatus().


Error

public static final GuestSessionWaitResult Error
Error while executing the process.


Timeout

public static final GuestSessionWaitResult Timeout
The waiting operation timed out. This also will happen when no event has been occurred matching the current waiting flags in aIGuestSession.waitFor(Long,Long)call.


WaitFlagNotSupported

public static final GuestSessionWaitResult WaitFlagNotSupported
A waiting flag specified in theIGuestSession.waitFor(Long,Long)call is not supported by the guest.

Method Detail

values

public static GuestSessionWaitResult[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (GuestSessionWaitResult c : GuestSessionWaitResult.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static GuestSessionWaitResult valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

value

public int value()

fromValue

public static GuestSessionWaitResult fromValue(long v)

fromValue

public static GuestSessionWaitResult fromValue(java.lang.String v)