Brook Tardigrade

Packed Record TBrookHTTPUpload

Description
Hierarchy
Fields
Methods
Properties

Unit

BrookHTTPUploads

Declaration

type TBrookHTTPUpload = packed record

Description

Structured type which holds the upload properties and allows to save the uploaded file.

Overview

Methods

Public constructor Create(AHandle: Pointer);
Public function Save(AOverwritten: Boolean; out AError: string): Boolean; overload;
Public function Save(out AError: string): Boolean; overload;
Public procedure Save(AOverwritten: Boolean); overload;
Public procedure Save; overload;
Public function SaveAs(const APath: TFileName; AOverwritten: Boolean; out AError: string): Boolean; overload;
Public function SaveAs(const APath: TFileName; out AError: string): Boolean; overload;
Public procedure SaveAs(const APath: TFileName; AOverwritten: Boolean); overload;
Public procedure SaveAs(const APath: TFileName); overload;

Properties

Public property Handle: Pointer read GetHandle;
Public property StreamHandle: Pointer read FStreamHandle;
Public property Directory: string read FDirectory;
Public property Field: string read FField;
Public property Name: string read FName;
Public property Mime: string read FMime;
Public property Encoding: string read FEncoding;
Public property Size: UInt64 read FSize;

Description

Methods

Public constructor Create(AHandle: Pointer);

Creates an instance of TBrookHTTPUpload.

Parameters
AHandle[in]
Upload handle.
Public function Save(AOverwritten: Boolean; out AError: string): Boolean; overload;

Saves the uploaded file defining the destination path by upload name and directory.

Parameters
AOverwritten[in]
Overwrite upload file if it exists.
AError[out]
Variable reference to store string describing the error if save fails.
Returns

True if the uploaded file is saved successfully.

Public function Save(out AError: string): Boolean; overload;

Saves the uploaded file defining the destination path by upload name and directory.

Parameters
AError[out]
Variable reference to store string describing the error if save fails.
Returns

True if the uploaded file is saved successfully.

Public procedure Save(AOverwritten: Boolean); overload;

Saves the uploaded file defining the destination path by upload name and directory.

Parameters
AOverwritten[in]
Overwrite upload file if it exists.
Public procedure Save; overload;

Saves the uploaded file defining the destination path by upload name and directory.

Public function SaveAs(const APath: TFileName; AOverwritten: Boolean; out AError: string): Boolean; overload;

Saves the uploaded file allowing to define the destination path.

Parameters
APath[in]
Absolute destination path.
AOverwritten[in]
Overwrite upload file if it exists.
AError[out]
Variable reference to store string describing the error if save fails.
Returns

True if the uploaded file is saved successfully.

Public function SaveAs(const APath: TFileName; out AError: string): Boolean; overload;

Saves the uploaded file allowing to define the destination path.

Parameters
APath[in]
Absolute destination path.
AError[out]
Variable reference to store string describing the error if save fails.
Returns

True if the uploaded file is saved successfully.

Public procedure SaveAs(const APath: TFileName; AOverwritten: Boolean); overload;

Saves the uploaded file allowing to define the destination path.

Parameters
APath[in]
Absolute destination path.
AOverwritten[in]
Overwrite upload file if it exists.
Public procedure SaveAs(const APath: TFileName); overload;

Saves the uploaded file allowing to define the destination path.

Parameters
APath[in]
Absolute destination path.

Properties

Public property Handle: Pointer read GetHandle;

Handle of an upload.

Public property StreamHandle: Pointer read FStreamHandle;

Stream handle of the upload.

Public property Directory: string read FDirectory;

Directory of the uploaded file.

Public property Field: string read FField;

Field name of the upload.

Public property Name: string read FName;

Name of the uploaded file.

Public property Mime: string read FMime;

MIME (content-type) of the upload.

Public property Encoding: string read FEncoding;

Encoding (transfer-encoding) of the upload.

Public property Size: UInt64 read FSize;

Size of the upload.

Generated by PasDoc 0.16.0.