WebCommon.incomingValue(3kaya)
NAME
WebCommon::incomingValue - Returns the first value for the specified
key from user-supplied data
SYNOPSIS
String incomingValue( String key, DataSource ds )
ARGUMENTS
key The key to retrieve data for
ds The source for user-supplied data
DESCRIPTION
- Returns the first value for the key from the specified data source, or throws a WebCommon.NotIncoming (3kaya) Exception if no such key exists.
- // GET /example.cgi?a=1;b=3;b=5;z=;z;z
val = incomingData("a",DataGet);
// val = "1"
val = incomingData("b",DataGet);
// val = "3"
val = incomingData("c",DataGet);
// NotIncoming exception thrown
val = incomingData("z",DataGet);
// val = ""
This is generally easier to use than WebCommon.incomingData (3kaya) if only one value is expected for that key.
AUTHORS
Kaya standard library by Edwin Brady, Chris Morris and others
(kaya@kayalang.org). For further information see http://kayalang.org/
LICENSE
The Kaya standard library is free software; you can redistribute it
and/or modify it under the terms of the GNU Lesser General Public
License (version 2.1 or any later version) as published by the Free
Software Foundation.
RELATED
- WebCommon.DataSource (3kaya) WebCommon.incomingData (3kaya) WebCommon.incomingExists (3kaya) WebCommon.incomingKeys (3kaya)