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

Form Module Object Functions

This section describes the functions of the Oracle Forms Open API Form Module object.

d2ffmdcr_Create( d2fctx *pd2fctx, d2fob *parent, d2ffmd **ppd2ffmd, text *name );

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

d2ffmdde_Destroy( d2fctx *pd2fctx, d2ffmd *pd2ffmd );

This function destroys the specified form module. You specify a pointer to the context in pd2fctx and a pointer to the form module you want to destroy in pd2ffmd.

d2ffmddl_Delete( d2fctx *pd2fctx, text *name, boolean db );

This function deletes the specified form module. You specify a pointer to the context in pd2fctx, a pointer to a text string for the name of the form module, and a boolean flag to indicate if the form module is to be deleted from a database (for example, an open library, a form module, or a menu module) in db.

If db is TRUE, the Forms API assumes that you want to delete the specified form module from a database; if db is FALSE, the Forms API searches the file system for the specified form module and then deletes it.

d2ffmddu_Duplicate( d2fctx *pd2fctx, d2fob *new_parent, d2fmd *pd2ffmd_src, d2ffmd **ppd2ffmd_dst, text *new_name );

This function duplicates the specified form module. You specify a pointer to the context in pd2fctx, a pointer to the new parent in new_parent, a pointer to the form module source in pd2ffmd_src, a handle for the function to store the destination in ppd2ffmd_dst, and a pointer for the name of the new form module (new_name).

This function returns D2FS_SUCCESS if it is able duplicate the specified form module and place it at the ppd2ffmd_dst location.

d2ffmdco_CompileObj ( d2fctx *pd2fctx, d2ffmd *pd2ffmd );

This function compiles all of the PL/SQL code associated with the specified form module. You specify a pointer to the context in pd2fctx and a pointer to the object you want to compile in pd2ffmd.

For example, you might use this function to compile all of the trigger objects attached to a form module, and all of the trigger objects attached to all item objects on a form module.

d2ffmdcf_CompileFile( d2fctx *pd2fctx, d2ffmd *pd2ffmd );

This function compiles a .fmb file and creates a generated .fmx file. You specify the context (pd2fctx) and a pointer to a form module object (pd2ffmd).

d2ffmdld_Load ( d2fctx *pd2fctx, d2ffmd **ppd2ffmd, text *formname, boolean db );

This function loads the specified form module. You specify the context (pd2fctx), a handle to a pointer for the function to use to store the form module (ppd2ffmd), the name of the form module (formname), and a boolean flag (db) to indicate if the form module is in a database.

If db is TRUE, the Forms API searches for the specified form module in the database. Note that this assumes that you have connected to some database. You must call d2fctx_Connect() before you load a form module from a database.

d2ffmdsv_Save ( d2fctx *pd2fctx, d2ffmd *pd2ffmd, text *formname, boolean db );

This function saves the specified form module. You specify the context (pd2fctx), a pointer to the form module (pd2ffmd), the name of the specified form module (formname), and a boolean flag (db) that indicates if the form module is to be saved in a database.

If db is TRUE, the Forms API saves the specified form module in the database. Note that this assumes that you have connected to some database previously. You must call d2fctx_Connect() before you save a form module to a database.

Note that if you want to save the form module with the default name (the name supplied at create time), you must pass NULL as the text string in formname. If you want to save the form module as some other name, then pass in that text string in formname.

d2ffmdfv_FileVersion ( d2fctx *pd2fctx, text *formname, boolean db, number *version );

This function returns the version of the form module. You specify the context (pd2fctx), the form module name (formname), a boolean flag (db) to indicate if the form 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 d2ffmdld_Load() function, since the file version will change once you load the form module.

d2ffmdgb_GetBoolProp( d2fctx *pd2fctx, d2ffmd *pd2ffmd, ub2 pnum, boolean *pprp );

This function retrieves a property of type boolean for the specified form module. You specify a pointer to the context in pd2fctx, the form module in pd2ffmd, 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.

d2ffmdgn_GetNumProp( d2fctx *pd2fctx, d2ffmd *pd2ffmd, ub2 pnum, number *pprp );

This function retrieves a property of type number (an actual scalar constant) for the specified form module. You specify a pointer to the context in pd2fctx, the form module in pd2ffmd, 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.

d2ffmdgt_GetTextProp( d2fctx *pd2fctx, d2ffmd *pd2ffmd, ub2 pnum, text **pprp );

This function retrieves a property of type text for the specified form module. You specify a pointer to the context in pd2fctx, the form module in pd2ffmd, 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 form module in pprp.

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

d2ffmdgo_GetObjectProp( d2fctx *pd2fctx, d2ffmd *pd2ffmd, ub2 pnum, dvoid **pprp );

This function retrieves a property of type object of the specified form module. You specify a pointer to the context in pd2fctx, the form module in pd2ffmd, 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.

d2ffmdgp_GetBlobProp( d2fctx *pd2fctx, d2ffmd *pd2ffmd, 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 form module object in pd2ffmd, 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.

d2ffmdsb_SetBoolProp( d2fctx *pd2fctx, d2ffmd *pd2ffmd, ub2 pnum, boolean prp );

This function sets the value of the specified form module boolean property. You specify a pointer to the context in pd2fctx, the form module in pd2ffmd, 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.

d2ffmdsn_SetNumProp( d2fctx *pd2fctx, d2ffmd *pd2ffmd, ub2 pnum, number prp );

This function sets the value of the specified form module number property. You specify a pointer to the context in pd2fctx, the form module in pd2ffmd, 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.

d2ffmdst_SetTextProp( d2fctx *pd2fctx, d2ffmd *pd2ffmd, ub2 pnum, text *prp );

This function sets the value of the specified form module text property. You specify a pointer to the context in pd2fctx, the form module in pd2ffmd, 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.

d2ffmdso_SetObjectProp( d2fctx *pd2fctx, d2ffmd *pd2ffmd, ub2 pnum, dvoid *prp );

This function sets the object of the specified form module property. You specify a pointer to the context in pd2fctx, the form module in pd2ffmd, 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.

d2ffmdsp_SetBlobProp( d2fctx *pd2fctx, d2ffmd *pd2ffmd, ub2 pnum, dvoid *prp );

This function sets the client-specified handle. You specify a pointer to the context in pd2fctx, a pointer to the form module object in pd2ffmd, 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.

d2ffmdhp_HasProp( d2fctx *pd2fctx, d2ffmd *pd2ffmd, ub2 pnum );

This function queries the specified form module for the specified property. You specify a pointer to the context in pd2fctx, the form module in pd2ffmd, 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.

d2ffmdip_InheritProp( d2fctx *pd2fctx, d2ffmd *pd2ffmd, ub2 pnum );

This function enables the specified form module to inherit the specified property. You specify a pointer to the context in pd2fctx, a pointer to the form module object in pd2ffmd, 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.

d2ffmdii_IspropInherited( d2fctx *pd2fctx, d2ffmd *pd2ffmd, 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 form module object in pd2ffmd, 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

About Open API header files

Form module object macros

Form module object API properties

Form module object