PrlSrvCfgDev_GetName Function

Obtains the device name.

Syntax

PRL_RESULT PrlSrvCfgDev_GetName(
    PRL_HANDLE hGenericDevice, 
    PRL_STR sDevName, 
    PRL_UINT32_PTR pnDevNameBufLength
);

File

PrlApiDisp.h

Parameters

hGenericDevice

A handle of type PHT_HW_GENERIC_DEVICE, or one of the descendant types, identifying the device.

sDevName

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

pnDevNameBufLength

[in] The size of the output buffer (in bytes). Set the buffer pointer to null and this 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

PHT_HW_GENERIC_DEVICE