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

Inherits: Progress.Lang.Object
Implements: Consultingwerk.Framework.Server.FileDownload.IDownloadFileService


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



Top Method Summary
Options Name Purpose
AssertRelativeFileName (character) Validates that the requested file name is a valid relative path
dispose () Disposes the service instance
MEMPTR GetFileContent (character) Returns the content of the file to be downloaded as a MEMPTR
INT64 GetMaxDownloadSize (IConfigurationProvider) Returns the configured maximum download size in bytes
initialize () Initializes the service instance

Top Property Summary
Options Name Purpose
CHARACTER FoldersConfigPrefix
CHARACTER MaxSizeConfigName


Method Detail
Top

AssertRelativeFileName (character)
Purpose: Validates that the requested file name is a valid relative path
Notes: Absolute paths (leading / or \), Windows drive letters (X:) and
path traversal (a ".." segment) are rejected with an
IllegalDownloadFilePathException (IHttp400Error)

Parameters:
pcFileName CHARACTER
The file name to validate
Top

dispose ()
Purpose: Disposes the service instance
Notes:

Top

MEMPTR GetFileContent (character)
Purpose: Returns the content of the file to be downloaded as a MEMPTR
Notes: The caller takes ownership of the returned MEMPTR and is
responsible for releasing it (set-size (...) = 0).

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

INT64 GetMaxDownloadSize (IConfigurationProvider)
Purpose: Returns the configured maximum download size in bytes
Notes: Returns 0 (no limit) when the DownloadFile -> MaxSize setting is
not configured

Parameters:
poConfig Consultingwerk.Framework.IConfigurationProvider
The IConfigurationProvider to read the setting from
Returns INT64
The maximum download size in bytes or 0 when unlimited
Top

initialize ()
Purpose: Initializes the service instance
Notes:



Property Detail
Top

CHARACTER FoldersConfigPrefix

Returns CHARACTER
Top

CHARACTER MaxSizeConfigName

Returns CHARACTER


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