nn::hio::CTR Namespace

Description

Namespace for the CTR HIO (Host IO) functionality.
(This can also be written without the ::CTR portion.)

Host IO provides three methods of communicating with a PC: files, serial communication, and shared memory.

Files

Files and directories on a PC can be accessed using the nn::hio::CTR::HostFile and nn::hio::CTR::HostDirectoryA classes.

To use the HostFile class, you must run the PARTNER-CTR HIO-Daemon on the PC.

Serial Communication

The nn::hio::CTR::SerialChannel class provides a means of bidirectional communication with programs running on the PC.

The PC must be running a program that performs serial communication.

Shared Memory

The nn::hio::CTR::SharedMemoryChannel class provides shared memory that can be accessed from both the PC and the CTR system.

The PC must be running a program that uses Host IO shared memory.

Using Channels

The serial communication and shared memory features of the Host IO library use channels to communicate. You can use multiple channels simultaneously. However, use a single process and a single thread for all channel operations. Serial sending and receiving can be done in separate threads.

Classes

nn::hio::CTR::HostDirectoryA Class that represents directories in the host file system. It can be used to get information about the entries that belong to directories.
nn::hio::CTR::HostDirectoryW Unicode version of the HostDirectoryA class.
nn::hio::CTR::HostFile Class that represents files in the host file system. It provides the ability to read from and write to files.
nn::hio::CTR::SerialChannel Class that represents the channels used for serial communication.
nn::hio::CTR::SharedMemoryChannel Class that represents the channels used for shared memory.

Structures

nn::hio::CTR::HostSystemTime Structure representing time stamps.
nn::hio::CTR::DirectoryEntryA Structure representing directory entries.
nn::hio::CTR::DirectoryEntryW Unicode version of the DirectoryEntryA class.

Enumerated Types

FileAttribute Enumerated type that represents file attributes.
ResultDescription Displays error details.

Constants

WORKMEMORY_SIZE const size_t Size of the work memory required to open a channel.
MAX_CHANNEL_NUM const size_t Maximum number of channels.
MAX_PATH const int Represents the maximum allowable path length. This value includes the null terminator at the end of the path.

Functions

Initialize/Finalize
Initialize Initializes the HIO library. Call this function once before using the library.
Finalize Finalizes the HIO library. Call this function once after using the library.
Other
GetHioDaemonStatus Gets whether the HostIO daemon process is running on the host.
GetVersion Gets the version of the HIO library.
DeleteFile Deletes file and returns the result of the process.
DeleteDirectory Deletes directory and returns the result of the process.
CreateDirectory Creates directory and returns the result of the process.
Rename Changes file/directory name and returns the result of the process.
GetCurrentDirectory Gets the current directory and returns the result of the process.
SetCurrentDirectory Sets the current directory and returns the result of the process.
GetEnvironmentVariable Gets the environment variable and returns the result of the process.
ResultNoConnected Returns a Result value indicating that there is no connection.
ResultConnected Returns a Result value indicating that the local host is connected.

Revision History

2010/06/14
Added descriptions of the various functions.
2010/03/03
Initial version.

CONFIDENTIAL