FORENAME - Get forenames (Reports & Settings Report Generator function)

From Catalyst
Jump to: navigation, search

Syntax

$FORENAME{string, type, count, mode}

Description

Used to retrieve an individual's forename(s).

Parameters

string
A text parameter that can not be omitted.
The full name of the individual.
type
A text parameter that can be omitted.
Whether the subject is an individual or a business.
blank
Automatically detect from the presence of words like 'Ltd'.
I
Assume an individual.
O
Assume an organisation.
count
A numeric parameter that can be omitted (it defaults to "0").
The number of forenames that are required.
0
Get all forenames.
1-9
Get the count'th forename.
mode
A text parameter that can be omitted.
Return the initials for the forename(s).
I
Initials without a full stop (e.g. "A N" for "Mr Andrew Norman Other").
i
Initials with a full stop (e.g. "A.N." for "Mr Andrew Norman Other")

Returns

A text value. The forename(s) of an individual, or blank if an organisation.

See also

$SURNAME, $TITLE.