This section describes the functions of the Oracle Forms Open API Menu Module object.
d2fmmdcr_Create( d2fctx *pd2fctx, d2fob *parent, d2fmmd *ppd2fmmd, text *name );
This function creates a menu module. You specify a pointer to the context in pd2fctx, a pointer to the parent of the new menu module object in parent, a handle for the function to store the newly-created object in ppd2fmmd, and the name of the new object in name.
This function returns D2FS_SUCCESS if it is able to create a new menu module in ppd2fmmd.
d2fmmdde_Destroy( d2fctx *pd2fctx, d2fmmd *pd2fmmd );
This function destroys the specified menu module. You specify a pointer to the context in pd2fctx and a pointer to the menu module you want to destroy in pd2fmmd.
d2fmmddl_Delete( d2fctx *pd2fctx, text *name, boolean db );
This function deletes the specified menu module. You specify a pointer to the context in pd2fctx, the name of the menu module in name, and a boolean flag to indicate if the menu module is part of a database in db.
If db is TRUE, the Forms API assumes that you want to delete the specified menu module (the name passed in name) from a database. If db is FALSE, the menu module is part of a file system and the Forms API searches the file system for the specified menu module and then deletes it.
d2fmmddu_Duplicate( d2fctx *pd2fctx, d2fob *new_parent, d2mmd *pd2fmmd_src, d2fmmd **ppd2fmmd_dst, text *new_name );
This function duplicates the specified menu module. You specify a pointer to the context in pd2fctx, a pointer to the new parent in new_parent, a pointer to the menu module source in pd2fmmd_, a handle for the function to store the destination in ppd2fmmd_dst, and a pointer for the name of the new menu module (new_name).
This function returns D2FS_SUCCESS if it is able duplicate the specified menu module and place it at the ppd2fmmd_dst location.
d2fmmdco_CompileObj( d2fctx *pd2fctx, d2fmmd *pd2fmmd );
This function compiles all of the PL/SQL code associated with the specified menu module. You specify a pointer to the context in pd2fctx and a pointer to the object you want to compile in pd2fmmd.
For example, you might use this function to compile all of the trigger objects attached to a menu module, and all of the trigger objects attached to all item objects in a menu module.
d2fmmdcf_CompileFile( d2fctx *pd2fctx, d2fmmd *pd2fmmd );
This function compiles an FMB file and creates a generated FMX file. You specify the context (pd2fctx) and a pointer to a menu module (pd2fmmd).
d2fmmdld_Load( d2fctx *pd2fctx, d2fmmd **ppd2fmmd, text *menuname, boolean db );
This function loads the specified menu module. You specify the context (pd2fctx), a handle to a pointer for the function to use to store the menu module (ppd2fmmd), the name of the menu module (menuname), and a boolean flag (db) to indicate if the menu module is in a database.
If you set db to TRUE, the Forms API searches for the specified menu module in the database. Note that this assumes that you have connected to some database. You must call d2fctx_Connect() before you load a menu module from a database.
d2fmmdfv_FileVersion( d2fctx *pd2fctx, text *menuname, boolean db, number version );
This function returns the version of the menu module. You specify the context (pd2fctx), the menu module name (menuname), a boolean flag (db) to indicate if the menu module is in a database or the file system, and a pointer for the version returned by the function (version).
Note that you should call this function prior to calling the d2fmmdld_Load() function, since the file version will change once you load the menu module.
d2fmmdar_AddRole( d2fctx *pd2fctx, d2fmmd *pd2fmmd, number index, text *role_name );
This function adds a security "role" to the specified menu module. You specify a pointer to the context in pd2fctx, a pointer to the menu module in pd2fmmd, the index into the role list where the Forms API will store this role in index, and the name of the role to be added to the list in role_name. This function also uses a 1 based index rather than a Zero based index; e.g the range of valid values is from 1 to D2FP_ROLE_COUNT.
The "AddRole", "RemoveRole", and "GetRole" functions enable you to specify which security roles have access to a particular menu module.
Note that there is a Forms API property called D2FP_ROLE_COUNT that you can use to retrieve the count of all roles for a specific menu module.
Note that if you do not specify the menu module roles at the module level, you won’t have access to them at the menu item level.
d2fmmdrr_RemoveRole( d2fctx *pd2fctx, d2fmmd *pd2fmmd, number index );
This function removes the specified security "role" from the specified menu module. You specify a pointer to the context in pd2fctx, a pointer to the menu module in pd2fmmd, and the index into the role list where the Forms API will remove this role in index. This function also uses a 1 based index rather than a Zero based index; e.g the range of valid values is from 1 to D2FP_ROLE_COUNT.
The "AddRole", "RemoveRole", and "GetRole" functions enable you to specify which security roles have access to a particular menu module.
Note that there is a Forms API property called D2FP_ROLE_COUNT that you can use to retrieve the count of all roles for a specific menu module.
Note that if you do not specify the menu module roles at the module level, you won’t have access to them at the menu item level.
d2fmmdgr_GetRole( d2fctx *pd2fctx, pd2fmmd *pd2fmmd, number index, text **role_name );
This function retrieves the specified security role from a menu module. You specify a pointer to the context in pd2fctx, a pointer to the menu module in pd2fmmd, the index into the role list which the Forms API uses to retrieve this role in index, and a handle for the function to store the name of the role in role_name. This function also uses a 1 based index rather than a Zero based index; e.g the range of valid values is from 1 to D2FP_ROLE_COUNT.
The "AddRole", "RemoveRole", and "GetRole" functions enable you to specify which security roles have access to a particular menu module.
Note that there is a Forms API property called D2FP_ROLE_COUNT that you can use to retrieve the count of all roles for a specific menu module.
Note that if you do not specify the menu module roles at the module level, you won’t have access to them at the menu item level.
d2fmmdgb_GetBoolProp( d2fctx *pd2fctx, d2fmmd *pd2fmmd, ub2 pnum, boolean *pprp );
This function retrieves a property of type boolean for the specified menu module. You specify a pointer to the context in pd2fctx, the menu module in pd2fmmd, 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.
d2fmmdgn_GetNumProp( d2fctx *pd2fctx, d2fmmd *pd2fmmd, ub2 pnum, number *pprp );
This function retrieves a property of type number (an actual scalar constant) for the specified menu module. You specify a pointer to the context in pd2fctx, the menu module in pd2fmmd, 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.
d2fmmdgt_GetTextProp( d2fctx *pd2fctx, d2fmmd *pd2fmmd, ub2 pnum, text **pprp );
This function retrieves a property of type text for the specified menu module. You specify a pointer to the context in pd2fctx, the menu module in pd2fmmd, the property number in pnum, and a handle 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 module in pprp.
Note that the client is responsible for freeing the text returned by this function.
d2fmmdgo_GetObjectProp( d2fctx *pd2fctx, d2fmmd *pd2fmmd, ub2 pnum, dvoid *pprp );
This function retrieves a property of type object of the specified menu module. You specify a pointer to the context in pd2fctx, the menu module in pd2fmmd, 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.
d2fmmdgp_GetBlobProp( d2fctx *pd2fctx, d2fmmd *pd2fmmd, 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 module object in pd2fmmd, 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.
d2fmmdsb_SetBoolProp( d2fctx *pd2fctx, d2fmmd *pd2fmmd, ub2 pnum, boolean prp );
This function sets the value of the specified menu module boolean property. You specify a pointer to the context in pd2fctx, the menu module in pd2fmmd, 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.
d2fmmdsn_SetNumProp( d2fctx *pd2fctx, d2fmmd *pd2fmmd, ub2 pnum, number prp );
This function sets the value of the specified menu module number property. You specify a pointer to the context in pd2fctx, the menu module in pd2fmmd, 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.
d2fmmdst_SetTextProp( d2fctx *pd2fctx, d2fmmd *pd2fmmd, ub2 pnum, text *prp );
This function sets the value of the specified menu module text property. You specify a pointer to the context in pd2fctx, the menu module in pd2fmmd, 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.
d2fmmdso_SetObjectProp( d2fctx *pd2fctx, d2fmmd *pd2fmmd, ub2 pnum, dvoid *prp );
This function sets the object of the specified menu module property. You specify a pointer to the context in pd2fctx, the menu module in pd2fmmd, 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.
d2fmmdsp_SetBlobProp( d2fctx *pd2fctx, d2fmmd *pd2fmmd, 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 module object in pd2fmmd, 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.
d2fmmdhp_HasProp( d2fctx *pd2fctx, d2fmmd *pd2fmmd, ub2 pnum );
This function queries the specified menu module for the specified property. You specify a pointer to the context in pd2fctx, the menu module in pd2fmmd, 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.
d2fmmdip_InheritProp( d2fctx *pd2fctx, d2fmmd *pd2fmmd, ub2 pnum );
This function enables the specified menu module to inherit the specified property. You specify a pointer to the context in pd2fctx, a pointer to the menu module in pd2fmmd, 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.
d2fmmdii_IspropInherited( d2fctx *pd2fctx, d2fmmd *pd2fmmd, 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 module object in pd2fmmd, 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.
Creating modules using the Open API
Modifying modules using the Open API