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

Alert Object Functions

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

d2faltcr_Create( d2fctx *pd2fctx, d2fob *parent, d2falt **ppd2falt, text *name );

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

This function returns D2FS_D2FS_SUCCESS if it is able to create the new alert object and store it in ppd2falt.

d2faltde_Destroy( d2fctx *pd2fctx, d2falt *pd2falt );

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

d2faltdu_Duplicate( d2fctx *pd2fctx, d2fob *new_parent, d2alt *pd2falt_src, d2falt **ppd2falt_dst, text *new_name );

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

This function returns D2FS_SUCCESS if it is able to duplicate the specified alert object and store it at the ppd2falt_dst location.

d2faltgb_GetBoolProp( d2fctx *pd2fctx, d2falt *pd2falt, ub2 pnum, boolean *pprp );

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

d2faltgn_GetNumProp( d2fctx *pd2fctx, d2falt *pd2falt, ub2 pnum, number *pprp );

This function retrieves a property of type number (an actual scalar constant) for the specified alert object. You specify a pointer to the context in pd2fctx, a pointer to the alert object in pd2falt, the property number in pnum, and a pointer to pprp, to store the numeric property value.

This function returns D2FS_SUCCESS if it stores the value of the number property in pprp.

d2faltgt_GetTextProp( d2fctx *pd2fctx, d2falt *pd2falt, ub2 pnum, text **pprp );

This function retrieves a property of type text for the specified alert object. You specify a pointer to the context in pd2fctx, a pointer to the alert object in pd2falt, 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 alert object in pprp.

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

d2faltgo_GetObjectProp( d2fctx *pd2fctx, d2falt *pd2falt, ub2 pnum, dvoid **pprp );

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

d2faltgp_GetBlobProp( d2fctx *pd2fctx, d2falt *pd2falt, 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 alert object in pd2falt, 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.

d2faltsb_SetBoolProp( d2fctx *pd2fctx, d2falt *pd2falt, ub2 pnum, boolean prp );

This function sets the value of the specified alert object boolean property. You specify a pointer to the context in pd2fctx, a pointer to the alert object in pd2falt, the property number in pnum, and the boolean property value in prp.

This function returns D2FS_SUCCESS if it sets the boolean property with the value you specify in prp.

d2faltsn_SetNumProp( d2fctx *pd2fctx, d2falt *pd2falt, ub2 pnum, number prp );

This function sets the value of the specified alert object number property. You specify a pointer to the context in pd2fctx, a pointer to the alert object in pd2falt, the property number in pnum, and the number property value in prp.

This function returns D2FS_SUCCESS if it sets the number property with the value you specify in prp.

d2faltst_SetTextProp( d2fctx *pd2fctx, d2falt *pd2falt, ub2 pnum, text *prp );

This function sets the value of the specified alert object text property. You specify a pointer to the context in pd2fctx, a pointer to the alert object in pd2falt, the property number in pnum, and a pointer to the text value in prp.

This function returns D2FS_SUCCESS if it sets the specified text property with the value stored in prp.

d2faltso_SetObjectProp( d2fctx *pd2fctx, d2falt *pd2falt, ub2 pnum, dvoid *prp );

This function sets the object of the specified alert object property. You specify a pointer to the context in pd2fctx, a pointer to the alert object in pd2falt, a property number in pnum, and a pointer to the object property in prp.

This function returns D2FS_SUCCESS if it sets the specified object property with the value stored in prp.

d2faltsp_SetBlobProp( d2fctx *pd2fctx, d2falt *pd2falt, ub2 pnum, dvoid *prp );

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

d2falthp_HasProp( d2fctx *pd2fctx, d2falt *pd2falt, ub2 pnum );

This function queries the specified alert object for the specified property. You specify a pointer to the context in pd2fctx, a pointer to the alert object in pd2falt, 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 specific circumstances. For a complete list of the valid Open Forms API return values, refer to the "About Open API function return codes" section.

d2faltip_InheritProp( d2fctx *pd2fctx, d2falt *pd2falt, ub2 pnum );

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

d2faltii_IspropInherited( d2fctx *pd2fctx, d2falt *pd2falt, 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 alert object in pd2falt, 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.

d2faltsc_SubClass( d2fctx *pd2fctx, d2falt *pd2falt, d2fob *parent, boolean keep_path);

This function returns D2FS_SUCCESS if the specified alert object (pd2falt) becomes a subclass of the specified parent (parent). You specify a pointer to the context in pd2fctx, a pointer to the alert object in pd2falt, a pointer to the parent object in parent, and a boolean flag to indicate if the function saves the path to the parent object in keep_path.

Note that the Forms API uses the boolean keep_path argument to save the actual path information. It is recommended that you do not set keep_path to TRUE since this information may be lost if you move to another machine. If keep_path is set to TRUE, the Forms API saves the actual path in the .fnb file. Therefore, the next time the form is loaded, depending on how the environment variable Forms 4.5 or 5.0 path is defined, the Forms API searches for the parent form in one of the specified directories defined by the environment variable.

d2faltis_IsSubclassed ( d2fctx *pd2fctx, d2falt *pd2falt );

This function verifies that the specified object is a subclass of another object. You specify a pointer to the context in pd2fctx and a pointer to the alert object in pd2falt.

If the function succeeds, it returns D2FS_YES or D2FS_NO, depending on whether the specified object is a subclass of another object; 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

Alert Object Macros

Alert object API properties

Alert object API