Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

IDSSExportEngineServer2 Interface Reference

Inherits IDSSExportEngineServer.

List of all members.

Public Member Functions

HRESULT ExportDocument3 ([in] IDSSDocumentInstance *pDI,[in] EnumDSSExportFormat nFormat,[in] BSTR PrefixString,[in, out] SAFEARRAY(unsigned char)*psaDocumentOutput)
 Export a document in the specified export format.
HRESULT ExportReport2 ([in] IDSSReportInstance *pRI,[in] EnumDSSExportFormat nFormat,[in] BSTR PrefixString,[out] SAFEARRAY(unsigned char)*psaGraphNames,[out] SAFEARRAY(unsigned char)*psaImageOutput,[in, out] SAFEARRAY(unsigned char)*psaReportOutput)
 Get the report in specified export format.
HRESULT ExportReport3 ([in] IDSSReportInstance *pRI,[in] EnumDSSExportFormat nFormat,[in] BSTR PrefixString,[in, out] SAFEARRAY(VARIANT)*psaAggregateOutput)
 Get the report in specified export format.


Member Function Documentation

HRESULT IDSSExportEngineServer2::ExportDocument3 [in] IDSSDocumentInstance pDI,
[in] EnumDSSExportFormat  nFormat,
[in] BSTR  PrefixString,
[in, out] SAFEARRAY(unsigned char)*  psaDocumentOutput
 

Export a document in the specified export format.

Parameters:
pDI Pointer to the document instance
nFormat The format to which the document is exported
PrefixString The prefix string that is attached to all image file names. This parameter is used only when the ExportFormat is DssExportFormatHtml
psaDocumentOutput Exported document in the specified export format
Returns:
Usual COM result code:
  • S_OK Operation succeeded.
  • E_FAIL Operation failed.

HRESULT IDSSExportEngineServer2::ExportReport2 [in] IDSSReportInstance pRI,
[in] EnumDSSExportFormat  nFormat,
[in] BSTR  PrefixString,
[out] SAFEARRAY(unsigned char)*  psaGraphNames,
[out] SAFEARRAY(unsigned char)*  psaImageOutput,
[in, out] SAFEARRAY(unsigned char)*  psaReportOutput
 

Get the report in specified export format.

If there are any graphs, the graph names are returned in a separate safearray and the graph binaries are returned in a different safearray. The user can parse through the returned array, to get the individual image names and image data.

Parameters:
pRI pointer to ReportInstance
nFormat The format to which the report is exported
PrefixString The prefix string that is attached to all image file names. This parameter contains a non-empty string only when the ExportFormat is DssExportFormatHtml
psaGraphNames Safearray containing file names of images referred in the HTML result. Applicable only to HTML export format
psaImageOutput Safearray containing JPEG files corresponding to images referred in the HTML result. Applicable only to HTML export format.
psaReportOutput Exported report in the specified export format
Returns:
Usual COM result code:
  • S_OK Operation succeeded.
  • E_FAIL Operation failed.

HRESULT IDSSExportEngineServer2::ExportReport3 [in] IDSSReportInstance pRI,
[in] EnumDSSExportFormat  nFormat,
[in] BSTR  PrefixString,
[in, out] SAFEARRAY(VARIANT)*  psaAggregateOutput
 

Get the report in specified export format.

All the output data are aggregated and returned in a single safearray. If there are any graphs, the graph names and the graph binaries are also returned in the same safearray. The user can parse through the returned array, to get the individual image names and image data.

Parameters:
pRI pointer to ReportInstance
nFormat The format to which the report is exported
PrefixString The prefix string that is attached to all image file names. This parameter contains a non-empty string only when the ExportFormat is DssExportFormatHtml
psaAggregateOutput Exported report in the specified export format, along with any graphs and graph names,
Returns:
Usual COM result code:
  • S_OK Operation succeeded.
  • E_FAIL Operation failed.


Copyright © 1996-2018 MicroStrategy Inc. All Rights Reserved.