## Description

Include file: xjavaenv.h

### Functions

#### XJavaEnvironment

#### Parameters

XJavaConsoleMessageHandler* phnd Pointer to a console message handler object; if NULL is passed, then a default message handler is beeing installed. int argc Number of arguments that shall be passed to the Java runtime system. char** argv Array with strings containing the parameters; possible parameters are: -v|-verbose turn on verbose mode -debug enable remote Java debugging -noasyncgc don't allow asynchronous gc's -verbosegc print a message when gc occur -ssnumber set the C stack size of a process -ossnumber set the JAVA stack size of a process -msnumber set the initial Java heap size -mxnumber set the maximum Java heap size -classpath directories separated by semicolons list directories in which to look for classes -prof output profiling data to ./java.prof -verify verify all classes when read in -verifyremote verify classes read in over the network [default] -noverify do not verify any class

#### Remarks

The constructor of XJavaEnvironment initializes the Java virtual machines.

#### ~XJavaEnvironment

#### Remarks

Constructor for the XJavaEnvironment class.

#### DisplayError

#### Parameters

int rc Error number; possible values are: JAVA_OK no error JAVA_INVALID_APPLET inavlid applet code given JAVA_INVALID_CONTEXT inavlid applet context given JAVA_INVALID_PARAMETER invalid parameter JAVA_ALREADY_INITIALIZED Java runtime system already initialized JAVA_OUT_OF_MEMORY out of memory JAVA_EXCEPTION_OCCURRED Java exception occurred JAVA_NOT_INITIALIZED Java runtime system not initialized JAVA_INTERNAL_ERROR internal Java error

#### Remarks

Opens a message box and displays an error message

#### Get

#### Return-Value

XJavaEnvironment* pJEnv pointer to the actual Java environment object.

#### Remarks

Queries the pointer to the actual Java environment object.

#### GetMessageHandler

#### Return-Value

XJavaConsoleMessageHandler* pMsgHandler Pointer to the actual console message handler object.

#### Remarks

Queries the pointer to the actual console message handler object.

#### GetProperty

#### Parameters

const char* key Name of the key (refer to the Java documentation) char* value Value that the key has int buflen Length of the buffer for the value int* pvallen Real length of the key value

#### Return-Value

An error code is return; possible values are: JAVA_OK no error JAVA_INVALID_APPLET inavlid applet code given JAVA_INVALID_CONTEXT inavlid applet context given JAVA_INVALID_PARAMETER invalid parameter JAVA_ALREADY_INITIALIZED Java runtime system already initialized JAVA_OUT_OF_MEMORY out of memory JAVA_EXCEPTION_OCCURRED Java exception occurred JAVA_NOT_INITIALIZED Java runtime system not initialized JAVA_INTERNAL_ERROR internal Java error

#### Remarks

Queries a property value from the Java runtime system.

#### GetShowURLHandler

#### Parameters

XWindow* owner Pointer to the window object to which the handler belongs to.

#### Return-Value

Pointer to the actual url show handler object.

#### Remarks

Queries the pointer to the actual url show handler object.

#### GetStatusMsgHandler

#### Parameters

XWindow* owner Pointer to the window object to which the handler belongs to.

#### Return-Value

Pointer to the actual status message handler.

#### Remarks

Queries the pointer to the actual status message handler object.

#### GetVersion

#### Return-Value

int* piMajor The major version number. int* piMinor The Minor version number. An error code is return; possible values are: JAVA_OK no error JAVA_INVALID_APPLET inavlid applet code given JAVA_INVALID_CONTEXT inavlid applet context given JAVA_INVALID_PARAMETER invalid parameter JAVA_ALREADY_INITIALIZED Java runtime system already initialized JAVA_OUT_OF_MEMORY out of memory JAVA_EXCEPTION_OCCURRED Java exception occurred JAVA_NOT_INITIALIZED Java runtime system not initialized JAVA_INTERNAL_ERROR internal Java error

#### Remarks

Queries the version of J-Empower.

#### Iconify

#### Parameters

XWindow* pOwnerWnd - Owner window of the applets

#### Return-Value

An error code is return; possible values are: JAVA_OK no error JAVA_INVALID_APPLET inavlid applet code given JAVA_INVALID_CONTEXT inavlid applet context given JAVA_INVALID_PARAMETER invalid parameter JAVA_ALREADY_INITIALIZED Java runtime system already initialized JAVA_OUT_OF_MEMORY out of memory JAVA_EXCEPTION_OCCURRED Java exception occurred JAVA_NOT_INITIALIZED Java runtime system not initialized JAVA_INTERNAL_ERROR internal Java error

#### Remarks

Notifies the applets of a window that the window has been minimized.

#### SetMessageHandler

#### Parameters

XJavaConsoleMessageHandler* handler pointer to the handler object

#### Return-Value

An error code is return; possible values are: JAVA_OK no error JAVA_INVALID_APPLET inavlid applet code given JAVA_INVALID_CONTEXT inavlid applet context given JAVA_INVALID_PARAMETER invalid parameter JAVA_ALREADY_INITIALIZED Java runtime system already initialized JAVA_OUT_OF_MEMORY out of memory JAVA_EXCEPTION_OCCURRED Java exception occurred JAVA_NOT_INITIALIZED Java runtime system not initialized JAVA_INTERNAL_ERROR internal Java error

#### Remarks

Sets a new console message handler object. Please remember to delete the old message handler object if there is one.

#### SetProperty

#### Parameters

const char* key Name of the key (refer to the Java documentation) char* value New value that the key has

#### Return-Value

An error code is return; possible values are: JAVA_OK no error JAVA_INVALID_APPLET inavlid applet code given JAVA_INVALID_CONTEXT inavlid applet context given JAVA_INVALID_PARAMETER invalid parameter JAVA_ALREADY_INITIALIZED Java runtime system already initialized JAVA_OUT_OF_MEMORY out of memory JAVA_EXCEPTION_OCCURRED Java exception occurred JAVA_NOT_INITIALIZED Java runtime system not initialized JAVA_INTERNAL_ERROR internal Java error

#### Remarks

Sets a property value of the Java runtime system.

#### SetShowURLHandler

#### Parameters

XWindow* wnd pointer to the window object that holds an applet XJavaShowURLHandler* hnd pointer to the handler object

#### Return-Value

An error code is return; possible values are: JAVA_OK no error JAVA_INVALID_APPLET inavlid applet code given JAVA_INVALID_CONTEXT inavlid applet context given JAVA_INVALID_PARAMETER invalid parameter JAVA_ALREADY_INITIALIZED Java runtime system already initialized JAVA_OUT_OF_MEMORY out of memory JAVA_EXCEPTION_OCCURRED Java exception occurred JAVA_NOT_INITIALIZED Java runtime system not initialized JAVA_INTERNAL_ERROR internal Java error

#### Remarks

Sets a new console url show handler object. Please remember to delete the old handler object if there is one.

#### SetStatusMsgHandler

#### Parameters

XWindow* wnd pointer to the window object that holds an applet XJavaStatusMsgHandler* hnd pointer to the handler object

#### Return-Value

An error code is return; possible values are: JAVA_OK no error JAVA_INVALID_APPLET inavlid applet code given JAVA_INVALID_CONTEXT inavlid applet context given JAVA_INVALID_PARAMETER invalid parameter JAVA_ALREADY_INITIALIZED Java runtime system already initialized JAVA_OUT_OF_MEMORY out of memory JAVA_EXCEPTION_OCCURRED Java exception occurred JAVA_NOT_INITIALIZED Java runtime system not initialized JAVA_INTERNAL_ERROR internal Java error

#### Remarks

Sets a new status message handler object. Please remember to delete the old handler object if there is one.

#### Uniconify

#### Parameters

XWindow* pOwnerWnd - Owner window of the applets

#### Return-Value

An error code is return; possible values are: JAVA_OK no error JAVA_INVALID_APPLET inavlid applet code given JAVA_INVALID_CONTEXT inavlid applet context given JAVA_INVALID_PARAMETER invalid parameter JAVA_ALREADY_INITIALIZED Java runtime system already initialized JAVA_OUT_OF_MEMORY out of memory JAVA_EXCEPTION_OCCURRED Java exception occurred JAVA_NOT_INITIALIZED Java runtime system not initialized JAVA_INTERNAL_ERROR internal Java error

#### Remarks

Notifies the applets of a window that the window has been restored.

This document was generated by Jens von Pilgrim's Autodoc