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

Datasource argument object functions

This section describes the functions of the Oracle Forms Open API Data Source Argument object.

d2fdsacr_Create( d2fctx *pd2fctx, d2fob *parent, d2fdsa **ppd2fdsa, text *name );

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

This function returns D2FS_SUCCESS if it is able to create and store a new data source argument in ppd2fdsa.

d2fdsade_Destroy( d2fctx *pd2fctx, d2fdsa *pd2fdsa );

This function destroys the specified data source argument. You specify a pointer to the context in pd2fctx and a pointer to the data source argument you want to destroy in pd2fdsa.

d2fdsadu_Duplicate( d2fctx *pd2fctx, d2fob *new_parent, d2dsa *pd2fdsa_src, d2fdsa **ppd2fdsa_dst, text *new_name );

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

This function returns D2FS_SUCCESS if it is able duplicate the specified data source argument and store it at the ppd2fdsa_dst location.

d2fdsagb_GetBoolProp( d2fctx *pd2fctx, d2fdsa *pd2fdsa, ub2 pnum, boolean *pprp );

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

d2fdsagn_GetNumProp( d2fctx *pd2fctx, d2fdsa *pd2fdsa, ub2 pnum, number *pprp );

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

d2fdsagt_GetTextProp( d2fctx *pd2fctx, d2fdsa *pd2fdsa, ub2 pnum, text **pprp );

This function retrieves a property of type text for the specified data source argument. You specify a pointer to the context in pd2fctx, the data source argument in pd2fdsa, the property number in pnum, and a handle to an array of characters for the function to store the text property value in pprp.

This function returns D2FS_SUCCESS if it fills the supplied array with a copy of the text property value for the specified data source argument in pprp.

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

d2fdsago_GetObjectProp( d2fctx *pd2fctx, d2fdsa *pd2fdsa, ub2 pnum, dvoid **pprp );

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

d2fdsagp_GetBlobProp( d2fctx *pd2fctx, d2fdsa *pd2fdsa, 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 data source argument object in pd2fdsa, 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.

d2fdsasb_SetBoolProp( d2fctx *pd2fctx, d2fdsa *pd2fdsa, ub2 pnum, boolean prp );

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

d2fdsasn_SetNumProp( d2fctx *pd2fctx, d2fdsa *pd2fdsa, ub2 pnum, number prp );

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

d2fdsast_SetTextProp( d2fctx *pd2fctx, d2fdsa *pd2fdsa, ub2 pnum, text *prp );

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

d2fdsaso_SetObjectProp( d2fctx *pd2fctx, d2fdsa *pd2fdsa, ub2 pnum, dvoid *prp );

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

d2fdsasp_SetBlobProp( d2fctx *pd2fctx, d2fdsa *pd2fdsa, ub2 pnum, dvoid *prp );

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

d2fdsahp_HasProp( d2fctx *pd2fctx, d2fdsa *pd2fdsa, ub2 pnum );

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

d2fdsaip_InheritProp( d2fctx *pd2fctx, d2fdsa *pd2fdsa, ub2 pnum );

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

d2fdsaii_IspropInherited( d2fctx *pd2fctx, d2fdsa *pd2fdsa, 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 data source argument object in pd2fdsa, 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

Datasource argument object macros

Datasource argument object API properties

Data source argument object