Namespace: Consultingwerk.Framework.Server.FileDownload
Class 
DownloadFileBusinessTask Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.BusinessTask
Consultingwerk.Framework.Server.FileDownload.DownloadFileBusinessTask

Inherits: Consultingwerk.OERA.BusinessTask
Implements: Consultingwerk.OERA.IBusinessService, Consultingwerk.OERA.RestResource.ISupportsRestMethods


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
CHARACTER BaseFileName (character) Returns the base (last segment) of a relative file name
Consultingwerk.OERA.RestResource.RestMethodResponse DownloadFile (CharacterHolder) Returns the content of the specified file as a binary download response - intended for Web / REST callers
GetFileContent (dataset, CharacterHolder) Returns the content of the specified file via the output dataset - intended for Desktop / AppServer callers
MEMPTR GetServiceFileContent (character) Retrieves the content of the file from the IDownloadFileService


Method Detail
Top

CHARACTER BaseFileName (character)
Purpose: Returns the base (last segment) of a relative file name
Notes: Used for the Content-Disposition file name so the browser does
not include sub folders in the downloaded file name

Parameters:
pcFileName CHARACTER
The relative file name
Returns CHARACTER
The base file name
Top

Consultingwerk.OERA.RestResource.RestMethodResponse DownloadFile (CharacterHolder)
Purpose: Returns the content of the specified file as a binary download
response - intended for Web / REST callers
Notes: The response is sent as application/octet-stream with a
Content-Disposition header so the browser downloads the file
under its (base) file name

Parameters:
poFileName Consultingwerk.CharacterHolder
The relative name of the file to download
Returns Consultingwerk.OERA.RestResource.RestMethodResponse
A RestMethodResponse carrying the binary file content
Top

GetFileContent (dataset, CharacterHolder)
Purpose: Returns the content of the specified file via the output
dataset - intended for Desktop / AppServer callers
Notes: Callers pass the dsFileDownload dataset by handle via
InvokeTask and read ttFileDownload from it after the call
the file name and BLOB content

Parameters:
dsFileDownload DATASET dsFileDownload
Output dataset containing ttFileDownload with
poFileName Consultingwerk.CharacterHolder
The relative name of the file to download
Top

MEMPTR GetServiceFileContent (character)
Purpose: Retrieves the content of the file from the IDownloadFileService
Notes: The IDownloadFileService is a mandatory service - a customer must
register an implementation against the interface. The returned
MEMPTR is owned by the caller of this method.

Parameters:
pcFileName CHARACTER
The relative name of the file to download
Returns MEMPTR
A MEMPTR holding the raw file content


ProDataset Detail

ProDataset dsFileDownload

Member tables: ttFileDownload


Temp-Table Detail

Temp-Table ttFileDownload

Defined in:


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       01.06.2026 09:10:21