DefineField Method (parent, name, sequence, flags, earliestVersion)

[This is preliminary documentation and is subject to change.]

Define a field of a SIF Data Object.

Declaration Syntax

Visual Basic

Visual C++

public IElementDef DefineField(
	IElementDef parent,
	string name,
	int sequence,
	byte flags,
	SifVersion earliestVersion
)

Public Function DefineField ( _
	parent As IElementDef, _
	name As String, _
	sequence As Integer, _
	flags As Byte, _
	earliestVersion As SifVersion _
) As IElementDef

public:
IElementDef^ DefineField (
	IElementDef^ parent, 
	String^ name, 
	int sequence, 
	unsigned char flags, 
	SifVersion^ earliestVersion
)

Parameters

parent (IElementDef): The IElementDef constant identifying the parent data object or element
name (String): The tag name of the element
sequence (Int32): The zero-based sequence number of the element
flags (Byte): Optional flags for this field (e.g. MD_REPEATABLE), or zero if no flags are applicable
earliestVersion (SifVersion): The earliest version of the specification this element should be recognized in

Return Value

Remarks

A field is a simple child element that has no attributes or elements of its own and is not represented by its own class. For example, the <LocalId> common element in SIF 1.5. Internally, the ADK stores fields more efficiently than complex elements.

Assembly: Edustructures.SifWorks.Adk (Module: Edustructures.SifWorks.Adk) Version: 2.0.0.10