PrlVmGuest_GetNetworkSettings Function

Obtains network settings of a guest operating system running in a virtual machine.

Syntax

PRL_HANDLE PrlVmGuest_GetNetworkSettings(
    PRL_HANDLE hVmGuest, 
    PRL_UINT32 nReserved
);

File

PrlApiVm.h

Parameters

hVmGuest

A handle of type PHT_VM_GUEST_SESSION identifying the user session in a virtual machine. The handle is obtained using the PrlVm_LoginInGuest function.

nReserved

Reserved parameter for future purposes. Must be 0 in the current implementation.

Returns

A handle of type PHT_JOB containing the results of this asynchronous operation or PRL_INVALID_HANDLE if there's not enough memory to instantiate the job object.

Remarks

The network settings are obtained using a user session in the guest operating system. Prior to calling this function, a handle to a user session in the virtual machine must be obtained using the PrlVm_LoginInGuest function.

To get the return code from the PHT_JOB object, use the PrlJob_GetRetCode function. Possible values are:

PRL_ERR_INVALID_ARG - invalid handle was passed. PRL_ERR_SUCCESS - function completed successfully.

To get the results from the returned PHT_JOB object, use the following steps:

Use the PrlJob_GetResult function to obtain a handle of type PHT_RESULT.
Use the PrlResult_GetParam function to obtain a handle of type PHT_SERVER_CONFIG. The handle will contain the guest OS network settings.

Once you obtain the PHT_SERVER_CONFIG handle, you can use the following functions to obtain individual network settings of the guest OS:

PrlSrvCfg_GetDnsServers

PrlSrvCfg_GetHostname

PrlSrvCfg_GetSearchDomains

PrlSrvCfg_GetNetAdapter

PrlSrvCfg_GetDefaultGateway

Links

PHT_VM_GUEST_SESSION