# Userexits

Functions

## Pre-Mask userexits
[Mask userexits]

### Functions
int | edb_ief_pre_mas_usx ()
| Pre-mask userexit which generates the standard EDB-IEF userexit menu.
int | lgv_usx_set_bar ()
| Set the status bar on the decision or procedure mask with LogiView model name/decision name or model name/procedure name.
int | tol_pre_mas ()
| Pre-mask userexit to perform an update in the current mask (using 'wdh_upd_lis') and to write calculate fields of the current mask before it will be displayed.
int | tpr_glb_docst_prm ()
| Sets C_ID of parent item record in item document refine widget.
int | xatt_prm (const char *param, const char *ignore)
int | xcls_qry_att_prm (const char *param, const char *ignore)
int | xcls_qry_prm (const char *param, const char *ignore)
int | xcnf_cpa_cat_spc_prm (const char *param, const char *ignore)
int | xcnf_cpa_var_cns_prm (const char *param, const char *ignore)
int | xcnf_mdl_spc_fin_prm (const char *param, const char *ignore)
int | xcnf_spc_sel_prm (const char *param, const char *ignore)
int | xcnf_spc_var_fin_prm (const char *param, const char *ignore)
int | xcnf_var_spc_fin_prm (const char *param, const char *ignore)
int | xcps_cmp_fnc_prm (const char *param, const char *ignore)
int | xcps_cnf_bom_sel_prm (const char *param, const char *ignore)
int | xcps_elm_prm (const char *param, const char *ignore)
int | xcps_flt_prm (const char *param, const char *ignore)
int | xcps_mdl_bom_prm (const char *param, const char *ignore)
int | xcps_mdl_sel_bom_prm (const char *param, const char *ignore)
int | xcps_prl_elm_prm (const char *param, const char *ignore)
int | xcps_sol_item_prm (const char *param, const char *ignore)
int | xcps_sol_mul_prm (const char *param, const char *ignore)
int | xcps_sol_use_prm (const char *param, const char *ignore)
int | xctx_prm (const char *param, const char *ignore)
int | xctx_set_nxt (const char *param, const char *ignore)
int | xdir_pre_mas ()
| Fills a list widget with data from the directory.
int | xdocfi_prm ()
| Pre-mask userexit for document-file relation masks.
int | xdocst_pre_mask ()
| Pre-mask userexit for document structures.
int | xedb_prm ()
| Basic pre-mask userexit.
int | xedbch_xbm ()
| General pre-mask userexit.
int | xedbch_xbm_upd ()
| General pre-mask userexit.
int | xform_cre_fld_men_prm ()
| Creates and sets the select menus for all fields of the active widget.
int | xform_dlg_prm ()
| Adds the mandatory field 'TEXT' and sets the button menu for "Continue", "Cancel" etc.
int | xgrpst_prm ()
| Pre-mask userexit for classification group structure list.
int | xhisto_xbm_his_all ()
| Dummy pre-mask userexit to prevent the automatic execution of the userexit `wdh_upd_lis`.
int | xmgt_drp_prm ()
| Sets the function pointer for Drag&Drop operations for the current mask to xmgt_drp_fnc.
int | xmodul_prm ()
| General pre-mask userexit.
int | xmtx_prm ()
| Pre-mask userexit for matrix list.
int | xord_var_pre_mas ()
| Sets the selection value for the passed order.
int | xpdw_drp_prm (const char *param, const char *ignore)
int | xpdw_pdw_prm (const char *param, const char *ignore)
int | xpdw_ppj_lis_prm (const char *param, const char *ignore)
int | xpdw_ppj_prm (const char *param, const char *ignore)
int | xpdw_pro_obj_prm (const char *param, const char *ignore)
int | xrel_qry_ent_nam ()
| Gets the entity name (e.g.
int | xrel_xbm ()
| Sets the current relation for the multi-list.
int | xsmlc_prm ()
| Pre-mask userexit for the ATC classes, used in classification form, list and folder.
int | xstate_tra_prm (const char *param, const char *ignore)
int | xtxt_fin_prm (const char *param, const char *ignore)
int | xtxt_ins_sel_pre_mas (const char *param, const char *ignore)
int | xtxt_set_sta_prm (const char *param, const char *ignore)
int | xtxt_whr_use_prm (const char *param, const char *ignore)
int | xvar_pre_frm ()
| Pre-mask userexit for the variant (other than TYP type) forms, renames the V_x mask fields (where x is a number) into C_x fields before displaying the variant form on the screen.
int | xvar_pre_mas ()
| Pre-mask userexit for the variant list.
int | xvardf_pre_mas ()
| Pre-mask userexit for the variant list, writes query criteria 'VAR' in TYPE field and refreshes the mask (wdh_upd_lis).

### Function Documentation

int edb_ief_pre_mas_usx | ( | ) |

Pre-mask userexit which generates the standard EDB-IEF userexit menu.

Returns:

  0 | OK

int lgv_usx_set_bar | ( | ) |

Set the status bar on the decision or procedure mask with LogiView model name/decision name or model name/procedure name.

Note:
  Only used as pre-mask-userexit.

Returns:

  0 | Success
  1 | Error occured

Example:

        // working example
        int iRc = log_usx_set_bar(NULL);

References:
  any references used

int tol_pre_mas | ( | ) |

Pre-mask userexit to perform an update in the current mask (using 'wdh_upd_lis') and to write calculate fields of the current mask before it will be displayed.

Returns:

  0 | OK
  Else | Error

  0 = o.k. 1 = error

It is not possible to set (additional) select values in the current mask, so all records will be loaded. To perform a pre-selection on a special range of records you have to set these select values from a calling userexit (written by yourself) which will then call "tol_pre_mas".

int tpr_glb_docst_prm | ( | ) |

Sets C_ID of parent item record in item document refine widget.

Returns:

  0 | OK
  Else | Error

Deprecated:

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

Pre-mask userexit for classification lists.

If the class has assigned attributes, then the pre-mask reads the attribute definition from the attribute pool (table T_CLA_DAT, the specific class assignment is stored in T_GRP_CLA) and adds the corresponding columns to the classification list. The attribute columns are dynamically created and are not mapped 1:1 to the database. Thus the insert/update/query operations for classification lists are implemented specifically. If the option /SUB is set (for queries in container class including sub-classes), the class structure is stored in the EPQTMP table temporarily. *

Parameters:

  cpArguments | Parameter for the Pre-mask userexit, syntax like: "/TABLE=table_name /UPD_WDG /SUB" with: /TABLE=table_name Name of the table with the attribute assignment to a class (e.g. T_GRP_FLD which is now a view of the T_CLA_DAT and T_GRP_CLA tables). /UPD_WDG The classification list must be updated (e.g. the attribute columns have changed). /SUB The class is a container class, the query must also be performed in the sub-classes.

Returns:

  0 | OK
  Else | Error

Remarks:
  The pre-mask userexit can also be called by the pre-action userexit to update the attribute column definition. The entries in EPQTMP are deleted by the post-mask userexit xatt_qry_pom.

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

Pre-mask userexit for select widgets with attribute sets for the class attributes Sets the query buffer of the field T_CLA_DAT.EDB_ID to the value of the EDB_ID of an edited attribute record (the widget where the attribute set select widget was opened from) and performs the query.

Only sets where the attribute is assigned to are shown in the select widget

Parameters:

  context | pre mask usx context
  cpArguments | userexit parameter, not yet used.

Returns:

  0 | Success |  | Else | Error

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

Pre-mask userexit for classification select widget in sub-classes folder of class form.

Sets the query buffer of the field T_GROUP_DAT.ENTNAM to the value of the Entity1 from last active widget (the widget where the class select widget was opened from) and performs the query. Only compatible classes (e.g. item classes for item records) are shown in select widget.

Parameters:

  context | Pre-mask userexit context
  param | Reserved, not used yet

Returns:

  0 | Success |  | Else | Error

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

Pre-mask userexit for specification category select widgets.

This userexit is used in the select widget for choosing a specification category for a specification. It filters all valid specification Categories for this specification. Set the organization code (T_AVL_DAT.STEP_INT_ID_REF) and the type (T_CLA_DAT.EDB_CLA_TYPE) from the last widget into the query buffer.

Parameters:

  param | Pre-mask userexit parameter (reserved).

Returns:

  0 | OK
  1 | Error

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

Pre-Mask userexit for specification constraint select widgets.

This userexit is used in select widgets for assigning a specification constraint for a product variant from the cooperation partner widget. Sets the organization (T_AVL_DAT.STEP_INT_ID_REF) from the last widget into the query buffer.

Parameters:

  param | Pre-mask userexit parameter,(reserved).

Returns:

  0 | OK
  1 | Error

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

Pre-Mask userexit for model specification select widgets.

Parameters:

  param |

Returns:

  0 | OK
  1 | Error

public pre-mask

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

Pre-Mask userexit for specification select widget.

Write "SPEC_CAT" in the specification category type (T_CLA_DAT.EDB_CLA_TYPE). Write the opposit from the parent field "INTERN" into the same field for query mode in the select widget (parent 'n' -> query 'y', parent 'y' -> query 'n').

Parameters:

  param | (reserved)

Returns:

  0 | OK
  != 0 | Error

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

Pre-Mask userexit for specification Product Variant relation widgets.

This userexit populates the ORG_CODE with the correct value for filtering.

Parameters:

  param | Standard userexit parameter (reserved).

Returns:

  0 | OK
  1 | Error

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

Pre-Mask userexit for product var specification select widgets.

Parameters:

  param | Standard userexit parameter (reserved).

Returns:

  0 | OK
  1 | Error

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

Pre-mask userexit for the select widget used to select product elements in the product component structure.

If the function field (T_CPS_FNC_DAT.EDB_NAME) in a list is already filled then the list named with /FNCLIS key is popped up to select the product component. If no product component is assigned to the select function or the function field is empty, then the default list named with /DEFLIS key is used as the select widget.

Parameters:

  context | Mask userexit context
  param | Parameter to control the behavior of this function. Syntax like: "/DEFLIS=<dft_list> /FNCLIS=<fnc_list>" With possible arguments:
  DEFLIS | dft_list | Name of the default list.
  FNCLIS | fnc_list | Name of the functional limited list.

Returns:

  0 | OK
  Else | Error

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

Pre-mask userexit for modular BOM selector form.

Reads the product structure element ID of the top level element from the widget buffer of the last active widget. The buffer key is "CNF_ELM_ID". Then the userexit calls the stored procedure to get the modular BOM explosion data.

Parameters:

  context | Mask userexit context
  param | Reserved

Returns:

  0 | Ok
  Else | Error

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

Pre-mask userexit for structure element masks.

Adds a drop listener.

Parameters:

  context | Mask userexit context
  param | Reserved

Returns:

  0 | Ok
  Else | Error

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

Pre-mask userexit for filter masks.

Adds a drop listener.

Parameters:

  context | Mask userexit context
  param | Reserved

Returns:

  0 | OK
  Else | Error

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

Pre-mask userexit for the BOM overview form.

Dummy userexit, but needed as wdh_upd_lis is called if no pre-mask userexit is defined for a relation widget.

Parameters:

  context | Mask userexit context
  param | Reserved

Returns:

  0 | OK
  Else | Error

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

Pre-mask userexit to choose a product structure element from modular BOM list.

Execute structure explosion for product structure element, so select widget can be filled.

Parameters:

  context | Mask userexit context
  param | Reserved

Returns:

  0 | OK
  1 | Error

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

Pre-mask userexit for parallel structure masks.

Adds a drop listener.

Parameters:

  context | Mask userexit context
  param | Reserved

Returns:

  0 | OK

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

Pre-mask userexit for the item selector.

Sets join in order to select items assigned to correspondent classes (e.g. Products). This userexit is used in the select widget for choosing an item to a solution. The userexit copies the widget buffer object of the solution, product element and product component. Additionally the userexit writes the show mode information into the widget buffer ("CPS_SHOW_MODE") and reads/writes the mask join from/into the widget buffer ("CPS_MASK_JOIN").

Parameters:

  context | Mask userexit context
  param | Reserved

Returns:

  0 | OK
  Else | Error

See also:
  xcps_sol_eda, xcps_sol_item_poa

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

Pre-mask userexit for multi-edit solution list.

Dummy userexit, but needed so wdh_upd_lis is not called if no pre-mask userexit is defined for a relation widget.

Parameters:

  context | Mask userexit context
  param | Reserved

Returns:

  0 | OK
  Else | Error

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

Pre-mask userexit for sub-list "in Modular Boms" in combined item widgets.

Sets the join condition for the list: T_CPS_SOL_DAT.EDB_ELM_REF=T_CPS_ELM_DAT.EDB_ID& T_CPS_ELM_DAT.EDB_CMP_REF=T_CPS_CMP_DAT.EDB_ID& T_CPS_SOL_DAT.EDB_CLASS_REF=T_GROUP_DAT.EDB_ID& T_GROUP_DAT.SML_NUM=V_CNF_GRP_VAR.EDB_SML_NUM& T_CPS_SOL_DAT.EDB_RUL_REF=T_CPS_RUL_DAT.EDB_ID& T_CPS_SOL_DAT.EDB_CHG_OPR_FROM=V_OPR_EWO_FRM.EDB_OPR_EDB_ID(+)& T_CPS_SOL_DAT.EDB_CHG_OPR_UNTIL=V_OPR_EWO_UNT.EDB_OPR_EDB_ID(+)

Parameters:

  context | Mask userexit context
  param | Reserved

Returns:

  0 | OK
  Else | Error

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

Pre-mask userexit of structure lists for objects which can be assigned to contexts, i.e.

which can be qualified.

- Checks if displaying the context columns is turned on. If so, appends a column to the corresponding mask for each context.
- Checks if the next context was set with `xctx_set_nxt`. If yes, the name of this context is appended to the mask title and the context ID is added to the widget buffer with the key "CTX". Used in combination with the userexits `xctx_pra` and `xctx_eda` this ensures that the current widget will only represent data of the given context - independent of the currently chosen value for the context.
- Refreshes the widget as soon as any pre-mask userexit is defined for a widget. This is not done by DataView.

Parameters:

  ctx | Menu userexit context.
  param | Parameter to control the behaviour of this userexit. Currently none.

Returns:

  0 | OK
  Else | Error

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

Sets the context for the next widget.

Menu or pre-mask userexit to be called directly before opening one of the relation lists that use the context. The purpose of this userexit is to overwrite the currently selected context and open a list for the passed context. Use this userexit in combination with 'xctx_prm'.

Note:
  The passed parameter for the context will be saved in a static variable and only be used by the pre-mask userexit 'xctx_prm'.

Parameters:

  ctx | Menu userexit context.
  param | Parameter to control the behavior of this function. Syntax is: "<contextId>" With possible arguments:
  contextId | ID of the context to be set. Can be: The ID of an existing context (like "PRD") The dash ("-") to indicate that no context shall be set for the next widget.

Returns:

  0 | OK
  Else | Error

Example:
  Although the current context is DESIGN (DSG) the bill of material used for production shall be opened using a corresponding menu entry like "Production BOM". This userexit is called directly before opening the relation list (calling 'iwf_lis_ref') with the argument "PRD". The two userexits may be combined using 'LIST': `LIST xctx_set_nxt(PRD) & iwf_lis_ref(EDB-ARTICLE STR) <endcode>`

See also:
  `xctx_prm`

int xdir_pre_mas | ( | ) |

Fills a list widget with data from the directory.

Note:
  The directory name is read from a global variable set by xdir_opn.

Returns:

  0 | OK
  1 | Error

See also:
  xdir_opn

int xdocfi_prm | ( | ) |

Pre-mask userexit for document-file relation masks.

For future use.

Parameters:

  cp_Arguments | not used

Returns:

  0 | OK
  Else | Error

int xdocst_pre_mask | ( | ) |

Pre-mask userexit for document structures.

Retrieves all available document types from the database and creates a menu containing these document types.

Returns:

  0 | OK
  -1 | Database error

int xedb_prm | ( | ) |

Basic pre-mask userexit.

A pre-selection on top recods may be performed.

Note:
  A pre-selection on top records will be performed if
  - Widget is not in virtual mode.
  - Widget contains the field 'xxx.AGG_FLAG'.
  - Widget is not a form that has been opended to display a single record (e.g. which has been selected in the list).
  - Option /PRE_SEL is set (and - if a default name is set too - the value of the DataView default is not 0).
  The current widget will be refreshed without a pre-selection on top records if one of the following situations is true and the widget is not in virtual mode:
  - Widget is a form and a query value for the C_ID is set (so the form has been opened for a selected element e.g. in a list).
  - Widget is a relation or aggregate list and the father element is already set.
  If the select or no-select menu of the widget contains selections according to the name 'EDB-...-SUB-MAS' they will be removed from the menu (they were needed in the old alphanumeric version).

Parameters:

  cpParameter | Parameter to control the behavior of this function. Syntax is: "[/PRE_SEL=<default>]" With possible arguments:
  PRE_SEL | default | Performs a pre-selection for top records (value of AGG_FLAG is 0) if value of passed default is 1. If no default name is set, a pre- selection is always performed.

Returns:

  0 | OK
  Else | Return code from wdh_upd_lis

int xedbch_xbm | ( | ) |

General pre-mask userexit.

Dummy userexit (if used in relation widgets, no automatic wdh_upd_lis is done).

Returns:

  0 | OK

int xedbch_xbm_upd | ( | ) |

General pre-mask userexit.

Calls xmodul_prm.

Deprecated:
  Use xmodul_prm

Returns:

  0 | OK

See also:
  xmodul_prm

int xform_cre_fld_men_prm | ( | ) |

Creates and sets the select menus for all fields of the active widget.

DataView will only create them when the user opens the menu interactively.

Parameters:

  cp_Parameter | Reserved.

Returns:

  0 | OK
  1 | Error

int xform_dlg_prm | ( | ) |

Adds the mandatory field 'TEXT' and sets the button menu for "Continue", "Cancel" etc.

Note:
  This pre-mask userexit is mandatory for dialog forms that are opened with 'xform_open_dlg'.

Parameters:

  cp_Arguments | Parameter to control the behavior of this function. Syntax is: "[/MENU=menu [/POSITION=vh]" With possible arguments:
  MENU | menu | Name of the button menu to be used for the dialog form. If this option is not set default is "EDB-ASS-BUT". If "NO" is passed as the menue name, no button menu will be used for the dialog form.
  POSITION | vh | Position of the button menu. The first letter indicates the vertical position. Possible values are: "T" = top, "B" = bottom. The second letter indicates the horizontal position: "L" = left, "C" = center, "R" = right. Default position is "BR" (bottom right).

Returns:

  0 | OK
  1 | Error

See also:
  xform_call_dlg xform_dlg_prm

int xgrpst_prm | ( | ) |

Pre-mask userexit for classification group structure list.

If the structure list is opened from the class form, the entity name of the upper class is stored in the widget buffer. Required in xclass_chk_rec_poa to check compatibility of parent/child class entities.

Parameters:

  cp_Par | Reserved.

Returns:

  0 | OK

See also:
  xclass_chk_rec_poa

int xhisto_xbm_his_all | ( | ) |

Dummy pre-mask userexit to prevent the automatic execution of the userexit `wdh_upd_lis`.

Returns:

  0 | OK

int xmgt_drp_prm | ( | ) |

Sets the function pointer for Drag&Drop operations for the current mask to xmgt_drp_fnc.

Note:
  xmgt_drp_fnc will be executed before the standard Drag&Drop userexits. If xmgt_drp_fnc returns an error, the standard DATAVIEW Drag&Drop userexit will not be called.

Parameters:

  cp_Parameter | Parameter to control the behavior of this function. Syntax is: "<lgv>" With possible arguments:
  lgv |  | Name of LogiView procedure (LV/DT) that is called by Drag&Droop in this destination widget.

Returns:

  0 | OK

int xmodul_prm | ( | ) |

General pre-mask userexit.

Parameters:

  cpPar | Parameter to control the behavior of this function. Syntax like: "[/VIRCHK][/UPD]" With possible arguments:
  VIRCHK | In virtual mode do nothing.
  UPD | In refine or aggregate widgets call wdh_upd_lis when parent C_ID is set. For other widgets call wdh_upd_lis.

Returns:

  0 | OK

int xmtx_prm | ( | ) |

Pre-mask userexit for matrix list.

Creates columns (fields) for each alternative item of the variant placeholder.

Note:
  This userexit can only be used for the matrix list!

Parameters:

  cp_Arguments | Parameter to control the behavior of this function. Syntax like: "field1[, field2[, ...]]" With possible arguments:
  field1 | Names of database fields in the matrix list which shall be used as individual columns (fields) for each alternative item. If no field is specified the default field list is: "V_VAR_MTX.POS_NO, V_VAR_MTX.QUANTITY"

Returns:

  0 | OK
  1 | Error

See also:
  xmtx_opn,xmtx_poa

int xord_var_pre_mas | ( | ) |

Sets the selection value for the passed order.

Pre-mask userexit to be used on the relation list of the order specific bill of material to set the selection value for the passed order.

Returns:

  0 | OK
  1 | Key fields not in widget

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

Pre-mask userexit for object structure widgets.

Sets the drag&drop function `xpdw_drp_fnc` for object structure masks. So it is possible to drag&drop objects from a global PDW view widget to a relation widget.

Parameters:

  usxContext | The userexit context.
  param | Additional userexit parameters. Currently none.

Returns:

  0 | OK
  Else | Error

See also:
  xpdw_drp_fnc

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

Pre-mask userexit in folders with PDW or PDW widgets.

Sets the single selection mode for the current mask.

Parameters:

  usxContext | The userexit context.
  param | Additional userexit parameters. Currently none.

Returns:

  0 | OK
  Else | Error

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

Pre-mask userexit for the widget that shows the allowed jobs (`EDB-PDW-POS-SLI` / `EDB-PDW-POS-PPJ-SLI`).

When selecting the job for a template project from a recursive widget, only user specific jobs have to be displayed. Therefore, this userexit extends the mask join with the condition `T_POS_DAT.REF_USR=S:currentUser`.

Parameters:

  usxContext | The userexit context.
  param | Additional userexit parameters. Currently none.

Returns:

  0 | OK
  PDW_JOI_TO_LNG (753) | Join string is too long.
  PDW_NO_MAS (722) | No mask available.
  PDW_NO_WDG (723) | No widget available.

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

Pre-mask userexit for the template project widget `EDB-PDW-POS-PPJ-RLI`.

Sets the current job as parent element for the template projects widget.

Parameters:

  usxContext | The userexit context.
  param | Additional userexit parameters. Currently none.

Returns:

  0 | OK
  PDW_NO_WDG (723) | No widget available.

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

Pre-mask userexit for the principal object relation mask.

Sets the mask join to filter `PDW_STRUCTURE` relations.

Remarks:
  Not called in virtual mode. Therefore, the mask join is also set by the pre-action userexit `xpdw_pro_obj_pre` in 'Q'uery mode.

Parameters:

  usxContext | The userexit context.
  param | Additional userexit parameters. Currently none.

Returns:

  0 | OK
  1 | Error

See also:
  xpdw_pro_obj_pre

int xrel_qry_ent_nam | ( | ) |

Gets the entity name (e.g.

EDB-ARTICLE) from the current mask and writes it in the field "C_ENTITY".

Parameters:

  cp_Parameter | Parameter to control the behavior of this userexit. Syntax like: "A|R"

With possible arguments:

A |  | Use the Aggregate entity (entity 1)
R |  | Use the Refine entity (entity 2)

Returns:

  0 | OK
  1 | Wrong parameter
  2 | No widget active
  3 | No entity id
  4 | No entity name
  5 | Field "T_PAC_MUL.C_ENTITY" not found
  6 | Cannot write selection in field
  7 | Cannot update widget

int xrel_xbm | ( | ) |

Sets the current relation for the multi-list.

The name of this relation can be defined through the default EDB-PAC-ACT-REL. From this entity you can copy records via drag&drop into the multi-list. Later you can change the current entity with the function xrel_set_rel.

Returns:

  0 | = OK

int xsmlc_prm | ( | ) |

Pre-mask userexit for the ATC classes, used in classification form, list and folder.

Opens a shadow widget in virtual mode and stores the shadow widget id in the widget buffer of the head form. The shadow widget is needed later by the query algorithm for ATC classes.

Parameters:

  cp_Parameter | /LIS The userexit is called to open the classification list (mask EDB-GRP-ART-RLI-S). /SUBLIS The userexit is called from the classification attributes folder in class form (mask EDB-ART-SMLC-RLI). /FRM The userexit is called from the class combined form (mask EDB-ART-CFR-S). /ABS The attribute list is opened for a container class. /SHAD Name of the shadow widget, the default list is EDB-ART-SMLC-RLI

Returns:

  0 | OK
  Else | Error

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

The pre-mask userexit for transition masks.

- Enables a group or task field depending on whether groups or tasks are used for state change privileges. If the roles are active (configuration parameter `EDB-CRM-TSK`) the field `T_CHK_TRA.REF_TASK` will be visible, otherwise the field `T_CHK_TRA.CUR_GROUP` to define the responsible group respectively the necessary task will be visible.
- Calls xedbch_xbm_upd.

Parameters:

  usxContext | The userexit context.
  param | Reserved.

Returns:

  0 | OK
  Else | Error occurred.

See also:
  xedbch_xbm_upd

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

Pre-mask userexit for the select widget.

Tries to get the category names from the widget buffer of the last active widget to select valid text components, e.g. Glossaries or Text-Instances. Sets the EDB-ID's of the categories as query-filter in the field T_TXT_CTG_DAT.EDB_ID.

Parameters:

  ctx | Userexit context
  param | Parameter to control the behavior of this function. Not currently used.

Returns:

  0 | OK
  Else | Error

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

Pre-mask userexit for Instance editor which preselects the Text-Instance-Editor with the Text-Template from which the Text-Instance-Editor was called (if possible).

Parameters:

  ctx | Field userexit context.
  param | Reserved parameter for the pre-field userexit.

Returns:

  0 | Ok.
  Else | Error

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

Pre-mask userexit to set query filter regarding states.

Parameters:

  ctx | Userexit context
  param | Parameter to control the behavior of this function. Syntax is: "/STATE=<state(s)> /LIFECYCLE=<name of lifecycle> /TARGET=<field for query-filter>" With possible arguments:
  STATE | [W][V][I][R][A] | Identifier for states W (In work), V (Revisioning), I (Withdrawn), R (Released), A (Approved). No separator.
  LIFECYCLE | name of lifecycle | Name of the lifecycle, from which the lifecycle-id's should be used.
  TARGET | field for query-filter | Name of the field, in which the lifecycle-id's should be written (separated by " | ") regarding the query-filter.

Returns:

  0 | OK
  Else | Error

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

Identifies information from the last active widget and sets these information in the widget buffer:

WHERUSEDTYPE | Type of the Where-Used root element.
WHERUSEDTYPEEDBID | The EDB-ID of the Where-Used root element.

Parameters:

  ctx | Userexit context
  param | Parameter to control the behavior of this function. Not currently used.

Returns:

  0 | OK
  Else | Error

int xvar_pre_frm | ( | ) |

Pre-mask userexit for the variant (other than TYP type) forms, renames the V_x mask fields (where x is a number) into C_x fields before displaying the variant form on the screen.

This is necessary because the variant attributes are stored as C_x fields in the table T_MASTER_ATT, and as V_x fields in the form definition (table T_FIELD). The V_x fields are needed to avoid the field name conflict (T_FIELD records with the same name are not allowed) between classification forms and variant forms.

Parameters:

  cp_Par | Userexit parameter, reserved.

Returns:

  0 | OK
  Else | Error

int xvar_pre_mas | ( | ) |

Pre-mask userexit for the variant list.

If a default variant is set, then the field T_PRF_DAT.EDB_ID is added to the mask before the variant list is displayed on the screen. By setting the correspondent query criteria in the VERS_REF field, only possible variants are shown later in the variant list.

Returns:

  0 | OK

int xvardf_pre_mas | ( | ) |

Pre-mask userexit for the variant list, writes query criteria 'VAR' in TYPE field and refreshes the mask (wdh_upd_lis).

If the default EDB-PRE-SEL-VAR-OFF exists and has a value (<> 0), then the refresh operation is not performed.

Parameters:

  Userexit | parameter, not used yet.

Returns:

  0 | OK
  Else | Error

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