GetActiveProjectIndex () : Dindex
JoPPS
Returns the index of the active project in the projectpool.
ì The index of the active project in the projectpool.
M A value of -1 is returned when no project is loaded. (the projectpool is empty)
& SetActiveProjectIndex, ProjectCount
& See also 3. Using JoPPS-Script in JoPPS for a discussion about the JoPPS projectpool.
GetCalcMode() : Dcalcmode
JoPPS
Returns the current JoPPS calculation mode. The calculation mode can be changed by the user through
the JoPPS Project.Mode menu.
ì The current calculation mode setting. Can be one of the following constants :
|
Calculation mode constants
|
Meaning
|
|
CALCMODE_GROUP
|
Calculate current assembly (group) of current project only
|
|
CALCMODE_PROJECT
|
Calculate current project only
|
|
CALCMODE_BATCH
|
Calculate in batch mode
|
|
CALCMODE_PTABLE
|
Calculate in pricetabel mode
|
7 Refer to the explanation of the Calculate function for a discussion of the calculation mode constants.
& Refer to 3. Using JoPPS-Script in JoPPS for more information on the calculation mode.
& SetCalcMode, Calculate
GetCalcPerBatchType( ? ) : ?
JoPPS – V2.82
To be documented.
JoPPS/JCALL/JScripter
Returns the current directory.
ì Sdir holds the current disk and directory specification.
& SetCurDir
GetCurrentAssembly() : Oassembly
JoPPS - v2.30
Returns the current assembly. (the assembly being edited in the JoPPS editor)
ì Oassembly, the current assembly object.
& GetCurrentProject
GetCurrentLanguage( ? ) : ?
JoPPS – V2.82
To be documented.
GetCurrentProject() : Oproject
JoPPS - v2.30
Returns the current project.
ì Oassembly, the current project object.
& GetCurrentAssembly
GetDatabaseDesc() : Sdesc
JoPPS
Returns the description of the database in use.
ì Sdesc is the description of the database package currently being used, an empty string is returned when no database is selected. (a database description can be changed using the JoPPS Administrator program)
& GetDatabaseId, SelectDatabase
JoPPS
Returns the id of the database in use.
ì Sdbid is the id (up to 8 characters) of the database package currently being used, an empty string is returned when no database is selected.
& GetDatabaseDesc, SelectDatabase
JoPPS – V2.82
To be documented.
JoPPS – V2.82
To be documented.
GetFileDate(Dh) : Ddatetime
JoPPS/JCALL/JScripter
Returns the date-and-time stamp of the specified filehandle.
î Dh is the filehandle.
ì Ddatetime is the date-and-time stamp of the file. You can use the date-time conversion and formatting routines on the returned value.
& SetFileDate, FileAge, DateToStr, DateTimeToStr, FormatDateTime
JoPPS – V2.82
To be documented.
GetHandlePos([Bofs]) : Dpos
JoPPS 3.34 P3
The script function ' GetHandlePos ' was provided with an additional argument to indicate whether the handle position/height should be determined or not in function of the specified handle reference:
î Bofs = False : handle position relative to sash
î Bofs = True : handle position depending on to handle reference
ì Dpos is the position of the handle
JoPPS – V2.82
To be documented.
JoPPS – V2.82
To be documented.
GetLanHint(Dtrans[,Stable]) : S
GetLanHint(Dform,Dcontrol[,Stable]) : S
JoPPS
Returns the hint for a given translation code.
î Dtrans is a message translation code.
Dform is a form translation code identifying a JoPPS dialog and the
Dcontrol argument is the control translation code identifying a specific control on this form.
The optional Stable argument specifies the translation table to use. By default the translation table associated with the running program is used. (eg. jopps.db when in JoPPS)
ì The hint associated with the given translation code argument(s) or an empty string if the requested entry was not in the translation database or has no hint.
& GetLanText, GetReportLanTag
GetLanText(Dtrans[,Stable]) : S
GetLanText(Dform,Dcontrol[,Stable]) : S
JoPPS
Returns the text for a given translation code.
î Dtrans is a message translation code.
Dform is a form translation code identifying a JoPPS dialog and the
Dcontrol argument is the control translation code identifying a specific control on this form.
The optional Stable argument specifies the translation table to use. By default the translation table associated with the running program is used. (eg. jopps.db when in JoPPS)
ì The text associated with the given translation code argument(s) or an empty string if the requested text was not in the translation database.
7 Example :
OutputMsg("List of possible run-time errors :");
i := 0;
WHILE (i:=i+1) < 51 DO
{
errmsg := GetLanText(-i,"jscript");
OutputMsg("error #"+IntToStr(i)+": "+errmsg);
};
& GetLanHint, GetReportLanTag
JoPPS – V2.82
To be documented.
JoPPS – V2.82
To be documented.
JoPPS – V2.82
To be documented.
JoPPS – V2.82
To be documented.
GetObjFullDesc(Oatom) : S
JoPPS - v2.70
Returns a descriptive text for the atom object given.
î Oatom is the atom object.
GetObjShortDesc(Oatom) : S
JoPPS - v2.70
Returns a short text describing the given atom object.
î Oatom is the atom object.
GetParam(Sparam[,Sdefault]) : Svalue
JoPPS
Returns the value of a JoPPS parameter.
î Sparam is the name of the parameter.
Sdefault is the default value if the parameter is not known to the system.
ì The value of the requested parameter or the default or an empty string if the parameter does not exists.
7 Example :
progroot := GetParam("PROGRAM_ROOT"); /* do NOT add the % chars!!! */
OutputMsg("%PROGRAM_ROOT%="+progroot);
& SetParam, InterpreteString
JoPPS – V2.82
To be documented.
GetProdDBVersion( ? ) : ?
JoPPS – V2.82
To be documented.
JoPPS – V2.82
To be documented.
GetProjectFilename() : S
GetProjectFilename(Sname) : S
GetProjectFilename(Dindex) : S
JoPPS
Returns the filename of a project in the projectpool.
î If no parameter is specified the current project is assumed,
Sname is the name of a project in the projectpool,
Dindex is a projectpool index.
ì The fully qualified filename or an empty string if the specified project was not found in the projectpool. (or no projects are open!)
& See also 3. Using JoPPS-Script in JoPPS for a discussion about the JoPPS projectpool.
JoPPS – V2.82
To be documented.
JoPPS – V2.82
To be documented.
GetReportLanTag([Dslot]) : Dtrans
JoPPS
Returns the translation code for the given report slot
î Dslot is the optional slot index. If no parameter is passed the current slot is assumed.
& For an overview of slot index constants refer to the discussion of the TagReport function
& GetLanText, GetLanHint
GetReportOutputFiles( ? ) : ?
JoPPS – V2.82
To be documented.
GetReportType([Dslot]) : S
JoPPS
Returns the reporttype of a slot.
î Dslot is the optional slot index. If no parameter is passed the current slot is assumed.
ì Returns "H"=HTML, "T"=Text, "L"=Label and "J"=JoPPS-Script or an empty string if no valid slot index is specified.
& For an overview of slot index constants refer to the discussion of the TagReport function.
GetResultLineCount([Dslot]) : D
JoPPS
Returns the number of text lines in the result of the given report slot.
î Dslot is the optional slot index. If no parameter is passed the current slot is assumed.
ì Returns the number of textlines in the result. Returns 0 if the slot was not updated during the last report run.
& For an overview of slot index constants refer to the discussion of the TagReport function.
& ReportRan, GetResultStr
GetResultParam(DparamId) : DSI
JoPPS
Returns the value of the specified result parameter.
î DparamId is the id of the parameter to query.
ì Returns the value of the specified result parameter.
|
Parameter ids
|
Required type
|
Meaning
|
|
PARAM_INTRO
|
B-type
|
The state of the main-intro flag
|
|
PARAM_SUBINTRO
|
B-type
|
The state of the sub-intro flag
|
|
PARAM_SUBSUMMARY
|
B-type
|
The state of the sub-summary flag
|
|
PARAM_SUMMARY
|
B-type
|
The state of the main-summary flag
|
& SetResultParam
GetResultStr([Dslot[,Dline]]) : S
JoPPS
Returns the result for a given slot.
î Dslot is the optional slot index, Dline is to select a specific line in the result text.
ì The result text or line as a string; an empty string is returned if the slot was not up-to-date.
& For an overview of slot index constants refer to the discussion of the TagReport function.
M Its better to specify a slot index as it is possible there is no current slot.
JoPPS
Returns the state of the JoPPS "SaveToDisk" flag. The SaveToDisk flag controls whether or not JoPPS results should be written to disk.
ì Returns the state of the "SaveToDisk" flag.
7 Example :
IF !GetSaveToDisk() THEN
{
IF AskYN("SaveToDisk is not active! Activate ?") THEN SetSaveToDisk(TRUE);
};
& SetSaveToDisk
JoPPS – V2.82
To be documented.
GetSubStr(Scollection,Dindex[,Sdelimiter]) : Ssub
JoPPS/JCALL/JScripter
Selects a specified substring out of a given "collection" string, you can specify a delimiter used to separate the strings in the "collection" string. The default delimiter is the comma (',') character.
î Scollection is the "collection" string,
Dindex is the substring to return and Sdelimiter is an optional delimiter character.
ì Ssub is the substring or an empty string if Dindex is beyond the number of substrings in the "collection" string.
7 Example :
days := "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday";
day := DayOfWeek();
OutputMsg("Today is "+GetSubStr(days,day-1));
& SubStrCnt
JoPPS – V2.82
To be documented.
JoPPS
Returns the state of the internal UI (userinterface) flag. The UI flag indicates whether or not JoPPS should popup the batch- or pricetableparameter dialog prior to start calculations.
ì The state of the UI flag.
& SetUI
JoPPS – V2.82
To be documented.
JoPPS
Returns the description of the current JoPPS user.
ì Sdesc is the description of the current user. (a user description can be changed using the JoPPS Administrator program)
& GetUserId
JoPPS
Returns the id of the current JoPPS user.
ì Suid is the id of the current user (max 8 characters).
& GetUserDesc
JoPPS – V2.82
To be documented.
GetDatabaseVersion() : SdbVersio
JoPPS 3.00
Returns the id of the database in use.
& GetDatabaseDesc, SelectDatabase, GetSoftwareVersion
GetSoftwareversion( ) : ?
JoPPS 3.00
Returns the software version.