.\" This man page is automatically generated using
.\" kayadoc2man from the Kaya development tools and the -xmldocs compile 
.\" option. Editing it directly is not encouraged.
.\" It is under the same license as the source .k file that it was
.\" generated from.
.TH "WebCommon.incomingValue" "3kaya" "August 2014" "Kaya" "Kaya module reference"
.SH "NAME"
WebCommon::incomingValue \- Returns the first value for the specified key from user-supplied data
.SH "SYNOPSIS"
.B String incomingValue(
\fIString key, DataSource ds\fP
.B ")"
.SH "ARGUMENTS"
.PP
.B "key"
The key to retrieve data for
.PP
.B "ds"
The source for user-supplied data
.SH "DESCRIPTION"
.PP
Returns the first value for the key from the specified data source, or throws a
.B "WebCommon.NotIncoming"(3kaya)
Exception if no such key exists.
.IP "" -4
 // 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 = ""
.PP
This is generally easier to use than
.B "WebCommon.incomingData"(3kaya)
if only one value is expected for that key.
.SH "AUTHORS"
Kaya standard library by Edwin Brady, Chris Morris and others (kaya@kayalang.org). For further information see http://kayalang.org/
.SH 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.
.SH "RELATED"
.PD 0
.PP
.B "WebCommon.DataSource"(3kaya)
.PP
.B "WebCommon.incomingData"(3kaya)
.PP
.B "WebCommon.incomingExists"(3kaya)
.PP
.B "WebCommon.incomingKeys"(3kaya)
.PD 0.4v