IFsrmReportJob::Formats property

Retrieves or sets an array of formats that determine the content format of the reports.

This property is read/write.

Syntax


HRESULT put_Formats(
  [in]   SAFEARRAY(VARIANT) formats
);

HRESULT get_Formats(
  [out]  SAFEARRAY(VARIANT) formats
);

Property value

An array of report formats to generate. Each element of the SAFEARRAY is a VARIANT of type VT_I4. Set the lVal member of the variant to the report format. For possible values, see the FsrmReportFormat enumeration.

Error codes

The method returns the following return values.

NameMeaning
S_OK

Success

E_INVALIDARG

Returned for the following reasons:

  • The format array is empty.
  • One or more of the variants are of the wrong type.
  • One or more of the format values are not valid.

Remarks

Each report in the job is generated in each of the specified formats.

The file name extension is based on the format. The extension for DHTML is ".html", the extension for HTML is ".htm", the extension for TXT is ".txt", the extension for CSV is ".csv", and the extension for XML is ".xml".

If the report type is FsrmReportType_ExportReport, you can specify only the FsrmReportFormat_Csv and FsrmReportFormat_Xml formats. The report is not run if one or both of these formats are not specified. Other formats are ignored.

Examples

For an example, see Defining a Report Job.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008

Header

FsrmReports.h

DLL

SrmSvc.dll

IID

IID_IFsrmReportJob is defined as 38e87280-715c-4c7d-a280-ea1651a19fef

See also

IFsrmReportJob

 

 

Show:
© 2014 Microsoft. All rights reserved.