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

Record group column specification object functions

This section describes the functions of the Oracle Forms Open API Record Group Column Specification object.

d2frcscr_Create( d2fctx *pd2fctx, d2fob *parent, d2frcs **ppd2frcs, text *name );

This function creates a record group column specification. You specify a pointer to the context in pd2fctx, a pointer to the parent of the new record group column specification object in parent, a handle for the function to store the newly-created object in ppd2frcs, and the name of the new object in name.

This function returns D2FS_SUCCESS if it is able to create a new record group column specification in ppd2frcs.

d2frcsde_Destroy( d2fctx *pd2fctx, d2frcs *pd2frcs );

This function destroys the specified record group column specification. You specify a pointer to the context in pd2fctx and a pointer to the record group column specification you want to destroy in pd2frcs.

d2frcsdu_Duplicate( d2fctx *pd2fctx, d2fob *new_parent, d2rcs *pd2frcs_src, d2frcs **ppd2frcs_dst, text *new_name );

This function duplicates the specified record group column specification. You specify a pointer to the context in pd2fctx, a pointer to the new parent in new_parent, a pointer to the record group column specification source in pd2frcs_src, a handle for the function to store the destination in ppd2frcs_dst, and a pointer for the name of the new record group column specification (new_name).

This function returns D2FS_SUCCESS if it is able duplicate the specified record group column specification and place it at the ppd2frcs_dst location.

d2frcsir_InsertRow( d2fctx *pd2fctx, d2frcs *pd2frcs, number index, text *dat );

This function inserts a row into the specified record group specification object. You specify a pointer to the context in pd2fctx, a pointer to the record group specification object in pd2frcs, the index into the row list where the function is to insert the row in index, and a pointer to the data in dat.

Note that you need to first create a record group object, then you need to create a new record group column object, and finally, you can insert rows into that associated column value.

Note that there is a Forms API property called D2FP_COL_VALS_COUNT that you can use to retrieve the count of all columns for a record group column specification.

d2frcsdr_DeleteRow( d2fctx *pd2fctx, d2frcs *pd2frcs, number index );

This function deletes the specified row from the specified record group specification object. You specify a pointer to the context in pd2fctx, a pointer to the record group specification object in pd2frcs, and the index into the row list where the function is to delete the row in index.

Note that there is a Forms API property called D2FP_COL_VALS_COUNT that you can use to retrieve the count of all columns for a record group column specification.

d2frcsgr_GetRow( d2fctx *pd2fctx, d2frcs *pd2frcs, number index, text **dat );

This function retrieves a row from the specified record group specification object. You specify a pointer to the context in pd2fctx, a pointer to the record group specification object in pd2frcs, the index into the row list where the function is to retrieve the row in index, and handle for the function to return the row in dat.

Note that there is a Forms API property called D2FP_COL_VALS_COUNT that you can use to retrieve the count of all columns for a record group column specification.

d2frcsgb_GetBoolProp( d2fctx *pd2fctx, d2frcs *pd2frcs, ub2 pnum, boolean *pprp );

This function retrieves a property of type boolean for the specified record group column specification. You specify a pointer to the context in pd2fctx, the record group column specification in pd2frcs, 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.

d2frcsgn_GetNumProp( d2fctx *pd2fctx, d2frcs *pd2frcs, ub2 pnum, number *pprp );

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

d2frcsgt_GetTextProp( d2fctx *pd2fctx, d2frcs *pd2frcs, ub2 pnum, text **pprp );

This function retrieves a property of type text for the specified record group column specification. You specify a pointer to the context in pd2fctx, the record group column specification in pd2frcs, 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 record group column specification in pprp.

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

d2frcsgo_GetObjectProp( d2fctx *pd2fctx, d2frcs *pd2frcs, ub2 pnum, dvoid **pprp );

This function retrieves a property of type object of the specified record group column specification. You specify a pointer to the context in pd2fctx, the record group column specification in pd2frcs, 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.

d2frcsgp_GetBlobProp( d2fctx *pd2fctx, d2frcs *pd2frcs, 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 record group column specification object in pd2frcs, 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.

d2frcssb_SetBoolProp( d2fctx *pd2fctx, d2frcs *pd2frcs, ub2 pnum, boolean prp );

This function sets the value of the specified record group column specification boolean property. You specify a pointer to the context in pd2fctx, the record group column specification in pd2frcs, 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.

d2frcssn_SetNumProp( d2fctx *pd2fctx, d2frcs *pd2frcs, ub2 pnum, number prp );

This function sets the value of the specified record group column specification number property. You specify a pointer to the context in pd2fctx, the record group column specification in pd2frcs, 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.

d2frcsst_SetTextProp( d2fctx *pd2fctx, d2frcs *pd2frcs, ub2 pnum, text *prp );

This function sets the value of the specified record group column specification text property. You specify a pointer to the context in pd2fctx, the record group column specification in pd2frcs, 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.

d2frcsso_SetObjectProp( d2fctx *pd2fctx, d2frcs *pd2frcs, ub2 pnum, dvoid *prp );

This function sets the object of the specified record group column specification property. You specify a pointer to the context in pd2fctx, the record group column specification in pd2frcs, 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.

d2frcssp_SetBlobProp( d2fctx *pd2fctx, d2frcs *pd2frcs, ub2 pnum, dvoid *prp );

This function sets the client-specified handle. You specify a pointer to the context in pd2fctx, a pointer to the record group column specification object in pd2frcs, 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.

d2frcshp_HasProp( d2fctx *pd2fctx, d2frcs *pd2frcs, ub2 pnum );

This function queries the specified record group column specification for the specified property. You specify a pointer to the context in pd2fctx, the record group column specification in pd2frcs, 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.

d2frcsip_InheritProp( d2fctx *pd2fctx, d2frcs *pd2frcs, ub2 pnum );

This function enables the specified record group column specification to inherit the specified property. You specify a pointer to the context in pd2fctx, a pointer to the record group column specification object in pd2frcs, 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.

d2frcsii_IspropInherited( d2fctx *pd2fctx, d2frcs *pd2frcs, 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 record group column specification object in pd2frcs, 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

Record group column specification object macros

Record group column specification API properties

Record group column specification object