promptblock_t* msg_open

(char* name)

Open a prompt block.

Documentation

Open a prompt block.

Opens a prompt block file, validates its magic number, reads its index and creates a descriptor for it. The descriptor is automatically allocated by the function, just like fopen() allocates a new FILE.

The current block (msg_cur) becomes the last block ( msg_last). The newly opened block becomes the current block. If the function is called from a user-servicing module, the user's language is also selected for subsequent prompting.

Parameters:

name - The basename of the prompt block file, without its .mbk suffix. By convention, prompt blocks are named the same as the directory of their modules (and, in most cases, the main module source file). This isn't binding, though.

Returns:

A pointer to a freshly allocated prompt block descriptor. This function always returns on success. Failure causes the process to halt with a fatal error.

Alphabetic index