SetReportInfo Method (reportObjectRefId, info, zone)

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

Assign a ReportInfo instance to the stream.

Declaration Syntax

Visual Basic

Visual C++

void SetReportInfo(
	string reportObjectRefId,
	ReportInfo info,
	IZone zone
)

Sub SetReportInfo ( _
	reportObjectRefId As String, _
	info As ReportInfo, _
	zone As IZone _
)

void SetReportInfo (
	String^ reportObjectRefId, 
	ReportInfo^ info, 
	IZone^ zone
)

Parameters

reportObjectRefId (String): The RefId of the SIF_ReportObject being streamed. The agent is responsible for assigning a RefId to the SIF_ReportObject and using the same RefId to identify all SIF_ReportObject instances that comprise the report data.
info (ReportInfo): A ReportInfo instance from the Edustructures.SifWorks.Reporting package
zone (IZone): The zone that is responding to the SIF_Request for SIF_ReportObjects

Remarks

The ReportInfo object identifies the report manifest to which the SIF_ReportObject relates, as well as information about this particular submission. The requesting agent uses this information to associate the report data with a report manifest. The ReportInfo will be included in each SIF_ReportObject packet sent with the response.

This method must be called before writing any SIFDataObject data to the stream via the Write method. Once called, it must not be called again for the duration of the message processing or an InvalidOperationException is thrown.

Exceptions

Exception	Condition
InvalidOperationException	thrown if this method is called more than once

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