PageRenderTime 21ms CodeModel.GetById 18ms app.highlight 1ms RepoModel.GetById 1ms app.codeStats 0ms

/man/redisLIndex.Rd

http://github.com/bwlewis/rredis
Unknown | 39 lines | 39 code | 0 blank | 0 comment | 0 complexity | 8c6d52a43026dca8aa7875e6123f59a3 MD5 | raw file
 1\name{redisLIndex}
 2\alias{redisLIndex}
 3\title{Retrieve a value from a Redis 'list.'}
 4\description{
 5Retrieve a value from a Redis 'list' at the specified index without 
 6removing it from the list.
 7}
 8\usage{
 9redisLIndex(key, index, ...)
10}
11\arguments{
12  \item{key}{The key (whose value is of the type 'list').}
13  \item{index}{The list index to retrieve.}
14  \item{...}{ Optional additional arguments.  Specify \code{raw=TRUE} to skip de-serialization of the data.}
15}
16\details{
17List indices begin at 0.
18Negative indexes are supported, for example -1 is the last element, 
19-2 the penultimate and so on.
20If the value stored at key is not of the 'list' type an error is returned. 
21If the index is out of range an empty string is returned.
22}
23\value{
24The corresponding value or an empty string if the index is out of bounds.
25}
26\references{
27http://redis.io/commands
28}
29\author{
30B. W. Lewis
31}
32\seealso{
33\code{\link{redisLPop}}
34}
35\examples{
36\dontrun{
37redisConnect()
38}
39}