GetShipmentManifestTypeNum
Function GetShipmentManifestTypeNum(const aShipmentTypeCode : string) : Variant;
Example
procedure ScriptEvent(var Value: variant);
begin
Value := GetShipmentManifestTypeNum('CustomerShipment'); // 1
end;
Usage
GetShipmentManifestTypeNum converts a Velox shipment-manifest type code to its canonical number.
Parameters and result
| Item | Type | Description |
|---|---|---|
aShipmentTypeCode | string, const | shipment-manifest type code; matching is case-insensitive but otherwise exact. |
| Result | Variant | Mapped integer for a recognized value; otherwise Null. |
Complete mapping
| Number | Code |
|---|---|
1 | CustomerShipment |
2 | SupplierShipment |
Behaviour and edge cases
- Matching is ordinal and case-insensitive for these ASCII codes, but the entire string must match.
- The function does not trim. Whitespace, punctuation changes, empty input and unknown text return
Null. - Numeric text is not parsed. Test
VarIsNullbefore assigning to a non-nullable numeric target. - Reused labels or numbers in another Velox status/type family are not semantically interchangeable. Use the function matching the field.
Additional Technical Info
GetShipmentManifestTypeNum converts a shipment-manifest type code to its corresponding Velox number. The complete map is compiled into product source and is not read from customer configuration.
Implementation
The source compares the input with each literal through installed Delphi SameText, in table order. A recognized branch returns its fixed counterpart; the fallback returns Null. No database or alias configuration is consulted.
Side effects, errors and performance
For supported input the function is pure, does no I/O and runs over a small fixed mapping. Ordinary unknown string input returns Null.
Related entries
GetShipmentManifestTypeCodeperforms the reverse conversion.- Embarcadero:
System.SysUtils.SameText - Free Pascal:
SameText