How to Use the vSphere Guest API

The vSphere Guest API defines functions and data types that you use to extract virtual machine data. This section covers the following topics:

vSphere Guest API Runtime Components
vSphere Guest API Data Types
vSphere Guest API Functions
vSphere Guest API Error Codes

vSphere Guest API Runtime Components
vSphere Guest API Data Types
vSphere Guest API Functions
The vSphere Guest SDK contains the header file vmGuestLib.h. This file declares the functions and data types that you use to call the vSphere Guest API. The following sections describe the vSphere Guest API functions:
vSphere Guest API Error Codes
Each vSphere Guest API function returns an error code. If successful, the returned error code is VMGUESTLIB_ERROR_SUCCESS. If the function is unable to complete its task, the error code provides information for diagnosing the problem.

Parent topic: The Guest Programming API