This section describes the functions of the Oracle Forms Open API Attached Library object.
d2falbat_Attach( d2fctx *pd2fctx, d2fob *parent, d2falb **ppd2falb, boolean db, text *name );
This function attaches the specified library to a database (such as a form, menu, or PL/SQL library) or file system. You specify a pointer to the context in pd2fctx, a pointer to where you want the library attached in parent, a handle for the returned attached library in ppd2falb, a boolean flag to indicate whether the library resides in a database or a file system in db, and a pointer to the name of the library in name.
If you set db to TRUE, the Forms API searches for the specified library (the name passed in name) in a database. If db is set to FALSE, the library resides in a file system and the Forms API searches the file system for the specified library and then attaches it. For example, if you want to attach a library to a form module and the library resides in the file system, set db to FALSE.
d2falbdt_Detach( d2fctx *pd2fctx, d2falb *pd2falb );
This function detaches the specified library from a database or file system. You specify a pointer to the context in pd2fctx and a pointer the attached library in ppd2falb.
d2falbgb_GetBoolProp( d2fctx *pd2fctx, d2falb *pd2falb, ub2 pnum, boolean *pprp );
This function retrieves a property of type boolean for the specified attached library. You specify a pointer to the context in pd2fctx, a pointer to the attached library in pd2falb, the property number in pnum, and a pointer to pprp, to store the boolean property value.
This function returns D2FS_SUCCESS if it stores the value of the boolean property in pprp.
d2falbgn_GetNumProp( d2fctx *pd2fctx, d2falb *pd2falb, ub2 pnum, number *pprp );
This function retrieves a property of type number (an actual scalar constant) for the specified attached library. You specify a pointer to the context in pd2fctx, a pointer to the attached library in pd2falb, the property number in pnum, and a pointer to pprp, to store the retrieved numeric property value.
This function returns D2FS_SUCCESS if it stores the value of the number property in pprp.
d2falbgt_GetTextProp( d2fctx *pd2fctx, d2falb *pd2falb, ub2 pnum, text **pprp );
This function retrieves a property of type text for the specified attached library. You specify a pointer to the context in pd2fctx, a pointer to the attached library in pd2falb, the property number in pnum, and a handle to an array of characters for the function to store the text property value (pprp).
This function returns D2FS_SUCCESS if it fills the supplied array with a copy of the text property value for the specified attached library in pprp.
Note that the client is responsible for freeing the text returned by this function.
d2falbgo_GetObjectProp( d2fctx *pd2fctx, d2falb *pd2falb, ub2 pnum, dvoid **pprp );
This function retrieves a property of type object of the specified attached library. You specify a pointer to the context in pd2fctx, a pointer to the attached library in pd2falb, 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.
d2falbgp_GetBlobProp( d2fctx *pd2fctx, d2falb *pd2falb, 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 attached library in pd2falb, 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.
d2falbsb_SetBoolProp( d2fctx *pd2fctx, d2falb *pd2falb, ub2 pnum, boolean prp );
This function sets the value of the specified attached library boolean property. You specify a pointer to the context in pd2fctx, a pointer to the attached library in pd2falb, the property number in pnum, and the boolean property value in prp.
This function returns D2FS_SUCCESS if it sets the specified boolean property with the value you specify in prp.
d2falbsn_SetNumProp( d2fctx *pd2fctx, d2falb *pd2falb, ub2 pnum, number prp );
This function sets the value of the specified attached library number property. You specify a pointer to the context in pd2fctx, a pointer to the attached library in pd2falb, the property number in pnum, and the number property value in prp.
This function returns D2FS_SUCCESS if it sets the specified number property with the value you specify in prp.
d2falbst_SetTextProp( d2fctx *pd2fctx, d2falb *pd2falb, ub2 pnum, text *prp );
This function sets the value of the specified attached library text property. You specify a pointer to the context in pd2fctx, a pointer to the attached library in pd2falb, the property number in pnum, and a pointer to the text property value in prp.
This function returns D2FS_SUCCESS if it is sets the specified text property with the value stored in prp.
d2falbso_SetObjectProp( d2fctx *pd2fctx, d2falb *pd2falb, ub2 pnum, dvoid *prp );
This function sets the object of the specified attached library property. You specify a pointer to the context in pd2fctx, a pointer to the attached library in pd2falb, a property number in pnum, and a pointer to the object property value in prp.
This function returns D2FS_SUCCESS if it sets the specified object property with the value stored in prp.
d2falbsp_SetBlobProp( d2fctx *pd2fctx, d2falb *pd2falb, ub2 pnum, dvoid *prp );
This function sets the client-specified handle. You specify a pointer to the context in pd2fctx, a pointer to the attached library object in pd2falb, 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.
d2falbhp_HasProp( d2fctx *pd2fctx, d2falb *pd2falb, ub2 pnum );
This function queries the specified attached library for the specified property. You specify a pointer to the context in pd2fctx, a pointer to the attached library in pd2falb, 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.
d2falbip_InheritProp( d2fctx *pd2fctx, d2falb *pd2falb, ub2 pnum );
This function enables the specified attached library to inherit the specified property. You specify a pointer to the context in pd2fctx, a pointer to the attached library object in pd2falb, 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.
d2falbii_IspropInherited( d2fctx *pd2fctx, d2falb *pd2falb, 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 attached library object in pd2falb, 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
Attached Library Object Macros