Up: GEOS SDK TechDocs | Up | Prev: GeodeAllocQueue() ... | Next: GeodeLoadDGroup ...

GeodeGetAppObject()

optr	GeodeGetAppObject(
        GeodeHandle gh);			/* handle of the application geode */

This routine returns the optr of the specified geode's GenApplication object. The geode should be an application. Pass zero to get the optr of the caller's application object.

Include: geode.h

GeodeGetCodeProcessHandle()

GeodeHandle GeodeGetCodeProcessHandle();

This routine returns the geode handle of the geode that owns the block in which the code which calls this routine resides.

Include: geode.h

GeodeGetDefaultDriver()

GeodeHandle GeodeGetDefaultDriver(
        GeodeDefaultDriverType type);		/* type of default driver to get */

This routine returns the default driver's geode handle for the type passed. The type must be one of the values of GeodeDefaultDriverType .

Include: driver.h

GeodeGetInfo()

word	GeodeGetInfo(
        GeodeHandle	  gh,			/* handle of the subject geode */
        GeodeGetInfoType  info,			/* type of information to return */
        void	 	* buf);			/* buffer to contain returned info */

This routine returns information about the specified geode. The geode must be loaded already. The meaning of the returned word depends on the value passed in info ; the GeodeGetInfoType is shown below. Pass the following:

gh
The geode handle of the geode. If gh is null then the routine will return the information of the current geode.
info
The type of information requested; this should be one of the values listed below.
buf
A pointer to a locked or fixed buffer which will contain returned information for various types requested.

GeodeGetInfoType has the following enumerations (only one may be requested at a time):

GGIT_ATTRIBUTES
Get the geode's attributes. The return value will be a record of GeodeAttrs corresponding to those attributes set for the geode. Pass a null buffer pointer.
GGIT_TYPE
Get the type of the geode. The returned value will be a value of GeosFileType indicating the type of file storing the geode. Pass a null buffer pointer.
GGIT_GEODE_RELEASE
Get the release number of the geode. The returned word will be the size of the buffer pointed to by buf , and the buffer will contain the ReleaseNumber structure of the geode.
GGIT_GEODE_PROTOCOL
Get the protocol level of the geode. The returned word will be the size of the buffer pointed to by buf , and the buffer will contain the ProtocolNumber structure of the geode.
GGIT_TOKEN_ID
Get the token identifier of the geode. The returned word will be the size of the buffer pointed to by buf , and the buffer will contain a GeodeToken structure containing the token characters and token ID of the geode's token.
GGIT_PERM_NAME_AND_EXT
Get the permanent name of the geode, with the extension characters. The returned word will be the size of the buffer pointed to by buf , and the buffer will contain a null-terminated character string representing the geode's permanent name (as set in its geode parameters file). Note that the buffer must be at least 13 bytes.
GGIT_PERM_NAME_ONLY
Get the permanent name of the geode without the extension characters. The returned word will be the size of the buffer pointed to by buf, and the buffer will contain the null-terminated character string representing the geode's permanent name. The buffer must be at least nine bytes.

Include: geode.h

GeodeGetOptrNS()

optr	GeodeGetOptrNS(
        optr	obj);

This routine unrelocates an optr, changing the virtual-segment handle to an actual global handle.

Include: resource.h

GeodeGetProcessHandle()

GeodeHandle GeodeGetProcessHandle();

This routine returns the geode handle of the current executing process (i.e. the owner of the current running thread). Use it when you need to pass your application's geode handle or Process object's handle to a routine or message.

Include: geode.h

GeodeGetUIData()

word	GeodeGetUIData(
        GeodeHandle		gh);

Include: geode.h

GeodeInfoDriver()

DriverInfoStruct  * GeodeInfoDriver(
        GeodeHandle gh);	 /* handle of the driver to get information about */

This routine returns information about the specified driver geode. Pass the geode handle of the driver as returned by GeodeUseDriver() . It returns a pointer to a DriverInfoStruct structure, shown below.

typedef struct {
    void			(*DIS_strategy)();
    DriverAttrs			DIS_driverAttributes;
    DriverType			DIS_driverType;
} DriverInfoStruct;

For full information on this structure, see the DriverInfoStruct reference entry.

Include: driver.h

GeodeInfoQueue()

word	GeodeInfoQueue(
        QueueHandle qh);			/* queue to query */

This routine returns information about a specific event queue. Pass the handle of the queue; for information about the current process' queue, pass a null handle. This routine returns the number of events (or messages) currently in the queue.

Include: geode.h

GeodeLoad()

GeodeHandle GeodeLoad(
        const char *		name,				/* file name of geode */
        GeodeAttrs		attrMatch,				/* GeodeAttrs that must be set */
        GeodeAttrs		attrNoMatch,				/* GeodeAttrs that must be clear */
        word		priority,				/* priority of the loaded geode */
        dword		appInfo,				/* special load information */
        GeodeLoadError *		err);				/* returned error value */

This routine loads the specified geode from the given file and then executes the geode based on its type. It returns the geode handle of the loaded geode if successful; if unsuccessful, the returned value will be NullHandle and the err pointer will point to an error value. Pass this routine the following:

name
A pointer to the name of the geode's file. This is a null-terminated character string that represents the full path of the file (or a path relative to the current working directory).
attrMatch
A record of GeodeAttrs that must be set in the specified geode for the load to be successful.
attrNoMatch
A record of GeodeAttrs that must be cleared in the specified geode for the load to be successful. (That is, each bit which is set in attrNoMatch must be clear in the geode's GeodeAttrs field.)
priority
If the subject geode is a process, this is the priority at which its process thread will run.
appInfo
Two words of data to be passed directly to the loaded geode. For libraries and drivers, this should be a far pointer to a null-terminated string of parameters.
err
A pointer to an empty GeodeLoadError which will hold any returned error values.

Warnings: If you load a geode dynamically with GeodeLoad() , you must be sure to free it when you are done with GeodeFreeDriver() or GeodeFreeLibrary() .

Include: geode.h

See Also: UserLoadApplication().


Up: GEOS SDK TechDocs | Up | Prev: GeodeAllocQueue() ... | Next: GeodeLoadDGroup ...