Userexits

Functions
Logiview userexits

Functions

int nsv_get_num ()
 LogiView userexit for calling the number server. More...
 
static int xjcl_lgv_map_men ()
 This userexit opens the specified menu on the client and returns the selected row. More...
 
int xpdw_lgv_ins_ref (const char *param, const char *ignore)
  More...
 
int xpdw_lgv_obj_vie (const char *param, const char *ignore)
  More...
 
int xpdw_lgv_rel_off (const char *param, const char *ignore)
  More...
 
int xpdw_lgv_rel_on (const char *param, const char *ignore)
  More...
 
int xpdw_lgv_vie_hard_on (const char *param, const char *ignore)
  More...
 
int xpdw_lgv_vie_hard_out (const char *param, const char *ignore)
  More...
 
int xpdw_lgv_vie_off (const char *param, const char *ignore)
  More...
 
int xpdw_lgv_vie_on (const char *param, const char *ignore)
  More...
 
int xpvm_cal_vie (const char *param, const char *ignore)
  More...
 
int xpvm_cre_dat (const char *param, const char *ignore)
  More...
 
int xutil_but_ret_act (char *param, const char *ignore)
  More...
 
int xutil_but_ret_but (char *param, const char *ignore)
  More...
 
int xutil_but_rfr_but (char *param, const char *ignore)
  More...
 
int xutil_but_set_tit (char *param, const char *ignore)
  More...
 
int xutil_call_ws (char *param, const char *ignore)
  More...
 
int xutil_fld_get_ttl (const char *param, const char *ignore)
  More...
 
int xutil_fld_ord (const char *param, const char *ignore)
  More...
 
int xutil_fld_size (const char *param, const char *ignore)
  More...
 
int xutil_fld_ttl_pos (const char *param, const char *ignore)
  More...
 
int xutil_fld_ttl_size (const char *param, const char *ignore)
  More...
 
int xutil_fld_ttl_vid_attr (const char *param, const char *ignore)
  More...
 
int xutil_fld_typ (const char *param, const char *ignore)
  More...
 
int xutil_fld_vid_attr (const char *param, const char *ignore)
  More...
 
int xutil_iwf_def_cns (char *param, const char *ignore)
  More...
 
int xutil_mas_get_info (const char *param, const char *ignore)
  More...
 
int xutil_mas_get_ttl (const char *param, const char *ignore)
  More...
 
int xutil_mas_max_rec (const char *param, const char *ignore)
  More...
 
int xutil_mas_num_sig_fld (const char *param, const char *ignore)
  More...
 
int xutil_mas_pos (const char *param, const char *ignore)
  More...
 
int xutil_mas_ret_acc_fld (char *param, const char *ignore)
  More...
 
int xutil_mas_ret_drt_rec (char *param, const char *ignore)
  More...
 
int xutil_mas_ret_fld (char *param, const char *ignore)
  More...
 
int xutil_mas_ret_flg_rec (char *param, const char *ignore)
  More...
 
int xutil_mas_ret_joi_mas (char *param, const char *ignore)
  More...
 
int xutil_mas_ret_tit_mas (char *param, const char *ignore)
  More...
 
int xutil_mas_scl_bhv (const char *param, const char *ignore)
  More...
 
int xutil_mas_set_joi_mas (char *param, const char *ignore)
  More...
 
int xutil_mas_set_tit_mas (char *param, const char *ignore)
  More...
 
int xutil_mas_size (const char *param, const char *ignore)
  More...
 
int xutil_mas_tit_fld (char *param, const char *ignore)
  More...
 
int xutil_wdg_ret_act (char *param, const char *ignore)
  More...
 
int xutil_wdg_ret_mas (char *param, const char *ignore)
  More...
 

Detailed Description

Function Documentation

int nsv_get_num ( )

LogiView userexit for calling the number server.

This userexit generates a new number for the given number circle.

Parameters
cp_ParameterParameter to control the behavior of this userexit. Syntax is:
CIRLCE_NAME,STR_NUM

With following arguments:
ParameterDescriptionin/output?Type
CIRLCE_NAMEName of number circle (inclusive #) inString
STR_NUMThe new generated number outInteger
Returns
int
0 OK
1 Error
Example:
Call of nsv_get_num from LogiView
10 CIRCLE_NAME = "#NAME"
20 RES = #nsv_get_num(CIRLCE_NAME,STR_NUM)
static int xjcl_lgv_map_men ( )
static

This userexit opens the specified menu on the client and returns the selected row.

Parameters
cpParstring containing these LogiView parameters:
  1. Menu name (S) - input
  2. Selected item (S) - output
  3. Selected row (I) - output
cpIgnignored
Returns
  • 0 - menu aborted by user
  • 10 - parameter 1 has wrong type
  • 20 - parameter 2 has wrong type
  • 30 - parameter 3 has wrong type
  • 50 - menu not found
  • 100 - menu could not be displayed
  • 400 - user selected a menu item (STA_MEN)
  • 999 - menu aborted
Example:
Opens a menu to choose one of the monitoring masks.
MENU_NAME = "EDB-BAS-MONITOR"
RES = #xjcl_lgv_map_men(MENU_NAME, EP_STRING, EP_INT)
put(strprint("RES = %i, item=%s, row=%i", RES, EP_STRING, EP_INT))
int xpdw_lgv_ins_ref ( const char *  param,
const char *  ignore 
)

Creates a new entry in the multi access rights view table to add a multi access rights view for an object.

Parameters
usxContextThe userexit context.
paramParameter to control the behavior of this userexit. Syntax is:
"principalCid objectCid objectTable iStatus iAktiv"

With possible arguments:
principalCidThe C_ID of the project or organizational unit.
objectCidThe C_ID of the object to make it visible in the multi access rights view.
objectTableThe table of the object (e.g. for items: T_MASTER_DAT).
iStatusThe value that is written in the I_STATUS column of the new record.
iAktiv

The value that is written in the I_ACTIVE column of the new record.

Returns
0 OK
1 Error
int xpdw_lgv_obj_vie ( const char *  param,
const char *  ignore 
)

Checks if a specific object is visible in a specific project or organizational unit. This userexit can be used from a LogiView procedure to check if a specific object is visible in a specific project or organizational unit. Only the direct VIE views are used, the project inheritance is not taken into count.

Parameters
usxContextThe userexit context.
paramParameter to control the behavior of this userexit. Syntax is:
"principalCid objectCid pdwTable isVisible"

With possible arguments:
principalCidThe C_ID of the project or organizational unit.
objectCidThe C_ID of the object to check if it is visible in the given project or organizational unit.
pdwTableThe table of the multi access rights view.
isVisibleThis parameter is used as return parameter for the result. It is a LogiView integer value that will be set to either 1 or 0, depending on whether the object is visible or not.
Returns
0 OK
1 Error
Example:
10 PROJ_CID = 123456789
20 OBJ_CID = 132456789
30 PDW_TABLE = "T_PRO_MASTER"
40 RES = #xpdw_lgv_obj_vie(PROJ_CID, OBJ_CID, PDW_TABLE, ISVISIBLE)
50 if (ISVISIBLE == 1)
60 put("Object is visible")
70 else
80 put("Object is NOT visible")
90 endif
int xpdw_lgv_rel_off ( const char *  param,
const char *  ignore 
)

Sets the default parameter RELATIONLOCK to OFF.

Parameters
usxContextThe userexit context.
paramReserved.
Returns
0 OK
1 Error
See Also
xpdw_lgv_rel_on
int xpdw_lgv_rel_on ( const char *  param,
const char *  ignore 
)

Sets the default parameter RELATIONLOCK to ON.

Parameters
usxContextThe userexit context.
paramReserved.
Returns
0 OK
1 Error
See Also
xpdw_lgv_rel_off
int xpdw_lgv_vie_hard_on ( const char *  param,
const char *  ignore 
)

Reactivates the multi access rights views. Unlike xpdw_lgv_vie_on, this userexit simply enables the multi access rights views, no matter if they have been disabled more than once with xpdw_lgv_vie_off.

Note
Has to be called in combination with xpdw_lgv_vie_hard_out!
Parameters
usxContextThe userexit context.
paramReserved.
Returns
0 OK
1 Error
See Also
xpdw_lgv_vie_hard_out, xpdw_lgv_vie_on
int xpdw_lgv_vie_hard_out ( const char *  param,
const char *  ignore 
)

Disables the multi access rights views. Unlike xpdw_lgv_vie_off, this userexit directly disables the multi access rights views, no matter if they have been enabled more than once with xpdw_lgv_vie_on.

Note
Has to be called in combination with xpdw_lgv_vie_hard_on.
Parameters
usxContextThe userexit context.
paramReserved.
Returns
0 OK
1 Error
See Also
xpdw_lgv_vie_hard_on, xpdw_lgv_vie_off
int xpdw_lgv_vie_off ( const char *  param,
const char *  ignore 
)

Sets the global multi access view. This userexit can be called from LogiView to disable the multi access rights views so that all objects are visible. Unlike xpdw_lgv_vie_hard_out, this userexit has to be called together with xpdw_lgv_vie_on.

Note
Has to be called in combination with xpdw_lgv_vie_on.
Parameters
usxContextThe userexit context.
paramReserved.
Returns
0 OK
1 Error
See Also
xpdw_lgv_vie_on, xpdw_lgv_vie_hard_off
int xpdw_lgv_vie_on ( const char *  param,
const char *  ignore 
)

Reactivates the multi access rights views. This userexit can be called from LogiView to reactivate the multi access rights views when they have been disabled before. Unlike xpdw_lgv_vie_hard_on, this userexit has to be called together with xpdw_lgv_vie_off and reactivates the multi access rights views only if the top call level has been reached.

Remarks
Has to be called in combination with xpdw_lgv_vie_off.
Parameters
usxContextThe userexit context.
paramReserved.
Returns
0 OK
1 Error
See Also
xpdw_lgv_vie_off, xpdw_lgv_vie_hard_on
int xpvm_cal_vie ( const char *  param,
const char *  ignore 
)

Calls the viewer. The viewer uses the data stored in table T_PVM_FIL_DAT which was filled by xpvm_cre_dat.

Parameters
usxContextThe userexit context.
paramParameter to control the behavior of this function. Syntax is:
"ViewMode, FileCid, ViewId, DocId, GuiFile, EciTicket, Content, ResultErrcode

Parameter Type in/output? Description
ViewMode String in "VIEW" or "MARKUP"
FileCid Integer in T_FILE_DAT.C_ID of file to view
ViewId Integer in ID for entries in T_PVM_FIL_DAT
DocId Integer in T_DOC_DAT.C_ID of assigned document
GuiFile String in GUI file used by JVue applet Or empty string
EciTicket String in ECI ticket
Content String in C_id list of markups to view Or ":" to activate markup mode Or empty string
ErrCode Integer out Errorcode of client callable
Returns
0 OK
1 Data could not processed.

public logiview

Example:
10 VIEW_MODE = .... 20 FILE_CID = .... 30 VIEW_ID = .... 40 DOC_CID = .... 50 GUI_FILE = .... 60 ECI_TICKET = ... 70 CONTENTS = .... 80 RES = #xpvm_cal_vie(VIEW_MODE,FIL_CID,VIEW_ID,DOC_CID,GUI_FILE,ECI_TICKET,CONTENTS,ERR_CODE) 90 put(strprint("Returncode of client callable is: %d", ERR_CODE))
See Also
xpvm_cre_dat
int xpvm_cre_dat ( const char *  param,
const char *  ignore 
)

Collects and prepares the data needed by the viewer. The data is stored in table T_PVM_FIL_DAT.

Parameters
usxContextThe userexit context.
paramParameter to control the behavior of this function. Syntax is:
"AppCmd, ViewMode, FileCid, DocCid, ResultViewId"

Parameter Type in/output? Description
AppCmd String in View command for file "AutoVue" or "AutoVue3D"
ViewMode String in "VIEW" or "MARKUP"
FileCid Integer in T_FILE_DAT.C_ID of file to view
DocCid Integer in T_DOC_DAT.C_ID of assigned document
ViewId Integer out ID for entries in T_PVM_FIL_DAT
Returns
0 OK
-1 Data could not processed.
1 Not all files local available

public logiview

Example:
10 APP_CMD = .... 20 VIEW_MODE = .... 30 FILE_CID = .... 40 DOC_CID = .... 50 RES = #xpvm_cre_dat(APP_CMD, VIEW_MODE, FILE_CID, DOC_CID, RESULT_VIEW_ID) 60 put(strprint("View Id is: %d", RESULT_VIEW_ID))
See Also
xpvm_cal_vie
int xutil_but_ret_act ( char *  param,
const char *  ignore 
)

Userexit that returns the ID of the button menu which was activated last, or returns 0. (Port of former TCL functions)

LGV example:
RES = @but_ret_act()
Parameters
contextUserexit context
cpParamIgnored
Returns
0 No active button menu
-3 Exception occurred, error is printed
Else The ID of the last activated button menu

public logiview

int xutil_but_ret_but ( char *  param,
const char *  ignore 
)

Userexit that returns the button menu ID for a button menu name. (Port of former TCL functions)

LGV example:
EP_MENU = #but_ret_but(EP_STRING)
Parameters
contextUserexit context
cpParamParameter that is divided into the following arguments.
buttonMenuName (INPUT) Name of the button menu
Returns
0 Button menu does not exist
-1 Parameter is missing
-3 Exception occurred, error is printed
Else ID of the button menu

public logiview

int xutil_but_rfr_but ( char *  param,
const char *  ignore 
)

Userexit that refreshes the button menu in the mask after a change. (Port of former TCL functions)

LGV example:
RES = #but_rfr_but(EP_MENU, EP_MAS)
Parameters
contextUserexit context
cpParamParameter that is divided into the following arguments.
buttonMenuID (INPUT) ID of the button menu
maskID (INPUT) ID of the mask
Returns
1 Button menu does not exist
0 OK, button menu is refreshed
-1 Parameter is missing
-2 Mask does not exist
-3 Exception occurred, error is printed

public logiview

int xutil_but_set_tit ( char *  param,
const char *  ignore 
)

Userexit that sets a new title for a button in a button menu in the mask. (Port of former TCL functions)

LGV example:
RES = #but_set_tit(EP_MENU, EP_POS, EP_STRING)
Parameters
contextUserexit context
cpParamParameter that is divided into the following arguments.
buttonMenuID (INPUT) ID of the button menu
buttonPosition (INPUT) Position of the button selection in menu
newButtonTitle (INPUT) New title string for the button
Returns
1 Wrong row position of the button selection
0 OK, new title was set
-1 Button menu ID is wrong
-2 Parameter is missing
-3 Button menu does not exist
-4 Exception occurred, error is printed
Else New title of button cannot be set

public logiview

int xutil_call_ws ( char *  param,
const char *  ignore 
)

LogiView userexit that calls a web service.

Parameters
contextUserexit context
paramLogiView parameter that is divided into the following arguments.
WS_ID (INPUT) ID of the web wervice Used by the app server to find a web service wrapper
CORR_ID (INPUT) Correlation ID for asynchronous calls.
ARGS (INPUT) Web service arguments string to be passed to the web service wrapper
RESULT (OUTPUT) Web service result string returned by web service wrapper
ERROR (OUTPUT) Web service error error message if web service call failed
Returns
0 OK
Else Error

-usx

int xutil_fld_get_ttl ( const char *  param,
const char *  ignore 
)

Userexit xutil_fld_get_ttl to get the field title in a mask.

Parameters
ctxThe userexit context.
paramSyntax like:
WidgetID, Field-Name, Field-Result-Title, [Title-Language]
ParameterDescriptionType
WidgetIDThe ID of the widget to examineInteger
Field-NameThe field nameString
Field-Result-TitleThe field title as returned valueString
Title-LanguageThe title language shortcut as optional parameter (ENG, GER, FRA, JAP, etc)String
Returns
int
0 OK
1 Failed
Example:
Call of xutil_fld_get_ttl from LogiView
10 WIDGET_ID = widget_id()
20 RES = #xutil_fld_get_ttl(WIDGET_ID,"BVB_ARTIKEL.PART_NAME", RESULT_TITLE, "ENG")
30 put(strprint("Field title is: %s", RESULT_TITLE))
int xutil_fld_ord ( const char *  param,
const char *  ignore 
)

Userexit xutil_fld_ord to get the field order in a mask.

Parameters
ctxThe userexit context.
paramSyntax like:
WidgetID, Field-Name, Field-Result-Order
ParameterDescriptionType
WidgetIDThe ID of the widget to examineInteger
Field-NameThe field nameString
Field-Result-OrderThe field order as returned valueInteger
Returns
int
0 OK
1 Failed
Example:
Call of xutil_fld_ord from LogiView
10 WIDGET_ID = widget_id()
20 RES = #xutil_fld_ord(WIDGET_ID,"BVB_ARTIKEL.PART_NAME", RESULT_ORDER)
30 put(strprint("Field order is: %d", RESULT_ORDER))
int xutil_fld_size ( const char *  param,
const char *  ignore 
)

Userexit xutil_fld_size to get the field size in a mask.

Parameters
ctxThe userexit context.
paramSyntax like:
WidgetID, Field-Name, Field-Result-length, Field-Result-width, Field-Result-Virtual-Width
ParameterDescriptionType
WidgetIDThe ID of the widget to examineInteger
Field-NameThe field nameString
Field-Result-lengthThe visable field length as returned valueInteger
Field-Result-widthThe visable field width as returned valueInteger
Field-Result-Virtual-WidthThe virtual field width as returned valueInteger
Returns
int
0 OK
1 Failed
Example:
Call of xutil_fld_size from LogiView
10 WIDGET_ID = widget_id()
20 RES = #xutil_fld_size(WIDGET_ID,"BVB_ARTIKEL.PART_NAME", RESULT_LENGTH, RESULT_WIDTH,
RESULT_VIRTUAL_WIDTH)
30 put(strprint("the LENGTH, WIDTH and VIRTUAL WIDTH of
field title are: %d, %d, %d", RESULT_LENGTH,RESULT_WIDTH, RESULT_VIRTUAL_WIDTH))
int xutil_fld_ttl_pos ( const char *  param,
const char *  ignore 
)

Userexit xutil_fld_ttl_pos to get the position of field title in a mask.

Parameters
ctxThe userexit context.
paramSyntax like:
WidgetID, Field-Name, Field-Result-Col, Field-Result-Row
ParameterDescriptionType
WidgetIDThe ID of the widget to examineInteger
Field-NameThe field nameString
Field-Result-ColThe column of field title as returned valueInteger
Field-Result-RowThe row of field title as returned valueInteger
Returns
int
0 OK
1 Failed
Example:
Call of xutil_fld_ttl_pos from LogiView
10 WIDGET_ID = widget_id()
20 RES = #xutil_fld_ttl_pos(WIDGET_ID,
"BVB_ARTIKEL.PART_NAME", RESULT_COL, RESULT_ROW)
30 put(strprint("the COL and ROW of field title
are: %d, %d", RESULT_COL, RESULT_ROW))
int xutil_fld_ttl_size ( const char *  param,
const char *  ignore 
)

Userexit xutil_fld_ttl_size to get the size of field title in a mask.

Parameters
ctxThe userexit context.
paramSyntax like:
WidgetID, Field-Name, Field-Result-length, Field-Result-width
ParameterDescriptionType
WidgetIDThe ID of the widget to examineInteger
Field-NameThe field nameString
Field-Result-lengthThe length of field title as returned valueInteger
Field-Result-widthThe width of field title as returned valueInteger
Returns
int
0 OK
1 Failed
Example:
Call of xutil_fld_ttl_size from LogiView
10 WIDGET_ID = widget_id()
20 RES = #xutil_fld_ttl_size(WIDGET_ID,
"BVB_ARTIKEL.PART_NAME", RESULT_LENGTH, RESULT_WIDTH)
30 put(strprint("the LENGTH and WIDTH of field title
are: %d, %d", RESULT_LENGTH, RESULT_WIDTH))
int xutil_fld_ttl_vid_attr ( const char *  param,
const char *  ignore 
)

Userexit xutil_fld_ttl_vid_attr to get the video attribute of field title in a mask.

Parameters
ctxThe userexit context.
paramSyntax like:
WidgetID, Field-Name, Field-Result-Title-Video
ParameterDescriptionType
WidgetIDThe ID of the widget to examineInteger
Field-NameThe field nameString
Field-Result-Title-VideoThe video attribute of field title as returned valueInteger
Returns
int
0 OK
1 Failed
Example:
Call of xutil_fld_ttl_vid_attr from LogiView
10 WIDGET_ID = widget_id()
20 RES = #xutil_fld_ttl_vid_attr(WIDGET_ID,
"BVB_ARTIKEL.PART_NAME", RESULT_TITLE_VIDEO)
30 put(strprint("Video attribute of field title
is: %d", RESULT_TITLE_VIDEO))
int xutil_fld_typ ( const char *  param,
const char *  ignore 
)

Userexit xutil_fld_typ to get the field type.

Parameters
ctxThe userexit context.
paramSyntax like:
WidgetID, Field-Name, Field-Result-Type
ParameterDescriptionType
WidgetIDThe ID of the widget to examineInteger
Field-NameThe field nameString
Field-Result-TypeThe field type as returned valueString
Returns
int
0 OK
1 Failed
Example:
Call of xutil_fld_typ from LogiView
10 WIDGET_ID = widget_id()
20 RES = #xutil_fld_typ(WIDGET_ID,"BVB_ARTIKEL.PART_NAME",
RESULT_TYPE)
30 put(strprint("Field type is: %s", RESULT_TYPE))
int xutil_fld_vid_attr ( const char *  param,
const char *  ignore 
)

Userexit xutil_fld_vid_attr to get the video attribute of field in a mask.

Parameters
ctxThe userexit context.
paramSyntax like:
WidgetID, Field-Name, Field-Result-Video
ParameterDescriptionType
WidgetIDThe ID of the widget to examineInteger
Field-NameThe field nameString
Field-Result-VideoThe video attribute of field as returned valueInteger
Returns
int
0 OK
1 Failed
Example:
Call of xutil_fld_vid_attr from LogiView
10 WIDGET_ID = widget_id()
20 RES = #xutil_fld_vid_attr(WIDGET_ID,
"BVB_ARTIKEL.PART_NAME", RESULT_VIDEO)
30 put(strprint("Video attribute of field is:%d", RESULT_VIDEO))
int xutil_iwf_def_cns ( char *  param,
const char *  ignore 
)

Userexit that recalculates the join dependencies due to the constraints or join definitions. This method must always be called if the mask join string was changed (MasSetJoiMas). (Port of former TCL functions)

LGV example:
RES = #iwf_def_cns(EP_WDG)
Parameters
contextUserexit context
cpParamParameter that is divided into the following arguments.
WidgetID (INPUT) ID of the widget
Returns
0 OK, join string is correct
-1 Parameter is missing
-2 Widget does not exist
-3 Exception occurred, error is printed
Else Join string is wrong

public logiview

int xutil_mas_get_info ( const char *  param,
const char *  ignore 
)

Userexit xutil_mas_get_info to get the mask information.

Remarks
It looks up for: mask name, mask title (multi language), mask position, mask size, mask scroll behaviour, mask records limit, mask signed fields, field name, field title(multi language), field position, field size, field type, field video attribute, field order, field title position, field title size, field title video attribute. There are two widget IDs as return value, which contains all the information for mask and fields.

The following tables show the fields of returned widgets according to the mask and fields information. C_PRX_MASK_TITLE_<LNG> and C_PRX_FIELD_TITLE_<LNG> are multi language fields. All languages, which defined in "LANGUAGE_DEFAULT" for the current user, will be considered.

EDB-PRX-MASK-INFO

EDB-PRX-MASK-INFOT_MASK
C_PRX_MASK_NAMET_MASK.C_NAME
C_PRX_MASK_TITLE_<LNG>T_MASK.C_TITLE_<LNG>
C_PRX_MASK_POS_COLT_MASK.C_COL
C_PRX_MASK_POS_ROWT_MASK.C_ROW
C_PRX_MASK_SCR_BEHT_MASK.C_VER_BAR
C_PRX_MASK_MAX_RECORDT_MASK.C_MAXREC
C_PRX_MASK_SIG_FLDT_MASK.C_SIGNUM
C_PRX_MASK_SIZ_XT_MASK.C_WID
C_PRX_MASK_SIZ_YT_MASK.C_LEN

EDB-PRX-FIELDS-INFO

EDB-PRX-FIELDS-INFOT_FIELD;T_MAS_FLD
C_PRX_FIELD_NAMET_FIELD.C_NAME
C_PRX_FIELD_TITLE_<LNG>T_MAS_FLD.C_TITLE_<LNG>, T_FIELD.C_TITLE_<LNG>
C_PRX_FIELD_TLT_POS_COLT_MAS_FLD.C_COL_TIT
C_PRX_FIELD_TLT_POS_ROWT_MAS_FLD.C_ROW_TIT
C_PRX_FIELD_TLT_SIZ_XT_MAS_FLD.C_WID_TIT
C_PRX_FIELD_TLT_SIZ_YT_MAS_FLD.C_LEN_TIT
C_PRX_FIELD_TLT_VID_ATTRT_MAS_FLD.C_VID_TIT
C_PRX_FIELD_ORDT_MAS_FLD.C_SORT
C_PRX_FIELD_SIZ_XT_MAS_FLD.C_WID_VIS
C_PRX_FIELD_SIZ_YT_MAS_FLD.C_LEN_VIS
C_PRX_FIELD_VIR_WIDT_MAS_FLD.C_WID_VIR
C_PRX_FIELD_TYPT_FIELD.C_TYPE
C_PRX_FIELD_VID_ATTRT_FIELD.C_VIDEO
Parameters
ctxThe userexit context.
paramSyntax like:
WidgetID, Mask-Result-ID, Field-Result-ID
ParameterDescriptionType
WidgetIDThe ID of the widget to examineInteger
Mask-Result-IDThe ID of EDB-PRX-MASK-INFO as returned valueInteger
Field-Result-IDThe ID of EDB-PRX-FIELDS-INFO as returned valueInteger
Returns
int
0 OK
1 Failed
Example:
Call of xutil_mas_get_info from LogiView
10 WIDGET_ID = widget_id()
20 RES = #xutil_mas_get_info(WIDGET_ID, INFO_MASK_ID,
INFO_FIELD_ID)
30 ROW_COUNT_MASK = row_count(INFO_MASK_ID)
40 put(strprint("There are %d rows in INFO-MASK",
ROW_COUNT_MASK))
50 field_read(INFO_MASK_ID, "C_PRX_MASK_NAME", 1,
RESULT_NAME)
60 put(strprint("MASK NAME: %s", RESULT_NAME))
70 field_read(INFO_MASK_ID, "C_PRX_MASK_TITLE_ENG" ,
1, RESULT_TITLE)
80 put(strprint("MASK TITLE of ENG: %s",RESULT_TITLE))
90 ROW_COUNT_FIELD = row_count(INFO_FIELD_ID)
100 put(strprint("There are %d rows in INFO-FIELD",ROW_COUNT_FIELD))
110 RES = 1
120 while(RES <= ROW_COUNT_FIELD)
130 field_read(INFO_FIELD_ID,"C_PRX_FIELD_NAME",RES, RESULT_NAME)
140 put(strprint("FIELD NAME: %s", RESULT_NAME))
150 field_read(INFO_FIELD_ID,"C_PRX_FIELD_TITLE_GER",RES,RESULT_TITLE)
160 put(strprint("FIELD TITLE of GER: %s",RESULT_TITLE))
170 RES = RES + 1
180 done
190 widget_close(INFO_MASK_ID)
200 widget_close(INFO_FIELD_ID)
int xutil_mas_get_ttl ( const char *  param,
const char *  ignore 
)

Userexit xutil_mas_get_ttl to get the mask title in specified language.

Parameters
ctxThe userexit context.
paramSyntax like:
WidgetID, Mask-Title [, Title-Language]
ParameterDescriptionType
WidgetIDThe ID of the widget to examineInteger
Mask-TitleThe mask title as returned valueString
Title-LanguageThe title language shortcut as optional parameter (ENG, GER, FRA, JAP, etc.)String
Returns
int
0 OK
1 Failed
Example:
Call of xutil_mas_get_ttl from LogiView
10 WIDGET_ID = widget_id()
20 RES = #xutil_mas_get_ttl(WIDGET_ID, RESULT_TITLE)
30 put(strprint("Mask title of default language is:
%s", RESULT_TITLE))
int xutil_mas_max_rec ( const char *  param,
const char *  ignore 
)

Userexit xutil_mas_max_rec to get the records limit of a mask.

Parameters
ctxThe userexit context.
paramSyntax like:
WidgetID, Mask-Result-Limit
ParameterDescriptionType
WidgetIDThe ID of the widget to examineInteger
Mask-Result-LimitThe records limit of a mask as returned valueInteger
Returns
int
0 OK
1 Failed
Example:
Call of xutil_mas_max_rec from LogiView
10 WIDGET_ID = widget_id()
20 RES = #xutil_mas_max_rec(WIDGET_ID, RESULT_LIMIT)
30 put(strprint("Mask record limit is: %d",
RESULT_LIMIT))
int xutil_mas_num_sig_fld ( const char *  param,
const char *  ignore 
)

Userexit xutil_mas_num_sig_fld to get the count of signed fields in a mask.

Parameters
ctxThe userexit context.
paramSyntax like:
WidgetID, Mask-Result-Signed
ParameterDescriptionType
WidgetIDThe ID of the widget to examineInteger
Mask-Result-SignedThe count of signed fields in a mask as returned valueInteger
Returns
int
0 OK
1 Failed
Example:
Call of xutil_mas_num_sig_fld from LogiView
10 WIDGET_ID = widget_id()
20 RES = #xutil_mas_num_sig_fld(WIDGET_ID,
RESULT_SIGNED)
30 put(strprint("Signed fields of the Mask is: %d", RESULT_SIGNED))
int xutil_mas_pos ( const char *  param,
const char *  ignore 
)

Userexit xutil_mas_pos to get mask size.

Parameters
ctxThe userexit context.
paramSyntax like:
WidgetID, Mask-Result-Column, Mask-Result-Row
ParameterDescriptionType
WidgetIDThe ID of the widget to examineInteger
Mask-Result-ColumnThe column of mask position as returned valueInteger
Mask-Result-RowThe row of mask position as returned valueInteger
Returns
int
0 OK
1 Failed
Example:
Call of xutil_mas_pos from LogiView
10 WIDGET_ID = widget_id()
20 RES = #xutil_mas_pos(WIDGET_ID, RESULT_COLUMN,
RESULT_ROW)
30 put(strprint("Column and row of mask position are:
%d, %d", RESULT_COLUMN, RESULT_ROW))
int xutil_mas_ret_acc_fld ( char *  param,
const char *  ignore 
)

Userexit that returns the access flag for a field in the mask. Allowed Values are :

'0' Invisible (0 as character)
'r' Read only
'w' Writable
'm' Mandatory
'*' Modus specific

(Port of former TCL functions)

LGV example:
RES = #mas_ret_acc_fld(EP_MAS, EP_FLD, EP_RESULT)
Parameters
contextUserexit context
cpParamParameter that is divided into the following arguments.
maskID (INPUT) ID of the mask
fieldID (INPUT) ID of the field
RESULT (OUTPUT) The access flag
Returns
0 OK, Access flag can be read and is returned as third parameter
-1 Parameter is missing
-2 Mask does not exist
-3 Field does not exist in mask
-4 Exception occurred, error is printed
Else Access flag of field cannot be read

public logiview

int xutil_mas_ret_drt_rec ( char *  param,
const char *  ignore 
)

Userexit that returns the dirty flag for a record in the mask. Allowed Values are :

0 Record is clean, not modified 'm' Record is modified

(Port of former TCL functions)

LGV example:
RES = #mas_ret_drt_rec(EP_MAS, EP_ROW, EP_RESULT)
Parameters
contextUserexit context
paramParameter that is divided into the following arguments.
maskID (INPUT) ID of the mask
row (INPUT) Row number
RESULT (OUTPUT) The dirty flag
Returns
0 OK, dirty flag can be read and is returned as third parameter
-1 Parameter is missing
-2 Mask does not exist
-3 Exception occurred, error is printed
Else Dirty flag of field cannot be read

public logiview

int xutil_mas_ret_fld ( char *  param,
const char *  ignore 
)

Userexit that returns the field id for the field name in the mask. (Port of former TCL functions)

LGV example:
EP_FLD = #mas_ret_fld(EP_MAS, EP_STRING)
Parameters
contextUserexit context
cpParamParameter that is divided into the following arguments.
maskID (INPUT) ID of the mask
fieldName (INPUT) Name of the field in the mask
Returns
0 Field does not exist in mask
-1 Parameter is missing
-2 Mask does not exist
-3 Exception occurred, error is printed
Else Id of the field

public logiview

int xutil_mas_ret_flg_rec ( char *  param,
const char *  ignore 
)

Userexit that returns the current flag for a record in the mask. Allowed Values are :

0 Record not existing
'-' Record not selected
'+' Record selected
'm' Record modified

(Port of former TCL functions)

LGV example:
RES = #mas_ret_flg_rec(EP_MAS, EP_ROW, EP_RESULT)
Parameters
contextUserexit context
cpParamParameter that is divided into the following arguments.
maskID (INPUT) ID of the mask
row (INPUT) Row number
RESULT (OUTPUT) The record flag
Returns
0 OK, record flag can be read and is returned as third parameter
-1 Parameter is missing
-2 Mask does not exist
-3 Exception occurred, error is printed
Else Record flag of field cannot be read

public logiview

int xutil_mas_ret_joi_mas ( char *  param,
const char *  ignore 
)

Userexit that returns the join string of the mask. (Port of former TCL functions)

LGV example:
RES = #mas_ret_joi_mas(EP_MAS, EP_RESULT)
Parameters
contextUserexit context
cpParamParameter that is divided into the following arguments.
maskID (INPUT) ID of the mask
RESULT (OUTPUT) The join string of the mask
Returns
0 OK, join string can be read and is returned as second parameter
-1 Parameter is missing
-2 Mask does not exist
-3 Exception occurred, error is printed
Else No join string is set

public logiview

int xutil_mas_ret_tit_mas ( char *  param,
const char *  ignore 
)

Userexit that returns the title string for the mask. (Port of former TCL functions)

LGV example:
RES = #mas_ret_tit_mas(EP_MAS, EP_RESULT)
Parameters
contextUserexit context
cpParamParameter that is divided into the following arguments.
maskID (INPUT) ID of the mask
RESULT (OUTPUT) The mask title
Returns
0 OK, mask title can be read and is returned as second parameter
-1 Parameter is missing
-2 Mask does not exist
-3 Exception occurred, error is printed
Else Reading the mask title failed

public logiview

int xutil_mas_scl_bhv ( const char *  param,
const char *  ignore 
)

Userexit xutil_mas_scl_bhv to get the mask scroll behaviour.

Parameters
ctxThe userexit context.
paramSyntax like:
WidgetID, Mask-Result-Scroll
ParameterDescriptionType
WidgetIDThe ID of the widget to examineInteger
Mask-Result-ScrollThe mask scroll behaviour as returned valueInteger
Returns
int
0 OK
1 Failed
Example:
Call of xutil_mas_scl_bhv from LogiView
10 WIDGET_ID = widget_id()
20 RES = #xutil_mas_scl_bhv(WIDGET_ID, RESULT_SCROLL)
30 put(strprint("Mask scroll behaviour is: %d",
RESULT_SCROLL))
int xutil_mas_set_joi_mas ( char *  param,
const char *  ignore 
)

Userexit that sets a new join string for the mask. (Port of former TCL functions)

LGV example:
RES = #mas_set_joi_mas(EP_MAS, EP_STRING)
Parameters
contextUserexit context
cpParamParameter that is divided into the following arguments.
maskID (INPUT) ID of the mask
newJoinString(INPUT) New join string for the mask
Returns
0 OK, join string can be set
-1 Parameter is missing
-2 Mask does not exist
-3 Exception occurred, error is printed
Else Setting a new join string failed

public logiview

int xutil_mas_set_tit_mas ( char *  param,
const char *  ignore 
)

Userexit that sets a new title string for the mask. (Port of former TCL functions)

LGV example:
RES = #mas_set_tit_mas(EP_MAS, EP_TITLE)
Parameters
contextUserexit context
cpParamParameter that is divided into the following arguments.
maskID (INPUT) ID of the mask
newMaskTitle (INPUT) New title string for the mask
Returns
0 OK, mask title is set -1 Parameter is missing
-2 Mask does not exist
-3 Exception occurred, error is printed
Else Setting the new mask title failed

public logiview

int xutil_mas_size ( const char *  param,
const char *  ignore 
)

Userexit xutil_mas_size to get mask size.

Parameters
ctxThe userexit context.
paramSyntax like:
WidgetID, Mask-Result-Width, Mask-Result-Length
ParameterDescriptionType
WidgetIDThe ID of the widget to examineInteger
Mask-Result-WidthThe mask width as returned valueInteger
Mask-Result-LengthThe mask length as returned valueInteger
Returns
int
0 OK
1 Failed
Example:
Call of xutil_mas_size from LogiView
10 WIDGET_ID = widget_id()
20 RES = #xutil_mas_size(WIDGET_ID, RESULT_WIDTH,
RESULT_LENGTH)
30 put(strprint("Mask width and length are: %d, %d",
RESULT_WIDTH, RESULT_LENGTH))
int xutil_mas_tit_fld ( char *  param,
const char *  ignore 
)

Userexit that sets a new title for a field in the mask. (Port of former TCL functions)

LGV example:
RES = #mas_tit_fld(EP_MAS, EP_FLD, EP_TITLE)
Parameters
contextUserexit context
cpParamParameter that is divided into the following arguments.
maskID (INPUT) ID of the mask
fieldID (INPUT) ID of the field
newFieldTitle (INPUT) New title string for the mask
Returns
0 OK, new title was set
-1 Parameter is missing
-2 Mask does not exist
-3 Field does not exist in mask
-4 Exception occurred, error is printed
Else New title of field cannot be set

public logiview

int xutil_wdg_ret_act ( char *  param,
const char *  ignore 
)

Userexit that returns the ID of the current active widget. (Port of former TCL functions)

LGV example:
EP_WDG = @wdg_ret_act()
Parameters
contextUserexit context
cpParamIgnored
Returns
0 No active widget
-3 Exception occurred, error is printed
Else The ID of the active widget

public logiview

int xutil_wdg_ret_mas ( char *  param,
const char *  ignore 
)

Userexit that returns the ID of the mask for the widget. (Port of former TCL functions)

LGV example:
EP_MAS = #wdg_ret_mas(EP_WDG)
Parameters
contextUserexit context
cpParamParameter that is divided into the following arguments.
WidgetID (INPUT) ID of the widget
Returns
0 No mask found
-1 Parameter is missing
-2 Widget does not exist
-3 Exception occurred, error is printed
Else The ID of the mask

public logiview