PushTechnology.ClientInterface.Client.Content.IStructuredReader Interface Reference

A structured reader allowing the record content to be read using IMRecord metadata. More...

Inherited by PushTechnology.ClientInterface.Client.Content.RecordStructuredReader.

Public Member Functions
string	Get (string name)
	Gets a field value by name. More...
string	Get (string name, int index)
	Get the value of a specified occurrence of a repeating field. More...
List< string >	GetValues (string name)
	Returns a list of the values of the named field. More...

Detailed Description

A structured reader allowing the record content to be read using IMRecord metadata.

Such a reader may be created using IRecord.CreateNewReader(IMRecord).

The reader will validate record content against the metadata allowing a zero-length string in any field. If a different empty field value is to be permitted as well as zero-length string (which typically indicates 'no change' in a field), create the builder using IRecord.CreateNewReader(IMRecord, string).

Member Function Documentation

string PushTechnology.ClientInterface.Client.Content.IStructuredReader.Get

(

string

name

)

Gets a field value by name.

This can only be used for a non-repeating field.

Parameters

name	The field name.

Returns

string PushTechnology.ClientInterface.Client.Content.IStructuredReader.Get	(	string	name,
		int	index
	)

Get the value of a specified occurrence of a repeating field.

That can only be used for a field that is declared as repeating.

Parameters

name
index

Returns

List<string> PushTechnology.ClientInterface.Client.Content.IStructuredReader.GetValues

(

string

name

)

Returns a list of the values of the named field.

Parameters

name	The field name.

Returns

A list of values which may be empty for optional fields and will contain only a single value for a single value field.

---

The documentation for this interface was generated from the following file:

• LegacyModule/Client/Content/IStructuredReader.cs