The Application Object: 1.3 GenApplication Basics: Application Instance Reference

| Up: GEOS SDK TechDocs | Up | Prev: 1.2 Application GCN Lists | Next: 1.4 Attach and Launch Flags 
GAI_appRef, GAI_appMode, GAI_optFlags, MSG_GEN_APPLICATION_SET_APP_MODE_MESSAGE, MSG_GEN_APPLICATION_GET_APP_MODE_MESSAGE, MSG_GEN_APPLICATION_SET_APP_INSTANCE_REFERENCE, MSG_GEN_APPLICATION_GET_APP_INSTANCE_REFERENCE, MSG_GEN_APPLICATION_SEND_APP_INSTANCE_REFERENCE_TO_FIELD

GAI_ appRef stores information (within an AppInstanceReference structure) that allows a GenApplication object to be reloaded from its former state. This structure contains a path name, long file name, and disk handle of a state file as well as an additional byte of disk data. The system automatically manages this state file and this instance field.

GAI_ appMode stores the application message that should be sent to the process to bring this application back from a saved state. This is initially null (unless previously saved to a state file); it is set by GenProcessClass when a mode is determined at MSG_META_ATTACH time. You should not alter this instance field.

GAI_ optFlags stores miscellaneous optimization flags. The only flag at this time--AOF_MULTIPLE_INIT_FILE_CATEGORIES--indicates that within this application there may be several different init file categories (marked with ATTR_GEN_INIT_FILE_CATEGORY). This allows MSG_META_GET_INI_CATEGORY to perform a full upward recursive search to find the appropriate init file category; by default, if an init file category is not found on an object, only the GenApplication object is queried.

MSG_GEN_APPLICATION_SET_APP_MODE_MESSAGE

void	MSG_GEN_APPLICATION_SET_APP_MODE_MESSAGE(
        Message modeMessage);

This message stores a message into the GenApplication's GAI_appMode field. Generally, this message indicates the current mode of the application. Should the application be shut down and restored, this message will be sent to the Process object to restore the state to the same mode.

Source: Rarely used.

Destination: Any GenApplication object.

Parameters: modeMessage The message number to be stored in GAI_appMode .

Return: Nothing.

Interception: Do not intercept.

MSG_GEN_APPLICATION_GET_APP_MODE_MESSAGE

Message	MSG_GEN_APPLICATION_GET_APP_MODE_MESSAGE();

This message returns the message number stored in the GenApplication's GAI_appMode field.

Source: Rarely used.

Destination: Any GenApplication object.

Parameters: None.

Return: The message number stored in GAI_appMode .

Interception: Do not intercept.

MSG_GEN_APPLICATION_SET_APP_INSTANCE_REFERENCE

void	MSG_GEN_APPLICATION_SET_APP_INSTANCE_REFERENCE(
        Handle	appInstance);

This message sets the GAI_appRef field to the passed structure.

Source: Rarely used.

Destination: Any GenApplication object.

Parameters: appInstance The handle of the reference data block.

Return: Nothing.

Interception: Do not intercept.

MSG_GEN_APPLICATION_GET_APP_INSTANCE_REFERENCE

Handle	MSG_GEN_APPLICATION_GET_APP_INSTANCE_REFERENCE();

This message retrieves the values in GAI_appRef .

Source: Rarely used.

Destination: Any GenApplication object.

Parameters: None.

Return: The handle of the reference stored in GAI_appRef .

Interception: Do not intercept.

MSG_GEN_APPLICATION_SEND_APP_INSTANCE_REFERENCE_TO_FIELD

void	MSG_GEN_APPLICATION_SEND_APP_INSTANCE_REFERENCE_TO_FIELD();

This message causes the GenApplication to send the contents of its GAI_appRef field off to its parent GenField object.

Source: Rarely used.

Destination: Any GenApplication object.

Interception: Do not intercept.

| Up: GEOS SDK TechDocs | Up | Prev: 1.2 Application GCN Lists | Next: 1.4 Attach and Launch Flags