finUtilities.DateCycleGetDescription Method - finPOWER Connect Business Layer

Member of finUtilities

Gets a friendly Description of a Date Cycle.

Syntax

finUtilities.DateCycleGetDescription(isFrequency, cycleMnemonic, [cycleMnemonicFriendly], [unknownDateCycle], [includeCycleDay])

Name	Type	Optional	ByRef	Description
isFrequency	Boolean			Indicates whether this Cycle is a Frequency.
cycleMnemonic	String			The cycle (Mnemonic text).
cycleMnemonicFriendly	String	Optional	ByRef	A friendly version of the passed in Cycle Mnemonic.
unknownDateCycle	Boolean	Optional	ByRef	Returns True if the supplied Cycle Mnemonic could not be recognised as a valid Date Cycle. If omitted, a value of False is assumed.
includeCycleDay	Boolean	Optional		Indicates whether to include the cycle day. If omitted, a value of True is assumed.

String

A String value.