PrlVmCfg_GetVNCWebSocketPort Function

Returns the VNC WebSocket port number for the specified virtual machine.

Syntax

PRL_RESULT PrlVmCfg_GetVNCWebSocketPort(
    PRL_HANDLE hVmCfg, 
    PRL_UINT32_PTR pnVmRemoteDisplayWebSocketPort
);

PrlApiVm.h

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

pnVmRemoteDisplayPort

[out] A pointer to a variable that receives the result.

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.