---
name: "HTMLDocument.encodeControlState"
section: "3kaya"
platform: "linux"
package: "kaya"
version: "0.4.4-6.2"
release: "Debian 8 (Jessie)"
platforms: ["linux"]
url: "https://new.carta.tech/HTMLDocument.encodeControlState"
---

# HTMLDocument.encodeControlState(3kaya)

Encode application state for later retrieval

## NAME

HTMLDocument::encodeControlState - Encode application state for later retrieval

## SYNOPSIS

**String encodeControlState(** *b(a) fn, a state, String prefix=""* **)**

## ARGUMENTS

**fn** The function to call

**state** The state to pass

**prefix** An optional prefix to the control variables. Different components may use different prefixes, allowing multiple **Webapp.runHandler (3kaya)** functions. In this context it performs the same role as the marshalling ID - if you are calling this function directly you almost certainly don't need it.

## DESCRIPTION

Encode an application state into a string. This is useful with **Webapp.storeFunction (3kaya)** for constructing shorter URLs, or allowing someone to resume a process at a much later date.

## 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

**Webapp.storeFunction (3kaya)**