[This is preliminary documentation and is subject to change.]
Find an SifElement given a SIF Query Pattern string.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public Element LookupBySQP( SifDataObject relativeTo, string query )
Public Function LookupBySQP ( _ relativeTo As SifDataObject, _ query As String _ ) As Element
public: Element^ LookupBySQP ( SifDataObject^ relativeTo, String^ query )
Parameters- relativeTo (SifDataObject)
- An IElementDef identifying a SIF Data Object to which the query is relative to (e.g. STUDENTPERSONAL, BUSINFO, etc.)
- query (String)
- A SIF Query Pattern string as described by the SIF 1.0r1 Specification
Return Value The Element satisfying the query, or null if no
match was found. If the query resolves to an attribute, a SimpleField
object is returned. If the query resolves to an element, a SifElement
object is returned. In both cases the caller can obtain the text
value of the attribute or element by calling its TextValue
property.