Classes & functions

cs.fnd.Fnd_Pref

Fnd_Pref
 Created by: Wayne Stewart, Created: 2026-04-28
 ------------------
 DataClass extension for [Fnd_Pref].

 Provides a typed, thread-safe getter and setter for the preferences held in
 the data file. Replaces the pointer-based v4_FndPrefGetSharedValue reader and
 the classic-record v4_FndPrefSaveServerPreference writer.

 The Owner column is the namespace. Three conventions live in it: the string
 Fnd_Pref_SharedName for preferences everyone shares, a user name for the ones
 that follow a user between machines, and any other label the caller chooses.
 getNamed and setNamed take the owner; getShared and setShared are those two
 with Fnd_Pref_SharedName filled in.

 Numeric type matching: Is longint and Is real are treated as a single
 numeric bucket so that an integer-stored value and a real default (or vice
 versa) do not silently fall back to default. The classic reader
 Fnd_Pref_GetSharedValue matches the two types exactly, so it is stricter than
 this is; that difference is deliberate and stays.

Class extends DataClass

getShared · setShared · getNamed · setNamed · removeNamed · namesFor · owners

No function description is available in the source.

No function description is available in the source.

No function description is available in the source.

No function description is available in the source.

No function description is available in the source.

No function description is available in the source.

No function description is available in the source.

cs.fnd.Fnd_PrefEntity

Fnd_PrefEntity
 Created by: Wayne Stewart, Created: 2026-04-28
 ------------------
 Entity extension for the [Fnd_Pref] dataclass.

 Adds typed value access on top of the (Type, Value) column pair.
 Value is stored as text; Type records the original 4D type so it can
 be decoded on read. Supported types: Is text, Is longint, Is real,
 Is boolean, Is object.

Class extends Entity

typedValue · setTypedValue

No function description is available in the source.

No function description is available in the source.

cs.fnd.date

date
 Created by: Wayne Stewart (Claude Opus 5) (2026-08-14)
 ------------------
The Fnd_Date module as a class, so a host can reach it through the class store
instead of the method names.

 In a host:         cs.fnd.date.new().toISO(Current date; Current time)
 Inside Foundation: cs.date.new().toISO(Current date; Current time)

The namespace is the "Component namespace in the class store" setting, which is
"fnd" here. It governs how the host sees these classes; inside the component
they are plain cs.<name>.

Design decisions and assumptions:
- Every function delegates to the Fnd_Date_ method of the same behaviour. The
  methods remain the implementation, so the class cannot drift from them and
  adds no behavioural risk.
- Stateless, so new() is cheap and instances are interchangeable. What little
  module state there is lives in Storage.Fnd.Date and Fnd.Date.
- Named for what they do rather than transcribing the method names, so
  Fnd_Date_DateAndTimeToISO becomes toISO and Fnd_Date_ISOtoDate becomes
  dateFromISO.
- Fnd_Date_Calendar and Fnd_Date_EntryFilter are not here. Both take a pointer
  to a form object and only mean anything inside a running form, which is not
  what a class store instance is for.

info · toISO · dateFromISO · timeFromISO · localTimestamp · fromParts · fromString · toString · endOfMonth · monthName · systemDateFormat · roundTime · roundTimeDown · roundTimeNear

The module's own labels — "name" and "version".

A date alone gives YYYY-MM-DD, a date and time the joined form. A null
  date with a time gives the time alone; a null date alone gives "".

Reads YYYY-MM-DD and YYYY-MM-DDThh:mm:ss alike. 4D's own Date() will not
  take the first of those, which is why this is not a wrapper over it.

Reads the time out of a stamp, including one carrying milliseconds or a
  zone suffix. The suffix is dropped rather than applied, so no silent
  conversion from UTC happens.

Local wall-clock time, YYYY-MM-DDThh:mm:ss.mmm, with no zone suffix.
  Comparable with other stamps from here, not with a UTC one.

Out of range parts roll over rather than being refused: month 13 is
  January of the next year, day 0 the last day of the previous month.

Unlike fromParts, this refuses a month above 12 or a day above 31, and
  gives the null date instead. Pass a format such as "D/M/Y" to read the
  string as something other than the machine's own setting.

"Today", "Tomorrow" or "Yesterday" where they apply, localized; the null
  date gives "". Everything else is formatted to the given format.

The last day of the month the date falls in.

Localized. Anything outside 1 to 12 gives "Error".

"M/D/Y" or "D/M/Y" and so on, for the machine this is running on.

No option, or 1, rounds to the nearest quarter hour; 2 rounds down.

Down to the quarter hour, however close the next one is.

The quarter is held for ten minutes past it before the next is reached,
  and the last five minutes of the day give 23:59 rather than midnight.

cs.fnd.fnd

Base Foundation Class - cs.fnd

info · getCurrentTable · setCurrentTable · getCurrentFormType · setComponentInfo · getComponentInfo · componentCheck

The component's own labels — "name" and "version". Anything else answers
  "Component Did Not Recognize Request".

The table this instance was told to work on, or Null if it was never set.

Records the table to work on, and returns it.

The form type this instance was told to work on. Fnd_Gen_NoForm when none.

Publishes one label for another component to read. The store lives on the
  Form object, so this only works while a form is loaded.

Reads back a label another component published. Empty when there is none,
  or when no form is loaded.

True when the required component answers. False alerts the developer first,
  and does not stop the caller — test the result and decide.

cs.fnd.log

log
 Created by WBS, 2026-09-12 (FND-26)
 Logging access for hosts: cs.fnd.log.new(). No shared singleton syntax.
 Delegates to methods; enabled/selection remain in the calling process.
 A future 21 singleton can use the same functions without sharing process state.

enable · config · declareLog · useLog · label · overrideLevel · addEntry · flush · closeLog · createTable · shutdown · extension · fileName · path · maximumSize · info

Read or set the current process enable flag.

Read or update application defaults; declared logs keep their settings.

Declare once; optional dedicated writer defaults to False.

Empty/omitted selects default; does not alter enable state.

Current process log label.

No arguments reads effective threshold. Optional True sets application scope.

Text or a collection of text columns, plus optional entry metadata.

Queue a flush; no completion acknowledgement.

Flush and close a label, or all logs when omitted.

Explicit only; interpreted host required. Inspect restartRequired.

Call after producers finish, outside a logger worker.

Omit to read; pass text to update through Fnd_Log_Extension.

Omit to read; pass text to update through Fnd_Log_FileName.

Omit to read; pass text to update through Fnd_Log_Path.

Get/set rollover size; zero disables rollover.

Existing module name/version/logging query API.

cs.fnd.out

No public function declarations in this class.

cs.fnd.pref

pref
 Created by: Wayne Stewart (Claude Opus 5) (2026-08-14)
 ------------------
The Fnd_Pref module as a class, so a host can reach it through the class store
instead of the method names.

 In a host:         cs.fnd.pref.new().getText("Report: Last Folder"; "")
 Inside Foundation: cs.pref.new().getText("Report: Last Folder"; "")

The namespace is the "Component namespace in the class store" setting, which is
"fnd" here. It governs how the host sees these classes; inside the component
they are plain cs.<name>.

Not to be confused with cs.Fnd_Pref, which is the DataClass extension for the
[Fnd_Pref] table and belongs to the host that owns the table. This one is the
module's API and belongs to the component.

Design decisions and assumptions:
- Every function delegates to the Fnd_Pref_ method of the same behaviour. The
  methods remain the implementation, so the class cannot drift from them and
  adds no behavioural risk.
- Stateless, so new() is cheap and instances are interchangeable. Module state
  lives in Storage.Fnd.Pref, shared by both routes.
- getWindow is the one place the shape changes rather than passing through. The
  method writes through four pointers, which is not something to publish on a
  modern API, so this returns {left; top; right; bottom} - or Null when nothing
  is stored, which the pointer form signals by leaving the caller's variables
  alone.
- The scope argument is a constant or a label, the same Variant the methods
  take. On a getter it only says where to store a default it has to create; on
  remove it says where to delete from. See the method headers.
- 4D 20 LTS has no singletons, so a host instantiates: cs.fnd.pref.new(). From
  21 a shared singleton would allow cs.fnd.pref.me, and the functions below
  would not change.

info · path · userName · save · getText · getBoolean · getLongInt · getReal · getObject · getWindow · setText · setBoolean · setLongInt · setReal · setObject · setWindow · remove

The module's own labels — "name" and "version".

Where the local preferences file is, or would be.

The name the server preferences are owned by. Setting it reloads.

Writes the local file and the user's server preferences. Called on quit.

The stored text, or the default. Passing a default stores it when the
  preference does not exist yet; the scope says where.

As getText, for a Boolean.

As getText, for an Integer.

As getText, for a Real.

As getText, for an Object.

No function description is available in the source.

Stores the value. The scope decides local or server; the default is the
  module's, see the method header.

As setText, for a Boolean.

As setText, for an Integer.

As setText, for a Real.

As setText, for an Object.

Pass {left; top; right; bottom}, or nothing for the frontmost window of
  the current process.

True if there was one to delete. The scope says where to delete from.

cs.fnd.pswd

pswd
 Created by: Wayne Stewart (Claude Opus 5) (2026-08-14)
 ------------------
The Fnd_Pswd module as a class, so a host can reach it through the class store
instead of the method names.

 In a host:         cs.fnd.pswd.new().generate({length: 16})
 Inside Foundation: cs.pswd.new().generate({length: 16})

The namespace is the "Component namespace in the class store" setting, which is
"fnd" here. It governs how the host sees these classes; inside the component
they are plain cs.<name>.

Design decisions and assumptions:
- Every function delegates to the Fnd_Pswd_ method of the same behaviour. The
  methods remain the implementation, so the class cannot drift from them and
  adds no behavioural risk.
- Stateless, so new() is cheap and instances are interchangeable. Module state
  lives in Storage.Fnd.Pswd, shared by both routes.
- generate() taking an options object is the one to reach for: it touches no
  shared state, so it is safe from a worker and from two processes at once.
  The setters below change the stored defaults and are not.
- 4D 20 LTS has no singletons, so a host instantiates: cs.fnd.pswd.new(). From
  21 a shared singleton would allow cs.fnd.pswd.me, and the functions below
  would not change.

info · generate · validCharacters · strength · dialog · useUppercase · useLowercase · useNumbers · useSymbols · customCharacters · excludeCharacters · minLength · maxLength

The module's own labels — "name" and "version".

Pass nothing for the stored settings, or an object to override them for
  this call only: {type; length; minLength; maxLength; useUppercase;
  useLowercase; useNumbers; useSymbols; customCharacters;
  excludedCharacters; requireEachClass}

The alphabet a generation would draw from, under the same options.

{ length ; poolSize ; bits ; rating }. Pass {type} when it is known, or a
  pronounceable password is weighed on its characters and overstated.

Shows the generator dialog. Returns "" if it was cancelled.

Reads the stored default, or sets it when passed a value.

Reads the stored default, or sets it when passed a value.

Reads the stored default, or sets it when passed a value.

Reads the stored default, or sets it when passed a value.

Setting characters turns the custom set on; setting none turns it off.

Matched exactly, so excluding "o" leaves "O" alone.

Carries the maximum up with it rather than leaving the pair inverted.

Carries the minimum down with it, the mirror of minLength.

cs.fnd.text

text
 Created by: Wayne Stewart (Claude Opus 5) (2026-08-13)
 WBS, 2026-09-12 - Expose existing whitespace trim through the class.
 ------------------
The Fnd_Text module as a class, so a host can reach it through the class store
instead of the method names.

 In a host:        cs.fnd.text.new().capitalize("hello world")
 Inside Foundation: cs.text.new().capitalize("hello world")

The namespace is the "Component namespace in the class store" setting, which is
"fnd" here. It governs how the host sees these classes; inside the component
they are plain cs.<name>.

Design decisions and assumptions:
- Every function delegates to the Fnd_Text_ method of the same behaviour. The
  methods remain the implementation, so the class cannot drift from them and
  adds no behavioural risk. The direction can invert later, one function at a
  time, without either API changing.
- Stateless, so new() is cheap and instances are interchangeable. Module state
  lives in Storage.Fnd.Text, shared by both routes.
- 4D 20 LTS has no singletons, so a host instantiates: cs.fnd.text.new(). From
  21 a shared singleton would allow cs.fnd.text.me, and the functions below
  would not change.
- Named for what they do rather than transcribing the method names, so
  Fnd_Text_TextToMD5 becomes toMD5 and Fnd_Text_Base64ToText becomes fromBase64.

info · capitalize · capitalizeExclude · padSpaces · stripSpaces · trim · wrap · equalStrings · formatNumber · toMD5 · md5Encoding · toBase64 · fromBase64 · encodeBase64 · decodeBase64

The module's own labels — "name" and "version".

Book title capitalisation. Option 4 skips the exclude word list.

Pass a collection to replace the exclude word list, or nothing to read it.

Pads with spaces, or truncates, to exactly $length_i characters.

1 leading, 2 trailing, 4 doubles, added together. Default is 1+2.

Trim both ends using Fnd_Text_Trim's whitespace set; preserve NBSP.

Wraps at the last space before the limit, joined by carriage returns.

Case and diacritic sensitive, unlike 4D's = operator.

Strips punctuation from the number, then applies the 4D number format.

Defaults to ISO-8859-1, which is what Foundation has always hashed.

Sets the charset every later toMD5 uses, or reads it when passed nothing.

Base64 on one line: BASE64 ENCODE does not wrap at 76 characters.

The reverse of toBase64.

Takes and returns a blob, rather than the pointer the method wants.

Takes and returns a blob, rather than the pointer the method wants.

cs.fnd.wnd

Class extends fnd // cs.fnd.wnd

title · type · position · closeBox · openWindow · openFormWindow · useSavedPosition · closeNow

No function description is available in the source.

No function description is available in the source.

No function description is available in the source.

No function description is available in the source.

No function description is available in the source.

No function description is available in the source.

No function description is available in the source.

$result_b:=Process_IsClosing