DM_getItemFormat

This method returns the item format for a single mining field. The item format is returned in the form of the following integer constants:
  • 0: Format 'item field name = item value', ignoring NULL, '-' and empty strings.
  • 1: Format 'item value', ignoring NULL, '-' and empty strings.
  • 2: Format 'item field name'.
  • 10: Format 'item field name = item value', not ignoring NULL, '-' and empty strings.
  • 101: Multi-value format. Expects an XML input string of the form <item>X1</item><item>X2</item>...<item>Xn</item>, where X1, X2, ... , Xn are arbitrary different item values

Syntax

Method syntax

Read syntax diagramSkip visual syntax diagram
>>-settings..DM_getItemFormat--(--fldName--)-------------------><

Function syntax

Read syntax diagramSkip visual syntax diagram
>>-DM_getItemFormat--(--settings--,--fldName--)----------------><

Parameters

settings
A value of type DM_MiningSettings
fldName
A value of type VARCHAR(128)

Return Value

The return value is of type INTEGER



Feedback | Information roadmap