LogEx Method for LCSession
This method adds a new extended entry to the log for this activity. The values supplied are a status code, such as you would supply to the Log method, plus various additional parameters that supply additional information about the particular error code being returned.
Defined In
LCSession Class
Syntax
lcSession. LogEx (status, int1,int2, int3, text1, text2, text3)
Parameters
| Parameter |
Description |
|---|---|
| status |
Long. Base HEI status code and also the return value from the function. This value will show up as the external code number in the session status. |
| int1 |
Long. Optional Extended parameters. See Usage. |
| int2 |
Long. Optional Extended parameters. See Usage. |
| int3 |
Long. Optional Extended parameters. See Usage. |
| text1 |
String. Optional Extended parameters. See Usage. |
| text2 |
String. Optional Extended parameters. See Usage. |
| text3 |
String. Optional Extended parameters. See Usage. |
Usage
This Log method logs an extended error or event with parameters; use Log for basic logs and LogText or LogTextEx for external logs. When logging an error, the activity status is set, placing the activity into an error state. The log text corresponding to the status code is added to any Log entry for this activity.
Each of the supported extended errors is described along with the extended intN and textN parameters used by that error. For instance, if you are logging the error code LCFAIL_INVALID_METADATA, you should supply the metadata name that was found to be invalid, in the text1 parameter.
| Value |
Description |
|---|---|
| LCFAIL_INVALID_METADATA |
Metadata (text1) |
| LCFAIL_TYPE_MISMATCH |
FieldName (text1), LCType (Int1), ConnectorType (Int2) |
| LCFAIL_DUPLICATE |
Metadata (text1) |
| LCFAIL_FIELD_COUNT_MISMATCH |
LCCount (int1), LinkCount (Int2) |
| LCFAIL_KEY_COUNT_MISMATCH |
LCCount (Int1), LinkCount (Int2) |
| LCFAIL_STAMPFIELD_TYPE |
FieldName (text1), LinkType (Int1) |
| LCFAIL_FIELD_TYPE |
FieldName (text1), ExpectedType (Int1), ActualType (Int2) |
| LCFAIL_MERGE_FIELD |
FieldName (text1) |
| LCFAIL_MISSING_PROPERTY |
PropertyToken (Int1) |
| LCFAIL_PROPERTY_CONFLICT |
PropertyToken (Int1), PropertyToken (Int2) |
| LCFAIL_INVALID_PROPERTY |
PropertyToken (Int1) |
| LCFAIL_PROPERTY_VALUE |
PropertyToken (Int1) |
| LCEVENT_CHARACTER_SET |
Character Set Descriptor (text1) |
The following status values are in the error package LCXPKG_EXFIELD. All of these take a single extended parameter, which is the field name, in Text1:
LCFAIL_OVERFLOW
LCFAIL_PRECISION_LOSS
LCFAIL_INVALID_INT
LCFAIL_INVALID_FLOAT
LCFAIL_INVALID_CURRENCY
LCFAIL_INVALID_NUMERIC
LCFAIL_INVALID_DATETIME
LCFAIL_INVALID_STREAM
LCFAIL_INVALID_FIELD
LCFAIL_INVALID_TYPE
LCFAIL_INVALID_KEY
LCFAIL_DUPLICATE_KEY
LCFAIL_INVALID_STAMPFIELD
LCFAIL_INVALID_FIELDNAME
LCFAIL_VIRTUAL_FIELD
LCFAIL_VIRTUAL_VALUE
LCFAIL_INVALID_ORDER