# Userexits

Functions

## Logiview userexits

### Functions
int | nsv_get_num ()
| LogiView userexit for calling the number server.
static int | xjcl_lgv_map_men ()
| This userexit opens the specified menu on the client and returns the selected row.
int | xpdw_lgv_ins_ref (const char *param, const char *ignore)
int | xpdw_lgv_obj_vie (const char *param, const char *ignore)
int | xpdw_lgv_rel_off (const char *param, const char *ignore)
int | xpdw_lgv_rel_on (const char *param, const char *ignore)
int | xpdw_lgv_vie_hard_on (const char *param, const char *ignore)
int | xpdw_lgv_vie_hard_out (const char *param, const char *ignore)
int | xpdw_lgv_vie_off (const char *param, const char *ignore)
int | xpdw_lgv_vie_on (const char *param, const char *ignore)
int | xpvm_cal_vie (const char *param, const char *ignore)
int | xpvm_cre_dat (const char *param, const char *ignore)
int | xutil_call_ws (char *param, const char *ignore)
int | xutil_fld_get_ttl (const char *param, const char *ignore)
int | xutil_fld_ord (const char *param, const char *ignore)
int | xutil_fld_size (const char *param, const char *ignore)
int | xutil_fld_ttl_pos (const char *param, const char *ignore)
int | xutil_fld_ttl_size (const char *param, const char *ignore)
int | xutil_fld_ttl_vid_attr (const char *param, const char *ignore)
int | xutil_fld_typ (const char *param, const char *ignore)
int | xutil_fld_vid_attr (const char *param, const char *ignore)
int | xutil_mas_get_info (const char *param, const char *ignore)
int | xutil_mas_get_ttl (const char *param, const char *ignore)
int | xutil_mas_max_rec (const char *param, const char *ignore)
int | xutil_mas_num_sig_fld (const char *param, const char *ignore)
int | xutil_mas_pos (const char *param, const char *ignore)
int | xutil_mas_scl_bhv (const char *param, const char *ignore)
int | xutil_mas_size (const char *param, const char *ignore)

### 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_Parameter | Parameter to control the behavior of this userexit. Syntax is: CIRLCE_NAME,STR_NUM With following arguments:
  Parameter | Description | in/output? | Type
  --- | --- | --- | ---
  CIRLCE_NAME | Name of number circle (inclusive #) | in | String
  STR_NUM | The new generated number | out | Integer

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:

  cpPar | string containing these LogiView parameters: Menu name (S) - input Selected item (S) - output Selected row (I) - output
  cpIgn | ignored

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:

  usxContext | The userexit context.
  param | Parameter to control the behavior of this userexit. Syntax is: "principalCid objectCid objectTable iStatus iAktiv" With possible arguments:
  principalCid |  | The C_ID of the project or organizational unit.
  objectCid |  | The C_ID of the object to make it visible in the multi access rights view.
  objectTable |  | The table of the object (e.g. for items: T_MASTER_DAT).
  iStatus |  | The 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:

  usxContext | The userexit context.
  param | Parameter to control the behavior of this userexit. Syntax is: "principalCid objectCid pdwTable isVisible" With possible arguments:
  principalCid |  | The C_ID of the project or organizational unit.
  objectCid |  | The C_ID of the object to check if it is visible in the given project or organizational unit.
  pdwTable |  | The table of the multi access rights view.
  isVisible |  | This 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:

  usxContext | The userexit context.
  param | Reserved.

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:

  usxContext | The userexit context.
  param | Reserved.

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:

  usxContext | The userexit context.
  param | Reserved.

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:

  usxContext | The userexit context.
  param | Reserved.

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:

  usxContext | The userexit context.
  param | Reserved.

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:

  usxContext | The userexit context.
  param | Reserved.

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:

  usxContext | The userexit context.
  param | Parameter to control the behavior of this function. Syntax is: "FileCid, ViewId, EciTicket, ResultErrcode
  Parameter | Type | in/output? | Description
  FileCid | Integer | in | T_FILE_DAT.C_ID of file to view
  ViewId | Integer | in | ID for entries in T_PVM_FIL_DAT
  EciTicket | String | in | ECI ticket
  ErrCode | Integer | out | Errorcode of client callable

Returns:

  0 | OK
  1 | Data could not processed.

public logiview

Example:
  10 FILE_CID = .... 20 VIEW_ID = .... 30 ECI_TICKET = ... 40 RES = xpvm_cal_vie(FILE_CID, VIEW_ID, ECI_TICKET, ERR_CODE) 50 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:

  usxContext | The userexit context.
  param | Parameter to control the behavior of this function. Syntax is: "FileCid, DocCid, ViewId"
  Parameter | Type | in/output? | Description
  AppCmd | String | in | View command for file "AutoVue" or "AutoVue3D"
  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 FILE_CID = .... 20 DOC_CID = .... 30 RES = xpvm_cre_dat(EP_APP_CMD, FILE_CID, DOC_CID, RESULT_VIEW_ID) 40 put(strprint("View Id is: %d", RESULT_VIEW_ID))

See also:
  xpvm_cal_vie

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

LogiView userexit that calls a web service.

Parameters:

  context | Userexit context
  param | LogiView 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:

  ctx | The userexit context.
  param | Syntax like: WidgetID, Field-Name, Field-Result-Title, [Title-Language]

Parameter | Description | Type
--- | --- | ---
WidgetID | The ID of the widget to examine | Integer
Field-Name | The field name | String
Field-Result-Title | The field title as returned value | String
Title-Language | The 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:

  ctx | The userexit context.
  param | Syntax like: WidgetID, Field-Name, Field-Result-Order

Parameter | Description | Type
--- | --- | ---
WidgetID | The ID of the widget to examine | Integer
Field-Name | The field name | String
Field-Result-Order | The field order as returned value | Integer

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:

  ctx | The userexit context.
  param | Syntax like: WidgetID, Field-Name, Field-Result-length, Field-Result-width, Field-Result-Virtual-Width

Parameter | Description | Type
--- | --- | ---
WidgetID | The ID of the widget to examine | Integer
Field-Name | The field name | String
Field-Result-length | The visable field length as returned value | Integer
Field-Result-width | The visable field width as returned value | Integer
Field-Result-Virtual-Width | The virtual field width as returned value | Integer

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:

  ctx | The userexit context.
  param | Syntax like: WidgetID, Field-Name, Field-Result-Col, Field-Result-Row

Parameter | Description | Type
--- | --- | ---
WidgetID | The ID of the widget to examine | Integer
Field-Name | The field name | String
Field-Result-Col | The column of field title as returned value | Integer
Field-Result-Row | The row of field title as returned value | Integer

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:

  ctx | The userexit context.
  param | Syntax like: WidgetID, Field-Name, Field-Result-length, Field-Result-width

Parameter | Description | Type
--- | --- | ---
WidgetID | The ID of the widget to examine | Integer
Field-Name | The field name | String
Field-Result-length | The length of field title as returned value | Integer
Field-Result-width | The width of field title as returned value | Integer

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:

  ctx | The userexit context.
  param | Syntax like: WidgetID, Field-Name, Field-Result-Title-Video

Parameter | Description | Type
--- | --- | ---
WidgetID | The ID of the widget to examine | Integer
Field-Name | The field name | String
Field-Result-Title-Video | The video attribute of field title as returned value | Integer

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:

  ctx | The userexit context.
  param | Syntax like: WidgetID, Field-Name, Field-Result-Type

Parameter | Description | Type
--- | --- | ---
WidgetID | The ID of the widget to examine | Integer
Field-Name | The field name | String
Field-Result-Type | The field type as returned value | String

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:

  ctx | The userexit context.
  param | Syntax like: WidgetID, Field-Name, Field-Result-Video

Parameter | Description | Type
--- | --- | ---
WidgetID | The ID of the widget to examine | Integer
Field-Name | The field name | String
Field-Result-Video | The video attribute of field as returned value | Integer

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_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-INFO | T_MASK
--- | ---
C_PRX_MASK_NAME | T_MASK.C_NAME
C_PRX_MASK_TITLE_<LNG> | T_MASK.C_TITLE_<LNG>
C_PRX_MASK_POS_COL | T_MASK.C_COL
C_PRX_MASK_POS_ROW | T_MASK.C_ROW
C_PRX_MASK_SCR_BEH | T_MASK.C_VER_BAR
C_PRX_MASK_MAX_RECORD | T_MASK.C_MAXREC
C_PRX_MASK_SIG_FLD | T_MASK.C_SIGNUM
C_PRX_MASK_SIZ_X | T_MASK.C_WID
C_PRX_MASK_SIZ_Y | T_MASK.C_LEN

EDB-PRX-FIELDS-INFO

EDB-PRX-FIELDS-INFO | T_FIELD;T_MAS_FLD
--- | ---
C_PRX_FIELD_NAME | T_FIELD.C_NAME
C_PRX_FIELD_TITLE_<LNG> | T_MAS_FLD.C_TITLE_<LNG>, T_FIELD.C_TITLE_<LNG>
C_PRX_FIELD_TLT_POS_COL | T_MAS_FLD.C_COL_TIT
C_PRX_FIELD_TLT_POS_ROW | T_MAS_FLD.C_ROW_TIT
C_PRX_FIELD_TLT_SIZ_X | T_MAS_FLD.C_WID_TIT
C_PRX_FIELD_TLT_SIZ_Y | T_MAS_FLD.C_LEN_TIT
C_PRX_FIELD_TLT_VID_ATTR | T_MAS_FLD.C_VID_TIT
C_PRX_FIELD_ORD | T_MAS_FLD.C_SORT
C_PRX_FIELD_SIZ_X | T_MAS_FLD.C_WID_VIS
C_PRX_FIELD_SIZ_Y | T_MAS_FLD.C_LEN_VIS
C_PRX_FIELD_VIR_WID | T_MAS_FLD.C_WID_VIR
C_PRX_FIELD_TYP | T_FIELD.C_TYPE
C_PRX_FIELD_VID_ATTR | T_FIELD.C_VIDEO

Parameters:

  ctx | The userexit context.
  param | Syntax like: WidgetID, Mask-Result-ID, Field-Result-ID

Parameter | Description | Type
--- | --- | ---
WidgetID | The ID of the widget to examine | Integer
Mask-Result-ID | The ID of EDB-PRX-MASK-INFO as returned value | Integer
Field-Result-ID | The ID of EDB-PRX-FIELDS-INFO as returned value | Integer

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:

  ctx | The userexit context.
  param | Syntax like: WidgetID, Mask-Title [, Title-Language]

Parameter | Description | Type
--- | --- | ---
WidgetID | The ID of the widget to examine | Integer
Mask-Title | The mask title as returned value | String
Title-Language | The 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:

  ctx | The userexit context.
  param | Syntax like: WidgetID, Mask-Result-Limit

Parameter | Description | Type
--- | --- | ---
WidgetID | The ID of the widget to examine | Integer
Mask-Result-Limit | The records limit of a mask as returned value | Integer

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:

  ctx | The userexit context.
  param | Syntax like: WidgetID, Mask-Result-Signed

Parameter | Description | Type
--- | --- | ---
WidgetID | The ID of the widget to examine | Integer
Mask-Result-Signed | The count of signed fields in a mask as returned value | Integer

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:

  ctx | The userexit context.
  param | Syntax like: WidgetID, Mask-Result-Column, Mask-Result-Row

Parameter | Description | Type
--- | --- | ---
WidgetID | The ID of the widget to examine | Integer
Mask-Result-Column | The column of mask position as returned value | Integer
Mask-Result-Row | The row of mask position as returned value | Integer

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_scl_bhv | ( | const char * | param,
|  | const char * | ignore
| ) |  |

Userexit `xutil_mas_scl_bhv` to get the mask scroll behaviour.

Parameters:

  ctx | The userexit context.
  param | Syntax like: WidgetID, Mask-Result-Scroll

Parameter | Description | Type
--- | --- | ---
WidgetID | The ID of the widget to examine | Integer
Mask-Result-Scroll | The mask scroll behaviour as returned value | Integer

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_size | ( | const char * | param,
|  | const char * | ignore
| ) |  |

Userexit `xutil_mas_size` to get mask size.

Parameters:

  ctx | The userexit context.
  param | Syntax like: WidgetID, Mask-Result-Width, Mask-Result-Length

Parameter | Description | Type
--- | --- | ---
WidgetID | The ID of the widget to examine | Integer
Mask-Result-Width | The mask width as returned value | Integer
Mask-Result-Length | The mask length as returned value | Integer

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))

Copyright © 2007-2012, Oracle and/or its affiliates.