DriverReadFile

Read file through the driver, whilst inheriting driver privileges (e.g. access to blocked drives); this method relies on the event handler API to receive notifications when each file chunk is read. If launched normally (rather than asynchronously), this method will block until the file is read in full. In order to use this method, you must first configure a memory buffer as part of registering an event handler for event type '5'. Requires administrative privileges.

Syntax

Method ID

#define WAAPI_MID_DRIVER_READ_FILE 29020

JSON Input Structure

{
  "input": {
    "method": 29020,
    "path": string,
    "handler_id": number
  }
}

Input Properties

Parameter	Type	Description
path	string	Path of the file to be read.
handler_id	number	The handler ID returned by wa_api_register_handler function - which indirectly indicates which buffer will be used for reading.

JSON Output Structure

{
  "result": {
    "method": 29020,
    "code": number,
    "timing": number,
    "timestamp": string
  }
}

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 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.

See Also

• Getting Started Guide

---

Last updated: 2026-10-01