EnumCurrencies

Returns arrays containing the IDs, labels, and descriptions of the application’s currencies, with the option to return only those currencies for which the DisplayInICT attribute is enabled. The arrays have a one-to-one correspondence.

Tip:	You determine which arrays are returned with the lFlagsRequestedInfo argument.

Syntax

<HFMwCurrencies>.EnumCurrencies (vbICTOnly, lFlagsRequestedInfo, pvaravarlCurrencyIDs, pvaravarbstrCurrencyLabels, pvaravarbstrCurrencyDescriptions)

Argument	Description
vbICTOnly	A flag that specifies whether to filter currencies for which the DisplayInICT attribute is enabled. Pass TRUE to filter currencies, FALSE to return all currencies. Input argument. Boolean subtype.
lFlagsRequestedInfo	A bitmask that specifies the type of information to return. Valid values for the bits are represented by the HFMConstants type library constants listed in Metadata Information Constants. Input argument. Long subtype.
pvaravarlCurrencyIDs	If WEBOM_METADATA_INFO_ID or WEBOM_METADATA_INFO_ALL is included in the lFlagsRequestedInfo argument’s bitmask, this returns an array containing the currencies’ IDs. Input/output argument.
pvaravarbstrCurrencyLabels	If WEBOM_METADATA_INFO_LABEL or WEBOM_METADATA_INFO_ALL is included in the lFlagsRequestedInfo argument’s bitmask, this returns an array containing the currencies’ labels. Input/output argument.
pvaravarbstrCurrencyDescriptions	If WEBOM_METADATA_INFO_DESCRIPTION or WEBOM_METADATA_INFO_ALL is included in the lFlagsRequestedInfo argument’s bitmask, this returns an array containing the currencies’ descriptions. Input/output argument.

Return Value

Returns a count of the currencies that are returned by this method.

Example

The following function returns the labels of all the currencies in an application.

Function getCurrencyLabels()
Dim cMetadata, cCurrencies, lCnt, vaIDs, vaLabels, vaDescs
'g_cSession is an HFMwSession object reference
Set cMetadata = g_cSession.metadata
Set cCurrencies = cMetadata.currencies
cCurrencies.EnumCurrencies true, WEBOM_METADATA_INFO_LABEL, vaIDs, _
  vaLabels, vaDescs
getCurrencyLabels = vaLabels
End Function