A script-enabled browser is required for this page to function properly.

Menu Parameter Object Functions

This section describes the functions of the Oracle Forms Open API Menu Parameter object.

Menu Parameters are no longer supported and these topics exist for documentation purposes only.

d2fmpmcr_Create( d2fctx *pd2fctx, d2fob *parent, d2fmpm **ppd2fmpm, text *name );

This function creates a menu parameter object. You specify a pointer to the context in pd2fctx, a pointer to the parent of the new menu parameter object in parent, a handle for the function to store the newly-created object in ppd2fmpm, and the name of the new object in name.

This function returns D2FS_SUCCESS if it is able to create a new menu parameter object in ppd2fmpm.

d2fmpmde_Destroy( d2fctx *pd2fctx, d2fmpm *pd2fmpm );

This function destroys the specified menu parameter object. You specify a pointer to the context in pd2fctx and a pointer to the menu parameter object you want to destroy in pd2fmpm.

d2fmpmdu_Duplicate( d2fctx *pd2fctx, d2fob *new_parent, d2mpm *pd2fmpm_src, d2fmpm **ppd2fmpm_dst, text *new_name );

This function duplicates the specified menu parameter object. You specify a pointer to the context in pd2fctx, a pointer to the new parent in new_parent, a pointer to the menu parameter object source in pd2fmpm_src, a handle for the function to store the destination in ppd2fmpm_dst, and a pointer for the name of the new menu parameter object (new_name).

This function returns D2FS_SUCCESS if it is able duplicate the specified menu parameter object and place it at the ppd2fmpm_dst location.

d2fmpmaam_AddAssocMenu( d2fctx *pd2fctx, d2fmpm *pd2fmpm, number index, text *menu_name);

This function adds the associated menu to the specified menu parameter object. You specify a pointer to the context in pd2fctx, the menu parameter object in pd2fmpm, the index into the menu list where the Forms API stores this associated menu in index, and the name of the menu to be added to the list in menu_name.

Note that there is a Forms API property called D2FP_ASSOC_MENU_COUNT that you can use to retrieve the count of all associated menus for a specific menu parameter object.

d2fmpmram_RemoveAssocMenu( d2fctx *pd2fctx, d2fmpm *pd2fmpm, number index );

This function removes the associated menu from the specified menu parameter object. You specify a pointer to the context in pd2fctx, the menu parameter object in pd2fmpm, and the index into the menu list where the Forms API finds and removes this associated menu in index.

Note that there is a Forms API property called D2FP_ASSOC_MENU_COUNT that you can use to retrieve the count of all associated menus for a specific menu parameter object.

d2fmpmgam_GetAssocMenu( d2fctx *pd2fctx, d2fmpm *pd2fmpm, number index, text **menu_name );

This function retrieves the associated menu for the specified menu parameter object. You specify a pointer to the context in pd2fctx, the menu parameter object in pd2fmpm, the index into the menu list where the Forms API finds this associated menu in index, and a handle to menu_name for the function to store the name of the menu to be retrieved.

Note that there is a Forms API property called D2FP_ASSOC_MENU_COUNT that you can use to retrieve the count of all associated menus for a specific menu parameter object.

d2fmpmgb_GetBoolProp( d2fctx *pd2fctx, d2fmpm *pd2fmpm, ub2 pnum, boolean *pprp );

This function retrieves a property of type boolean for the specified menu parameter object. You specify a pointer to the context in pd2fctx, the menu parameter object in pd2fmpm, the property number in pnum, and a pointer to pprp, to store the boolean value.

This function returns D2FS_SUCCESS if it stores the value of the boolean property in pprp.

d2fmpmgn_GetNumProp( d2fctx *pd2fctx, d2fmpm *pd2fmpm, ub2 pnum, number *pprp );

This function retrieves a property of type number (an actual scalar constant) for the specified menu parameter object. You specify a pointer to the context in pd2fctx, the menu parameter object in pd2fmpm, the property number in pnum, and a pointer to pprp, to store the numeric value.

This function returns D2FS_SUCCESS if it stores the value of the number property in pprp.

d2fmpmgt_GetTextProp( d2fctx *pd2fctx, d2fmpm *pd2fmpm, ub2 pnum, text **pprp );

This function retrieves a property of type text for the specified menu parameter object. You specify a pointer to the context in pd2fctx, the menu parameter object in pd2fmpm, the property number in pnum, and a pointer to an array of characters in pprp for the function to store the text property value.

This function returns D2FS_SUCCESS if it fills the supplied array with a copy of the text property value for the specified menu parameter object in pprp.

Note that the client is responsible for freeing the text returned by this function.

d2fmpmgo_GetObjectProp( d2fctx *pd2fctx, d2fmpm *pd2fmpm, ub2 pnum, dvoid **pprp );

This function retrieves a property of type object of the specified menu parameter object. You specify a pointer to the context in pd2fctx, the menu parameter object in pd2fmpm, a property number in pnum, and a handle to pprp, for the function to store the object property value.

This function returns D2FS_SUCCESS if it stores a handle to the desired object property in pprp.

d2fmpmgp_GetBlobProp( d2fctx *pd2fctx, d2fmpm *pd2fmpm, ub2 pnum, dvoid **pprp );

This function retrieves the value from the client-specified handle. You specify a pointer to the context in pd2fctx, a pointer to the menu parameter object in pd2fmpm, a property number in pnum, and a handle to pprp, for the function to provide access to the client-specified value.

This function returns D2FS_SUCCESS if it stores a handle to the desired client-specified property in pprp.

d2fmpmsb_SetBoolProp( d2fctx *pd2fctx, d2fmpm *pd2fmpm, ub2 pnum, boolean prp );

This function sets the value of the specified menu parameter object boolean property. You specify a pointer to the context in pd2fctx, the menu parameter object in pd2fmpm, the property number in pnum, and the boolean value in prp.

This function returns D2FS_SUCCESS if it sets the boolean property with the value you specify in prp.

d2fmpmsn_SetNumProp( d2fctx *pd2fctx, d2fmpm *pd2fmpm, ub2 pnum, number prp );

This function sets the value of the specified menu parameter object number property. You specify a pointer to the context in pd2fctx, the menu parameter object in pd2fmpm, the property number in pnum, and the number value in prp.

This function returns D2FS_SUCCESS if it sets the number property with the value you specify in prp.

d2fmpmst_SetTextProp( d2fctx *pd2fctx, d2fmpm *pd2fmpm, ub2 pnum, text *prp );

This function sets the value of the specified menu parameter object text property. You specify a pointer to the context in pd2fctx, the menu parameter object in pd2fmpm, the property number in pnum, and a handle to the text value in prp.

This function returns D2FS_SUCCESS if it sets the specified text property with the value stored in prp.

d2fmpmso_SetObjectProp( d2fctx *pd2fctx, d2fmpm *pd2fmpm, ub2 pnum, dvoid *prp );

This function sets the object of the specified menu parameter object property. You specify a pointer to the context in pd2fctx, the menu parameter object in pd2fmpm, a property number in pnum, and a handle to the object property in prp.

This function returns D2FS_SUCCESS if it sets the specified object property with the value stored in prp.

d2fmpmsp_SetBlobProp( d2fctx *pd2fctx, d2fmpm *pd2fmpm, ub2 pnum, dvoid *prp );

This function sets the client-specified handle. You specify a pointer to the context in pd2fctx, a pointer to the menu parameter object in pd2fmpm, a property number in pnum, and a pointer to the client-specified value in prp.

This function returns D2FS_SUCCESS if it sets the client-specified handle with the value stored in prp.

d2fmpmhp_HasProp( d2fctx *pd2fctx, d2fmpm *pd2fmpm, ub2 pnum );

This function queries the specified menu parameter object for the specified property. You specify a pointer to the context in pd2fctx, the menu parameter object in pd2fmpm, and a property number in pnum.

If the function succeeds, it returns D2FS_YES or D2FS_NO, depending on whether the object has the specified property; otherwise, the function can return a number of possible return values, depending on the circumstances. For a complete list of the valid Open Forms API return values, refer to the "About Open API function return codes" section.

d2fmpmip_InheritProp( d2fctx *pd2fctx, d2fmpm *pd2fmpm, ub2 pnum );

This function enables the specified menu parameter object to inherit the specified property. You specify a pointer to the context in pd2fctx, a pointer to the menu parameter object in pd2fmpm, and the property number in pnum.

If the function succeeds, it returns D2FS_YES or D2FS_NO, depending on whether the object has been modified to inherit the specified property; otherwise, the function can return a number of possible return values, depending on the specific circumstances. For a complete list of the valid Open Forms API return values, refer to the "About Open API function return codes" section.

d2fmpmii_IspropInherited( d2fctx *pd2fctx, d2fmpm *pd2fmpm, ub2 pnum );

This function verifies that the specified object’s property is inherited, as is, from its parent object. You specify a pointer to the context in pd2fctx, a pointer to the menu parameter object in pd2fmpm, and the property number in pnum.

If the function succeeds, it returns D2FS_YES or D2FS_NO, depending on whether the property is inherited from the specified object’s parent; otherwise, the function can return a number of possible return values, depending on the specific circumstances. For a complete list of the valid Open Forms API return values, refer to the "About Open API function return codes" section.

d2fmpmsc_SubClass( d2fctx *pd2fctx, d2fmpm *pd2fmpm, d2fob *parent, boolean keep_path);

This function returns D2FS_SUCCESS if the specified menu parameter object (pd2fmpm) becomes a subclass of the specified parent (parent). You specify a pointer to the context in pd2fctx, a pointer to the menu parameter object in pd2fmpm, a pointer to the parent object in parent, and a boolean flag to save the path to the parent object in keep_path.

Note that the Forms API uses the boolean keep_path argument to save the actual path information. It is recommended that you do not set keep_path to TRUE since this information may be lost if you move to another machine. If keep_path is set to TRUE, the Forms API saves the actual path in the .fmb file. Therefore, the next time the form is loaded, depending on how the environment variable Forms 4.5 or 5.0 path is defined, the Forms API searches for the parent form in one of the specified directories defined by the environment variable.

d2fmpmis_IsSubclassed ( d2fctx *pd2fctx, d2fmpm *pd2fmpm );

This function verifies that the specified object is a subclass of another object. You specify a pointer to the context in pd2fctx and a pointer to the menu parameter object in pd2fmpm.

If the function succeeds, it returns D2FS_YES or D2FS_NO, depending on whether the specified object is a subclass of another object; otherwise, the function can return a number of possible return values, depending on the specific circumstances. For a complete list of the valid Open Forms API return values, refer to the "About Open API function return codes" section.


Creating modules using the Open API

Modifying modules using the Open API

About Open API header files

Menu parameter object macros

Menu parameter object API properties

Menu parameter object