PrlVirtNet_SetDescription Function

Sets the specified virtual network description.

Syntax

PRL_RESULT PrlVirtNet_SetDescription(
    PRL_HANDLE hVirtNet, 
    PRL_CONST_STR sDescription
);

PrlApiNet.h

hVirtNet

A handle of type PHT_VIRTUAL_NETWORK identifying the virtual network.

sDescription

The value to set. The value must be a a UTF-8 encoded, null-terminated string.

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.