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

Relation object functions

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

d2frelcr_Create( d2fctx *pd2fctx, d2fob *parent, d2frel **ppd2frel, text *name );

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

This function returns D2FS_SUCCESS if it is able to create a new relation in ppd2frel.

d2frelde_Destroy( d2fctx *pd2fctx, d2frel *pd2frel );

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

d2frelup_Update( d2fctx *pd2fctx, d2frel *pd2frel );

This function updates the specified relation object. You specify a pointer to the context in pd2fctx and a pointer to the relation object in pd2frel.

With conventional Forms objects, you first create an object, and then you begin setting and retrieving its object properties. Relation objects require an additional step after you create it to "instantiate" the object. So, with relation objects, you first create them, then you set specific properties of the relation object, and then you call this update function. If you do not call this function, the relation object is not complete and the behavior is undefined. The relation object subsequently exists in an "unstable" state (if you actually tried to do anything with an unstable relation object, the Forms API returns an error).

d2freldu_Duplicate( d2fctx *pd2fctx, d2fob *new_parent, d2rel *pd2frel_src, d2frel **ppd2frel_dst, text *new_name );

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

This function returns D2FS_SUCCESS if it is able duplicate the specified relation and place it at the ppd2frel_dst location.

d2frelgb_GetBoolProp( d2fctx *pd2fctx, d2frel *pd2frel, ub2 pnum, boolean *pprp );

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

d2frelgn_GetNumProp( d2fctx *pd2fctx, d2frel *pd2frel, ub2 pnum, number *pprp );

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

d2frelgt_GetTextProp( d2fctx *pd2fctx, d2frel *pd2frel, ub2 pnum, text **pprp );

This function retrieves a property of type text for the specified relation. You specify a pointer to the context in pd2fctx, the relation in pd2frel, the property number in pnum, and a pointer 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 relation in pprp.

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

d2frelgo_GetObjectProp( d2fctx *pd2fctx, d2frel *pd2frel, ub2 pnum, dvoid **pprp );

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

d2frelgp_GetBlobProp( d2fctx *pd2fctx, d2frel *pd2frel, 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 relation object in pd2frel, 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.

d2frelsb_SetBoolProp( d2fctx *pd2fctx, d2frel *pd2frel, ub2 pnum, boolean prp );

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

d2frelsn_SetNumProp( d2fctx *pd2fctx, d2frel *pd2frel, ub2 pnum, number prp );

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

d2frelst_SetTextProp( d2fctx *pd2fctx, d2frel *pd2frel, ub2 pnum, text *prp );

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

d2frelso_SetObjectProp( d2fctx *pd2fctx, d2frel *pd2frel, ub2 pnum, dvoid *prp );

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

d2frelsp_SetBlobProp( d2fctx *pd2fctx, d2frel *pd2frel, ub2 pnum, dvoid *prp );

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

d2frelhp_HasProp( d2fctx *pd2fctx, d2frel *pd2frel, ub2 pnum );

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

d2frelip_InheritProp( d2fctx *pd2fctx, d2frel *pd2frel, ub2 pnum );

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

d2frelii_IspropInherited( d2fctx *pd2fctx, d2frel *pd2frel, 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 relation object in pd2frel, 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

Relation object macros

Relation object API properties

Relation object