PrlFsEntry_GetRelativeName Function

Returns the file system entry relative name.

Syntax

PRL_RESULT PrlFsEntry_GetRelativeName(
    PRL_HANDLE hFsEntry, 
    PRL_STR sRelativeName, 
    PRL_UINT32_PTR pnRelativeNameBufLength
);

File

PrlApi.h

Parameters

hFsEntry

A handle of type PHT_REMOTE_FILESYSTEM_ENTRY identifying the file system entry.

sRelativeName

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

pnRelativeNameBufLength

[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_REMOTE_FILESYSTEM_ENTRY