PushTechnology.ClientInterface.Client.Content.Metadata.IRecordContentReader Interface Reference

Record content reader. More...

Inheritance diagram for PushTechnology.ClientInterface.Client.Content.Metadata.IRecordContentReader:

Public Member Functions
IRecord	NextRecord ()
	Returns a record of string data from the current content position. More...
string	NextField ()
	Returns a field of string data from the current content position. More...
bool	HasMoreFields ()
	Indicates whether there are more fields to read. More...
bool	HasMoreRecords ()
	Indicates whether there are more records to read. More...
void	Reset ()
	Reset the reader so that it can be used to start reading the content again from the beginning. More...

Detailed Description

Record content reader.

Allows data content to be read in record/field format.

Member Function Documentation

bool PushTechnology.ClientInterface.Client.Content.Metadata.IRecordContentReader.HasMoreFields

(

)

Indicates whether there are more fields to read.

Returns

true if there are more fields beyond the current position.

bool PushTechnology.ClientInterface.Client.Content.Metadata.IRecordContentReader.HasMoreRecords

(

)

Indicates whether there are more records to read.

Returns

true if there are more records beyond the current position.

string PushTechnology.ClientInterface.Client.Content.Metadata.IRecordContentReader.NextField

(

)

Returns a field of string data from the current content position.

This returns a field of String data constructed from bytes read from the current content position to the next field delimiter (or record delimiter) within the buffer or the end of the content.

HasMoreFields may be called before calling this method to determine whether there are any more fields to read.

After calling this method the content pointer will be moved beyond the delimiter found.

Empty content is equivalent to no fields. A single empty field may be represented by content containing a single Constants.FIELD_MU delimiter.

Returns

The next field, or null if there is no more content available.

IRecord PushTechnology.ClientInterface.Client.Content.Metadata.IRecordContentReader.NextRecord

(

)

Returns a record of string data from the current content position.

This returns a record of string data read from the current content position to the next record delimiter within the buffer or the end of the content.

Fields (areas delimited by field delimiters) are unpacked from within the record area. If there are no field delimiters then the returned record will contain only one field.

HasMoreRecords may be called before calling this method to determine whether there are any records to read.

Empty content is equivalent to no records.

A single empty record in the content may be represented by a single Constants.RECORD_MU delimiter. This is the only way of distinguishing between a single empty record and no records.

A record containing a single empty field may be represented by a single Constants.FIELD_MU between record delimiters, before the first record delimiter or after the final record delimiter. This is the only way of distinguishing between an empty record and a record containing a single empty field.

After calling this method the content position will be moved beyond the record read.

Returns

The next record, or null if there is no more content available.

void PushTechnology.ClientInterface.Client.Content.Metadata.IRecordContentReader.Reset

(

)

Reset the reader so that it can be used to start reading the content again from the beginning.

---

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

• LegacyModule/Client/Content/Metadata/IRecordContentReader.cs