SpeciesObservationManagerCreateFileByFileOrderSettings Method |
Creates a file using file order settings.
No file order is created, the file is returned directly.
Namespace: ArtDatabanken.DataAssembly: ArtDatabanken.Data (in ArtDatabanken.Data.dll) Version: 1.3.0.0 (1.3.0.0)
Syntax public byte[] CreateFileByFileOrderSettings(
IUserContext userContext,
FileOrderTypeId fileOrderType,
FileOrderFileTypeId fileType,
IFileOrderSettings fileOrderSettings
)
Public Function CreateFileByFileOrderSettings (
userContext As IUserContext,
fileOrderType As FileOrderTypeId,
fileType As FileOrderFileTypeId,
fileOrderSettings As IFileOrderSettings
) As Byte()
public:
virtual array<unsigned char>^ CreateFileByFileOrderSettings(
IUserContext^ userContext,
FileOrderTypeId fileOrderType,
FileOrderFileTypeId fileType,
IFileOrderSettings^ fileOrderSettings
) sealed
abstract CreateFileByFileOrderSettings :
userContext : IUserContext *
fileOrderType : FileOrderTypeId *
fileType : FileOrderFileTypeId *
fileOrderSettings : IFileOrderSettings -> byte[]
override CreateFileByFileOrderSettings :
userContext : IUserContext *
fileOrderType : FileOrderTypeId *
fileType : FileOrderFileTypeId *
fileOrderSettings : IFileOrderSettings -> byte[]
Parameters
- userContext
- Type: ArtDatabanken.DataIUserContext
The user context. - fileOrderType
- Type: ArtDatabanken.DataFileOrderTypeId
File order type. Valid values are those found in the enum FileOrderTypeId.
E.g. SpeciesObservations.
- fileType
- Type: ArtDatabanken.DataFileOrderFileTypeId
File type. Valid values are those found in the enum FileOrderFileTypeId.
E.g. ExcelXlsx, GeoJson, EsriShape.
- fileOrderSettings
- Type: ArtDatabanken.DataIFileOrderSettings
The file order settings. Search parameters etc.
Return Value
Type:
Byte
The file format returned is the following:
(FileOrderTypeId.SpeciesObservations, FileOrderFileTypeId.ExcelXlsx) => Xlsx file is returned
(FileOrderTypeId.SpeciesObservations, FileOrderFileTypeId.GeoJson) => GeoJson file is returned as zip-file
(FileOrderTypeId.SpeciesObservations, FileOrderFileTypeId.EsriShape) => Shape file is returned as zip-file
Implements
ISpeciesObservationManagerCreateFileByFileOrderSettings(IUserContext, FileOrderTypeId, FileOrderFileTypeId, IFileOrderSettings)Remarks
The following combinations of (fileOrderType, fileType) are implemented (2018-02-20):
(FileOrderTypeId.SpeciesObservations, FileOrderFileTypeId.ExcelXlsx)
(FileOrderTypeId.SpeciesObservations, FileOrderFileTypeId.GeoJson)
(FileOrderTypeId.SpeciesObservations, FileOrderFileTypeId.EsriShape)
See Also