This section describes the functions of the Oracle Forms Open API Object Group Child object.
d2fogcgcr_Create( d2fctx *pd2fctx, d2fogc *parent, d2fogc **ppd2fogc, text *name );
This function creates an object group child. You specify a pointer to the context in pd2fctx, a pointer to the parent of the new object group child object in parent, a handle for the function to store the newly-created object in ppd2fogc, and the name of the new object in name.
This function returns D2FS_SUCCESS if it is able to create a new object group in ppd2fogcg.
d2fogcgde_Destroy( d2fctx *pd2fctx, d2fogc *pd2fogc );
This function destroys the specified object group child. You specify a pointer to the context in pd2fctx and a pointer to the object group child you want to destroy in pd2fogc.
d2fogcgdu_Duplicate( d2fctx *pd2fctx, d2fogc *new_parent, d2ogc *pd2fogc_src, d2fogc **ppd2fogc_dst, text *new_name );
This function duplicates the specified object group child. You specify a pointer to the context in pd2fctx, a pointer to the new parent in new_parent, a pointer to the object group child source in pd2fogc_src, a handle for the function to store the destination in ppd2fogc_dst, and a pointer for the name of the new object group child (new_name).
This function returns D2FS_SUCCESS if it is able duplicate the specified object group child and place it at the ppd2fogcg_dst location.
d2fogcggb_GetBoolProp( d2fctx *pd2fctx, d2fogc *pd2fogc, ub2 pnum, boolean *pprp );
This function retrieves a property of type boolean for the specified object group child. You specify a pointer to the context in pd2fctx, the object group child in pd2fogc, 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.
d2fogcggn_GetNumProp( d2fctx *pd2fctx, d2fogc *pd2fogc, ub2 pnum, number *pprp );
This function retrieves a property of type number (an actual scalar constant) for the specified object group child. You specify a pointer to the context in pd2fctx, the object group child in pd2fogc, 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.
d2fogcggt_GetTextProp( d2fctx *pd2fctx, d2fogc *pd2fogc, ub2 pnum, text **pprp );
This function retrieves a property of type text for the specified object group child. You specify a pointer to the context in pd2fctx, the object group child in pd2fogc, 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 object group child in pprp.
Note that the client is responsible for freeing the text returned by this function.
d2fogcggo_GetObjectProp( d2fctx *pd2fctx, d2fogc *pd2fogc, ub2 pnum, dvoid **pprp );
This function retrieves a property of type object of the specified object group child. You specify a pointer to the context in pd2fctx, the object group child in pd2fogc, 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.
d2fogcggp_GetBlobProp( d2fctx *pd2fctx, d2fogc *pd2fogc, 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 object group child object in pd2fogc, 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.
d2fogcgsb_SetBoolProp( d2fctx *pd2fctx, d2fogc *pd2fogc, ub2 pnum, boolean prp );
This function sets the value of the specified object group child boolean property. You specify a pointer to the context in pd2fctx, the object group child in pd2fogc, 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.
d2fogcgsn_SetNumProp( d2fctx *pd2fctx, d2fogc *pd2fogc, ub2 pnum, number prp );
This function sets the value of the specified object group child number property. You specify a pointer to the context in pd2fctx, the object group child in pd2fogc, 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.
d2fogcgst_SetTextProp( d2fctx *pd2fctx, d2fogc *pd2fogc, ub2 pnum, text *prp );
This function sets the value of the specified object group child text property. You specify a pointer to the context in pd2fctx, the object group child in pd2fogc, 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.
d2fogcgso_SetObjectProp( d2fctx *pd2fctx, d2fogc *pd2fogc, ub2 pnum, dvoid *prp );
This function sets the object of the specified object group child property. You specify a pointer to the context in pd2fctx, the object group child in pd2fogc, 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.
d2fogcgsp_SetBlobProp( d2fctx *pd2fctx, d2fogc *pd2fogc, ub2 pnum, dvoid *prp );
This function sets the client-specified handle. You specify a pointer to the context in pd2fctx, a pointer to the specified object group child object in pd2fogc, 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.
d2fogcghp_HasProp( d2fctx *pd2fctx, d2fogc *pd2fogc, ub2 pnum );
This function queries the specified object group child for the specified property. You specify a pointer to the context in pd2fctx, the object group child in pd2fogc, 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.
d2fogcgip_InheritProp( d2fctx *pd2fctx, d2fogc *pd2fogc, ub2 pnum );
This function enables the specified object group child to inherit the specified property. You specify a pointer to the context in pd2fctx, a pointer to the object group child in pd2fogc, 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.
d2fogcgii_IspropInherited( d2fctx *pd2fctx, d2fogc *pd2fogc, 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 object group child object in pd2fogc, 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
Object group child object macros