MapLongToShort
Maps a given a long text value and returns the corresponding short text value.
Syntax
Function MapLongToShort(LongText As Variant, ShortText As Variant) As Boolean
Parameters
|
LongText |
Required [in]; Specifies the long text value that needs to be mapped. |
|
ShortText |
Required [out]; Returns the short text value. |
Return Values
Returns TRUE if the mapping was successful, otherwise FALSE. If the mapping succeeds, the ShortText parameter will hold the mapped short text value, otherwise the parameter will be empty.
Remarks
It searches for the long text value in the business document record-set and maps it to the corresponding short text value.
Error Data
|
Error Code |
Error message |
Reason |
|
E_BOF_POINTER |
"An invalid (NULL) pointer was passed to the function as a parameter" |
A null parameter was passed |
|
E_CE_NOTINITIALIZED |
"Combo Engine is not Initialized. Cannot use the Combo Engine." |
When the combo engine was created, the Initialize function failed |
|
E_CE_NOLISTENGINE |
"No valid ListEngine component exists with the Combo Engine" |
The combo engine does not have a ListEngine component associated with it. The combo engine may have failed to create a list engine component |
|
E_CE_NOREPOSITORY |
"No Repository associated with the Combo Engine" |
The combo engine does not have its repository component associated with it. The Application Repository Service has failed to retrieve the combo engine repository information |
In case of duplicate long text values, you can use the SetIndex method to perform the mapping.
See Also