Developer

API Reference

IRootForm_ResolveForm()

Brew Release
Brew MP 1.0.2
See Also
Description
This function creates a form based on a "form:" URL, returning a pointer to the newly created form referenced by the URL. The URL should identify itself as a "form:" URL scheme, including a path that identifies a handler of type AEEIID_IForm. In order for this path to be resolved a MIME type has to be registered using the ISHELL_RegisterHandler API. This MIME type will then be associated with the specific handler of type AEEIID_IForm.
Parameters
  • pif
    []:
    [in] A pointer to an IRootForm object.
  • u
    []:
    [in] Pointer to the URL to be resolved. The URL should be formatted as a NULL terminated string, defining a "
  • o
    []:
    [out] Pointer to an IForm pointer, into which the function will return a pointer to the form created by the function, or NULL if the function fails.

Interface
Prototype
   int IRootForm_ResolveForm(IRootForm *pif, char const *u, IForm **o);
Return
   
   AEE_SUCCESS              --  The URL was successfully resolved and a new form was created.
   AEE_EBADPARM             --  The function was called with either a NULL URL scheme, or without
                                defining an IForm pointer into which the function would be
                                returning the created form.
   AEE_ESCHEMENOTSUPPORTED  --  The URL passed to the function is ill-formed, either lacking the
                                proper scheme identifier (which must be "form:") or a proper
                                path to an AEEIID_IForm handler.
   AEE_ENOMEMORY            --  Insufficient memory to resolve the URL.

Side Effect
None
Comment
None
  • Follow