Baanboard.com

Go Back   Baanboard.com

User login

Frontpage Sponsor

Main

Poll
Would you like to see a separate forum on Baanboard for the ION product?
No
14%
Yes
86%
Total votes: 78

Baanboard at LinkedIn


Reference Content

 
Predefined variables
By patvdv at 26 Feb 2008 - 21:57


Predefined variables

The following is a list of the predefined variables available to programmers. Variables specific to a particular function or group of functions are listed with those functions.

4 = 4GL only; R = Read-only; D = Deprecated (do not use anymore)

Type

Name

Attr.

Description

long

actual.occ

4R

Occurrence currently selected on form.

string

attr.adju(1)

4

  • "l" align left
  • "r" align right
  • "c" align center

long

attr.bitset.mask

4D

In general: bitsets are deprecated in the UI. The available values for a bitset field (see also enum functions).

long

attr.changed

4R

Indicates if the current field has changed.

string

attr.conv(1)

4

  • "u" convert to upper case
  • "l" convert to lower case

string

attr.currency$(3)

4R

Current currency (see set.currencies()).

long

attr.currkey

4R

Number of the current key. Or 0 if the current field is not a key field.

long

attr.dbase

4R

  • 1 current field is database field
  • 0 current field is not a database field

long

attr.dbmaxlen

4R

Maximum length of database field.

string

attr.deflt$(100)

4R

Default value of current field.

string

attr.descr$(60)

4

Description of current field.

long

attr.diga

4

Number of digits after decimal sign. For strings, this is the maximum input length.

long

attr.digv

4

Number of digits before decimal sign.

long

attr.divf

4

Division factor. (For entering numeric values without a decimal point.)

string

attr.domain$(16)

4R

Domain of the current field.

string

attr.domm$(14)

4

Domain message code of current field.

long

attr.dorp

4

Fill field with default or previous value:

  • 1 default
  • 0 previous

long

 

attr.echo

4D

  • 1 display value after input
  • 0 do not display value after input

This variable is supported for backward compatibility only. In preference, use the inputfield.visible(), inputfield.invisible() and inputfield.password() functions.

long

attr.element

4

Current array index (if field is an array element).

string

attr.enum.mask$(128)

4D

The values available for an enumerate field. Also the enumerate values available for the ask.enum() function.

See also set.enum.values.for.field() function.

string

attr.format.addition$(3)

4

Currency to be used for an amount format. Language to be used for a date format.

string

attr.helpfile$(10)

 

Help file of current field.

string

attr.ille$(30)

4

Illegal characters.

long

attr.imax

4

Maximum input length.

long

attr.inpfld

4R

  • 0 display field
  • 1 input field
  • 2 input only
  • 3 display only

long

attr.input

4D

  • 0 input disabled
  • 1 input enabled

This variable is supported for backward compatibility only. In preference, use disable.fields() and enable.fields() functions.

string

attr.lega$(30)

4

Legal characters.

long

attr.mandatory

4R

Mandatory input.

long

attr.maxlen

4

Maximum display length of current field.

string

attr.message$(132)

 

Message to be displayed when a field is filled after a before.input event.

long

attr.minlen

4

Minimum length of current field.

long

attr.multioccur

4R

  • 1 multioccurrence field
  • 0 not multioccurrence field

string

attr.nowait$(30)

4RD

Characters that start a field command. This variable is supported for backward compatibility only. In BaanERP, field command functionality is replaced by form commands.

string

attr.oformat$(30)

4

Output format of field.

long

attr.permission

4R

Permissions for current field:

  • NO.PERMISSION 1
  • PERM.READ 2
  • PERM.MODIFY 4
  • PERM.WRITE 8
  • PERM.DELETE 16
  • NO.RESTRICTION 30
  • PERM.UNKNOWN 32
  • NO.PERM.DEFINED 64

See also db.permission() function.

string

attr.previous$(30)

4R

Previous value of field.

long

attr.rang

4R

Compiled expression ID for attr.rang$.

string

attr.rang$(100)

4R

Defines a range; values are automatically checked against this range.

long

attr.reallen

4R

Real database length of field.

string

attr.refpath(100)

4

Reference path.

long

attr.rndm

4

Rounding method (see also round() function).

long

attr.rotate

4

Current index in currency table (see set.currencies() function).

long

attr.sttp

4 D

Start position in current field.

string

attr.textfield$(17)

4

Name of the text field. Used by the Text Manager.

string

attr.textkw1$(17) to attr.textkw4$(17)

4

Keywords of text. Used by the Text Manager.

string

attr.textlang$(1)

4

Language for text editing. Used by the Text Manager.

long

attr.textmaxlines

4

Maximum number of lines in the text editor. Used by the Text Manager.

long

attr.textmode

4

  • 1 display mode
  • 3 read/write mode

Used by the Text Manager.

string

attr.textopt$(25)

4

Name of default option for editor window options. Used by the Text Manager.

long

attr.textstart

4

  • 1 When new text is created, start text manager directly (default).
  • 0 When new text is created, fill keywords first.

Used by the Text Manager.

string

attr.textzoomsession$(18)

4

Session zoomed to by text editor zoom command. The default is "Display Texts" session. Used by the Text Manager.

long

attr.type

4R

Database type (DB.ENUM, DB.STRING, DB.TIME, DB.DATE, and so on)

long

attr.zoomcode

4

Field zoomcode. Possible values are:

  • 0 (no zoom)
  • Z.SESSION
  • Z.MENU

string

attr.zoomreturn$(18)

4

Name of return field of zoom session on current field.

string

attr.zoomsession$(18)

4

Session zoomed to from field.

long

auto.nextform

4D

  • 1 When modifying form data, automatically display next form when all occurrences on current form have been filled.
  • 0 When modifying form data, do not automatically display next form when all occurrences on current form have been filled (default).

 

 

 

It is not good GUI practice to use this variable.

long

background

R

  • 1 current session is modal
  • 0 current session is modeless

long

before.update.check

4RD

  • 0 field is checked during input
  • 1 field is checked during update

Valid only in subsection check.input.

long

break.view

4

When searching for records in type 3 forms, break to next view when no records found and group fields match with old values.

long

chartgrp

 

Current chart group.

string

chm.name(128)

4

Name of the current chart.

string

chm.owner(14)

4

Owner/creator of current chart.

string

chm.title(128)

4

Description of current chart.

string

chm.user(14)

4

Name of user of current chart.

long

choice

4

Command ID of active command.

long

curr.key

4R

Current key number of main table.

string

curr.pacc$(8)

R

Current package combination.

string

dal.error.file

R

The name of the source file where the last dal.set.error.message was called. This variable can be used in the debugger. If you trace this variable, the debugger will stop when the function dal.set.error.message() has been called.

long

dal.error.line

R

The line number in the code where the last dal.set.error.message was called. See dal.error.file above.

long

date

R

Number of days since 01-01-0001 (local time).

string

date$(6)

R

Current system date (DDMMYY).

long

e

R

Error code of last file action.

long

error.bypass

4

Indicates which database errors can be detected in your program script, see the database functionsdatabase_operations_overview for a detailed description.

string

exit.val$(80)

R

String returned to the called program at the end of the process.

string

fattr.currfld$(30)

4R

Name of current field.

string

fattr.descr$(60)

4

Description of current form.

long

fattr.ftype

4R

Type of current form (1, 2, 3, or 4).

string

fattr.helpfile$(14)

4

Name of help file for current form.

long

fattr.horizontal

4R

True for horizontal occurrences.

long

fattr.init

4R

Indicates if the form has been initialized.

long

fattr.nrtabs

4R

Number of tabs on current form (dynamic forms only).

long

fattr.occurnr

4R

Number of occurrences on current form.

long

fattr.seqno

4RD

Sequence number of current field in form.

long

fattr.toplines

4 D

The number of lines above the multioccurrence fields (default: 3). Set in the before.program section.

long

fattr.total.line

4

If set in before.program section, this indicates that a total line must be displayed in the grid (see also display.total.fields()).

string

filename$(16)

R

Name of most-recently accessed table.

long

filled.occ

4R

Number of filled occurrences.

string

firstweek$(6)

R

Date of the first day in the first week of the current year.

long

form.curr

4R

Current form number.

long

form.next

4R

Next form number. -1 if no next form

long

form.prev

4R

Previous form number. -1if no previous form

long

graphical.mode

4

Indicates whether the 3GL program runs in graphical mode (true) or in character mode (false). Default is false.

long

ignore.first.event

4

Indicates whether the start command of the current session must be skipped. The start command is defined in the session data.

long

initial.resize

4

Indicates automatic resize while starting a session.

string

job.device(14)

4

Default device used by job process.

long

job.device.requested

4

Indicates whether an output device must be specified when in job mode.

long

job.process

4R

Indicates if process is started by a job.

long

job.process.error

4R

Indicates if an error occurred during the run of a job.

string

job.report(15)

4

Report code of report to be used when in job mode.

long

job.skip.date.question

4

Indicates if the question "Consider the difference between entered date and system date?" must be skipped.

string

language$(1)

R

Current language code.

long

lattr.*

 

See Report scriptsReport_scripts.

string

logname$(16)

R

Current login name.

string

main.table$(9)

4R

Name of current main table.

long

mark.table()

4R

This array indicates which records are marked. The size of this array is set to fattr.occurnr. For example, if records 3 and 8 are marked, then:

mark.table(3) = 1
mark.table(8) = 1

and other elements in the array are 0 (false).

long

marked

4R

Indicates if there are marked records.

long

max.formtabs

4D

Defines the maximum number of form tabs to be displayed. Set in the before.program section.

double

maxdouble

R

Maximum value of a double.

long

modify.prim.key

4

  • 1 Primary key can be modified during modify. Set in programs of type 1, 2, and 3.
  • 0 Primary key cannot be modified.

long

number.forms

4R

Number of forms within current session.

long

number.of.marks

4R

Number of selected records in the grid.

long

parent

R

Identification number of parent process.

long

pid

R

Identification number of current process.

long

previous.choice

4R

Possible values:

  • 0
  • add.set dupl.occur
  • global.copy modify.set
  • mark.delete global.delete

Valid only in field sections and main.table.io.

string

procesinfo$(200)

 

Information passed to program at startup.

string

prog.name$(16)

R

Name of current session.

string

query.extension(512)

4D

A condition that is added to the WHERE clause of a query to be parsed by the 4GL engine (using AND operator). Set in before.program section. In preference, use the query.extend functions.

string

report$

4

Current report code.

long

reportgrp

4

Current report group.

long

reportno

R

Reports are numbered (1..n) within a report group. This number indicates the sequence number within the report group.
Note: The numbers (labeled "No.") in the session "Reports by Session" only match with reportno if these numbers are consecutive.

string

sattr.descr$(80)

4R

Description of the session.

long

select.only.fields.on.form

 
  • true all reference tables are read (default)
  • false only reference tables of fields on form are read

Use in before.program section.

long

shell.type

R

Exec_perm from user file.

 

spool.*

 

See spool.open().

long

start.by.wfc

4R

Session was started by workflow.

long

stp.abort.error

4R

Boolean indicating if the function abort.io() has been called.

long

stp.check.input.error

4RD

Boolean indicating if the function set.input.error() has been called.

Valid only in check.input section.

long

stp.skip.error

4R

Boolean indicating if the function skip.io() has been called.

long

subdal

4R

Indicates if the invocation of this DAL was caused by another DAL.

long

synchronized.reason

4R

This indicates the command that started the dialog synchronization.

long

update.status

4R

  • 0 no update
  • ADD.SET during add
  • MODIFY.SET during modify
  • MARK.DELETE during delete

string

user.locale$(14)

R

Locale from user file.

long

user.timer

R

Timer from user file.

string

user.type$(1)

4R

Current type of user. Possible values are:

  • S super user
  • N normal user

long

win.*

4R

See get.window.attrs().

string

zoomfield$(18)

4R

Variable set in the zoom session, indicating which field in the parent session was zoomed from.

string

zoomreturn$(18)

4R

Variable set in the zoom session, indicating which field's value is to be returned. In the parent session, the variable attr.zoomreturn$ has the same value.


0
No votes yet


All times are GMT +2. The time now is 23:20.


©2001-2013 - Baanboard.com - Baanforums.com