QueryDriverForFileSystem

DEPRECATED

This method is deprecated and may be removed in a future release.

Will return list of files and sub-directories in specified directory (non-recursive). The directory can be on a blocked volume. Requires administrative privileges.

Syntax

Method ID

#define WAAPI_MID_DRIVER_QUERY_FILESYSTEM 29005

JSON Input Structure

{
  "input": {
    "method": 29005,
    "target_path": string
  }
}

Input Properties

Parameter	Type	Description
`target_path`	string	Path name of directory to list contents.

JSON Output Structure

{
  "result": {
    "method": 29005,
    "code": number,
    "timing": number,
    "timestamp": string,
    "file_structure": [
      {
        "name": string,
        "type": 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.file_structure`	array<object>	Contents of target directory (list of files and sub-directories).
`result.file_structure.name`	string	File or directory name.
`result.file_structure.type`	string	Can be: 'file' or 'directory'.
`result.file_structure.last_modified_time`	number	Last modification timestamp.

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​