# OpenToRead

## Description

Opens a file stored on the local filesystem for reading into the specified ID. All platforms are restricted to a single folder for reading and writing so file paths must be relative, not absolute. This command will check the special write folder first, and if it cannot locate the file it will check the media folder, so you may load images, sounds, and other bundled media files using this command. On Raspberry Pi you can use this command to open a GPIO pin for reading by using the filename "gpio:" followed by the GPIO pin number, for example OpenToRead(1, "gpio:4"), this is case sensitive. You can then use ReadByte to read from the pin and CloseFile to close the pin.

## Definition

OpenToRead( ID, szFile )

void agk::OpenToRead( UINT ID, const char *szFile )

integer OpenToRead( szFile )

UINT agk::OpenToRead( const char *szFile )

## Parameters

- ID - The ID to use for referencing this file later.
- szFile - The filename to open for reading.