Next: , Previous: , Up: Extension API Description   [Contents][Index]


16.4.8 Requesting Values

All of the functions that return values from gawk work in the same way. You pass in an awk_valtype_t value to indicate what kind of value you expect. If the actual value matches what you requested, the function returns true and fills in the awk_value_t result. Otherwise, the function returns false, and the val_type member indicates the type of the actual value. You may then print an error message or reissue the request for the actual value type, as appropriate. This behavior is summarized in Table 16.1.

Type of Actual Value
StringNumberArrayUndefined
StringStringStringFalseFalse
NumberNumber if can be converted, else falseNumberFalseFalse
TypeArrayFalseFalseArrayFalse
RequestedScalarScalarScalarFalseFalse
UndefinedStringNumberArrayUndefined
Value cookieFalseFalseFalseFalse

Table 16.1: API value types returned