Function Reference


_IEFormGetObjByName

Returns an object reference to a Form by name

#include <IE.au3>
_IEFormGetObjByName ( ByRef $oObject, $sName [, $iIndex = 0] )

Parameters

$oObject Object variable of an InternetExplorer.Application, Window or Frame object
$sName Specifies the name of the Form you wish to match
$iIndex [optional] If Form name occurs more than once, specifies instance by 0-based index
    0 (Default) or positive integer returns an indexed instance
    -1 returns a collection of the specified Forms

Return Value

Success: an object variable pointing to the Form object, @extended = form count.
Failure: sets the @error flag to non-zero.
@error: 3 ($_IEStatus_InvalidDataType) - Invalid Data Type
7 ($_IEStatus_NoMatch) - No Match
@extended: Contains invalid parameter number

Remarks

If the desired form does not have a name or ID, _IEFormGetCollection() to get a reference by index.

Related

_IEFormGetCollection, _IEFormReset, _IEFormSubmit

Example

; Get a reference to a specific form by name.  In this case, submit a query
; to the Google search engine.  Note that the names of the form and form
; elements can be found by viewing the page HTML source

#include <IE.au3>

Local $oIE = _IECreate("http://www.google.com")
Local $oForm = _IEFormGetObjByName($oIE, "gbqf")
Local $oQuery = _IEFormElementGetObjByName($oForm, "q")
_IEFormElementSetValue($oQuery, "AutoIt IE.au3")
_IEFormSubmit($oForm)