Skip to main content

ForceFolders

Function ForceFolders( const aFolder : string) : Boolean

Example​

procedure ScriptEvent(var Value: variant);
begin
  Value := ForceFolders('C:\Fictional\Work\Archive');
end;

Usage​

ForceFolders alias for ForceDirectories that creates every missing directory in a path.

Parameters

NameTypeDescription
aFolderstring, constAbsolute or relative directory path to ensure.

Returns

An empty string raises rather than returning False.

Behaviour

Behaviour is identical to ForceDirectories: existing directories succeed; missing parent directories are created recursively; failure can return False after leaving earlier created directories in place.

Important usage notes

  • The word “Folders” does not identify a different algorithm or a special Velox data location.
  • Empty input raises Velox RTL EInOutError.
  • Relative input uses the process current directory.
  • Creation is non-transactional and subject to access, naming, storage, race and reparse-point behaviour.
  • A successful return does not grant exclusive ownership or guarantee later access.

Usage notes

Prefer ForceDirectories in new scripts so the name matches the Velox API. Retain this alias for compatibility or established Velox terminology. Constrain the input to an approved root before invoking either name.

Additional Technical Info​

ForceFolders is a Velox naming alias for ForceDirectories. It creates every missing component of aFolder and returns whether the complete directory exists.

The example uses a fictional path. It is source-reviewed and was not executed by the documentation workflow. Calling the function can create multiple directories.

Implementation

uPSI_SysUtilsImport registers ForceFolders against SysUtilsImport.ForceFolders, whose complete implementation is Result := SysUtils.ForceDirectories(aFolder). It adds no Velox-specific checks, logging, retries, rollback or permissions.

Side effects

Zero or more directories can be created. Partial directory chains remain after later failure. No automatic rollback occurs.

Errors

The same Boolean failures and propagated exception cases as ForceDirectories apply.

Performance and concurrency

The alias adds only one wrapper call. Terminal cost is one existence query per level plus creation for each missing component, with no inter-process locking.

Related entries

External references

There is no separate Delphi or Free Pascal ForceFolders terminal in this path. The alias terminates in:

Created 2026-07-15