PrlSrv_FsGetDirEntries Function

Retrieves information about the specified file system entry residing on the specified host computer.

Syntax

PRL_HANDLE PrlSrv_FsGetDirEntries(
    PRL_HANDLE hServer, 
    PRL_CONST_STR path
);

File

PrlApiDisp.h

Parameters

hServer

A handle of type PHT_SERVER identifying the Parallels Service.

path

An absolute directory name and path, or drive letter (e.g. C:\) on the host computer for which to get the information.

Returns

A handle of type PHT_JOB containing the results of this asynchronous operation or PRL_INVALID_HANDLE if there's not enough memory to instantiate the job object.

Remarks

The information retrieved by the PrlSrv_FsGetDirEntries function includes the information about the specified entry and, if the entry is a directory, the information about its immediate child entries (files and subdirectories). On Windows, you can also specify a drive letter, in which case the information about the root directory entries will be retrieved.

To get the return code from the PHT_JOB object, use the PrlJob_GetRetCode function. Possible values are:

PRL_ERR_INVALID_ARG - invalid server handle was passed or invalid path was specified.

PRL_ERR_SUCCESS - function completed successfully.

To get the results from the PHT_JOB object:

Use the PrlJob_GetResult function to obtain a handle to the PHT_RESULT object.
Use the PrlResult_GetParam function to obtain a handle of type PHT_REMOTE_FILESYSTEM_INFO containing the file system entry information.

Links

PHT_SERVER