DriverListDirectory

List directory contents at given path, in terms of files and folders contained within (non-recursive). Directory can be located on a blocked drive. Requires administrative privileges.

Syntax

Method ID

#define WAAPI_MID_DRIVER_LIST_DIRECTORY 29019

JSON Input Structure

{
  "input": {
    "method": 29019,
    "path": string
  }
}

Input Properties

Parameter	Type	Description
`path`	string	Path of the directory which will be queried for content.

JSON Output Structure

{
  "result": {
    "method": 29019,
    "code": number,
    "timing": number,
    "timestamp": string,
    "base_path": string,
    "files": [
      {
        "name": string,
        "size": string,
        "last_modified_time": number
      },
      ...
    ],
    "folders": [
      {
        "name": string,
        "last_modified_time": number
      },
      ...
    ]
  }
}

Output Properties

Property	Type	Description
`result.method`	number	The method ID that generated this result.
`result.code`	number	The result code. See Result Codes.
`result.timing`	number	The measured time for the method call in milliseconds.
`result.timestamp`	string	The timestamp in seconds of when the call was made.
`result.base_path`	string	Full path to base target.
`result.files`	array<object>	List of files present at the supplied base path.
`result.files.name`	string	Name of the file.
`result.files.size`	string	Size of the file, in bytes.
`result.files.last_modified_time`	number	Last modification timestamp of the file.
`result.folders`	array<object>	List of directories present at the supplied base path.
`result.folders.name`	string	Name of the folder.
`result.folders.last_modified_time`	number	Last modification timestamp of the folder.

Result Codes

Code	Name	Description
0	`WAAPI_OK`	The operation completed successfully.

note

Other codes may be returned. See the full Result Codes reference for the complete list.

Remarks

Error Handling

The results of this function are determined by the error code returned by the call. If successful, WAAPI_OK or a special success code will be returned. Always check both the function return value and the result.code field in the output JSON.

Examples

Examples will be added here demonstrating the usage of this method.

Syntax​

Method ID​

JSON Input Structure​

Input Properties​

JSON Output Structure​

Output Properties​

Result Codes​

Remarks​

Error Handling​

Examples​

See Also​