PrlVmInfo_IsVncServerStarted Function

Determines whether a VNC server is running for the specified virtual machine.

Syntax

PRL_RESULT PrlVmInfo_IsVncServerStarted(
    PRL_HANDLE handle, 
    PRL_BOOL_PTR pbIsVncServerStarted
);

PrlApiVm.h

handle

A handle of type PHT_VM_INFO.

pbIsVncServerStarted

[out] A pointer to a variable that receives the result. PRL_TRUE indicates that a VNC server is running. PRL_FALSE indicates otherwise.

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_NO_DATA - the VNC server state information is not available.

PRL_ERR_SUCCESS - function completed successfully.