PrlVmDevSerial_GetSocketMode Function

Returns the socket mode of a virtual serial port.

Syntax

PRL_RESULT PrlVmDevSerial_GetSocketMode(
    PRL_HANDLE hVmDev, 
    PRL_SERIAL_PORT_SOCKET_OPERATION_MODE_PTR pnSocketMode
);

File

PrlApi.h

Parameters

hVmDev

A handle of type PHT_VIRTUAL_DEV_SERIAL_PORT identifying the serial port.

pnSocketMode

[out] Pointer to a variable that receives the socket mode.

Returns

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

Use this function to get the socket mode when the emulation type of the port is "socket". To get the port's emulation type, use the PrlVmDev_GetEmulatedType function.