osRead function
Declaration:
BOOL osRead( HANDLE Handle, PVOID Buffer, SIZE Size, struct TIORequest *IORequest );
Parameters:
Handle
A handle to the object.
Buffer
A pointer to the buffer that will receive the data.
Size
The number of bytes to be read.
IORequest
A pointer to a TIORequest structure containing additional configuration (may be NULL if not required).
Return value:
Returns TRUE on success or FALSE on failure. Call the osGetLastError function to obtain extended error information.
Description:
The osRead function reads data from the specified object. It is designed for use with objects such as streams, queues, and mailboxes. The function fails if the object specified by the handle does not permit read operations.
The IORequest parameter allows the caller to specify a timeout for the read operation and retrieves the number of bytes actually read.
This function is available only when OS_READ_WRITE_FUNC is set to 1.
| Version: | 1.0 |
|---|---|
| Header file: | OS_API.h |
| See also: | BOOL, FALSE, HANDLE, interprocess communication, OS_READ_WRITE_FUNC, osGetLastError, osWrite, PVOID, SIZE, TIORequest, TRUE |
SpaceShadow documentation