C_SaveSpreadsheet

Call C_SaveSpreadsheet to save a spreadsheet containing one of the output types listed below for the SpreadsheetType parameter.

Parameters

ObjectHandle (IN)

The handle of the object.

• For spreadsheet type of sptWaveSearch, sptLineTypesPropertiesReport, sptCodeChecksReport and sptReferencesReport this must the handle of the model.
• For spreadsheet type of sptConnectionsReport this must be the handle of the object for which output is desired, or the handle of the model.
• For spreadsheet type of sptDiffractionResults, sptDiffractionMeshDetails and sptDiffractionWaveComponents this must be the handle of the diffraction object.
• For spreadsheet type of sptAddedMassDampingData this must be the handle of a vessel type or a multibody group. In the case of a vessel type, the reported data is for the selected draught.
• Otherwise it must be the handle of the object for which output is desired, e.g. line, vessel, link etc.

SpreadsheetType (IN)

Identifies the type of spreadsheet to be saved. This can be one of the following constants defined in OrcFxAPI.h:

• sptSummaryResults
• sptFullResults
• sptWaveSearch
• sptVesselDisplacementRAOs
• sptVesselSpectralResponse
• sptLineClashingReport
• sptDetailedProperties
• sptLineTypesPropertiesReport
• sptCodeChecksReport
• sptSupportGeometryTable
• sptAirGapReport
• sptDiffractionResults
• sptDiffractionMeshDetails
• sptDiffractionWaveComponents
• sptAddedMassDampingData
• sptConnectionsReport
• sptReferencesReport

lpParameters (IN)

Depending on the spreadsheet type this parameter should be:

• A pointer to a TLineClashingReportParameters structure if SpreadsheetType is sptLineClashingReport.
• A pointer to a TAirGapReportParameters structure if SpreadsheetType is sptAirGapReport.
• NULL otherwise.

lpFileName (IN)

Points to a null-terminated string containing the name of the file to be saved. The file can be an Excel spreadsheet (.xlsx or .xls), a tab delimited file (.txt) or a comma separated file (.csv). The decision is taken based on the file extension that you specify.

lpStatus (OUT)

Points to a variable in which the status result for the function call will be returned.

Unicode and ANSI

The Unicode function name is C_SaveSpreadsheetW and the ANSI function name is C_SaveSpreadsheetA.

See also

C_SaveSpreadsheetMem.