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

Report object functions

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

d2frptcr_Create( d2fctx *pd2fctx, d2fob *parent, d2frpt **ppd2frpt, text *name );

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

This function returns D2FS_SUCCESS if it is able to create a new report object in ppd2frpt.

d2frptde_Destroy( d2fctx *pd2fctx, d2frpt *pd2frpt );

This function destroys the specified report object. You specify a pointer to the context in pd2fctx and a pointer to the report object you want to destroy in pd2frpt.

d2frptdu_Duplicate( d2fctx *pd2fctx, d2fob *new_parent, d2rpt *pd2frpt_src, d2frpt **ppd2frpt_dst, text *new_name );

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

This function returns D2FS_SUCCESS if it is able duplicate the specified report object and place it at the ppd2frpt_dst location.

d2frptgb_GetBoolProp( d2fctx *pd2fctx, d2frpt *pd2frpt, ub2 pnum, boolean *pprp );

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

d2frptgn_GetNumProp( d2fctx *pd2fctx, d2frpt *pd2frpt, ub2 pnum, number *pprp );

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

d2frptgt_GetTextProp( d2fctx *pd2fctx, d2frpt *pd2frpt, ub2 pnum, text **pprp );

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

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

d2frptgo_GetObjectProp( d2fctx *pd2fctx, d2frpt *pd2frpt, ub2 pnum, dvoid **pprp );

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

d2frptgp_GetBlobProp( d2fctx *pd2fctx, d2frpt *pd2frpt, 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 report object in pd2frpt, 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.

d2frptsb_SetBoolProp( d2fctx *pd2fctx, d2frpt *pd2frpt, ub2 pnum, boolean prp );

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

d2frptsn_SetNumProp( d2fctx *pd2fctx, d2frpt *pd2frpt, ub2 pnum, number prp );

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

d2frptst_SetTextProp( d2fctx *pd2fctx, d2frpt *pd2frpt, ub2 pnum, text *prp );

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

d2frptso_SetObjectProp( d2fctx *pd2fctx, d2frpt *pd2frpt, ub2 pnum, dvoid *prp );

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

d2frptsp_SetBlobProp( d2fctx *pd2fctx, d2frpt *pd2frpt, ub2 pnum, dvoid *prp );

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

d2frpthp_HasProp( d2fctx *pd2fctx, d2frpt *pd2frpt, ub2 pnum );

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

d2frptip_InheritProp( d2fctx *pd2fctx, d2frpt *pd2frpt, ub2 pnum );

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

d2frptii_IspropInherited( d2fctx *pd2fctx, d2frpt *pd2frpt, 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 report object in pd2frpt, 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.

d2frptsc_SubClass( d2fctx *pd2fctx, d2frpt *pd2frpt, d2fob *parent, boolean keep_path);

This function returns D2FS_SUCCESS if the specified report object (pd2frpt) becomes a subclass of the specified parent (parent). You specify a pointer to the context in pd2fctx, a pointer to the report in pd2frpt, 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.

d2frptis_IsSubclassed ( d2fctx *pd2fctx, d2frpt *pd2frpt );

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 report object in pd2frpt.

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

Report object macros

Report object API properties

Report object