PrlIPPrivNet_GetName Function

Returns the name of the specified private network.

Syntax

PRL_RESULT PrlIPPrivNet_GetName(
    PRL_HANDLE hPrivNet, 
    PRL_STR sName, 
    PRL_UINT32_PTR pnNameBufLength
);

File

PrlApi.h

Parameters

hPrivNet

A handle of type PHT_IPPRIV_NET identifying the private network.

sName

[out] A pointer to a buffer that receives the result (a UTF-8 encoded, null-terminated string).

pnNameBufLength

[in] The size of the output buffer (in bytes). Set the buffer pointer to null and this parameter's value to zero to receive the required size. [out] The required output buffer size.

Returns

PRL_RESULT . Possible values are:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_BUFFER_OVERRUN - the size of the output buffer is not large enough. The parameter that is used to specify the size will contain the required size.

PRL_ERR_SUCCESS - function completed successfully.

Links

PrlApi.h , PHT_IPPRIV_NET