VM Guest API Data Types
The VM Guest API uses the data types listed in Data Types to support access to virtual machine data.
| Data Type | Description |
| VMGuestLibHandle | Reference to virtual machine data. VMGuestLibHandle is defined in vmGuestLib.h. |
| VMSessionID | Unique identifier for a
session. The session ID changes after a virtual machine is migrated using
VMotion, suspended and resumed, or reverted to a snapshot. Any of these events
is likely to render any information retrieved with this API invalid. You can
use the session ID to detect those events and react accordingly. For example,
you can refresh and reset any state that relies on the validity of previously
retrieved information.
Use VMGuestLib_GetSessionId to obtain a valid session ID. A session ID is opaque. You cannot compare a virtual machine session ID with the session IDs from any other virtual machines.You must always call VMGuestLib_GetSessionId after calling VMGuestLib_UpdateInfo. VMSessionID is defined in vmSessionId.h. |
| VMGuestLibError | Status code that indicates success or failure. Each function returns a VMGuestLibError code. For information about specific error codes, see VM Guest API Error Codes. VMGuestLibError is an enumerated type defined in vmGuestLib.h. |