RetrieveKey - Develop Apps | Community Toolbar

Conduit API

Case Study

HTML Apps -> RetrieveKey

This function is used to retrieve the value of the stored key on the client's PC.

RetrieveKey(key)

Parameter	Description	Range	Type
key	The name of the key to retrieve.	not null or empty string	string

- Return Value

null

- Remarks

This function can be used both with the HTML component and with the gadget window.
*Notice: API methods must be invoked after the web page has triggered the "onload" event.

- Code Example

HTML | Gadget

This example contains an icon RetrieveKey

that when clicked, will attempt to retrieve the value associated with the key represented by the string "ID".

<html>
<head>
<style type= "text/css">
BODY
{
margin-left:0;
margin-right:0;
margin-top:0;
margin-bottom:0;
width:100%;
height:100%;
overflow:hidden;
background-color:threedface;
}
</style>
<!-- Conduit API script declaration -->
<script type="text/javascript" language="javascript" src="http://api.conduit.com/BrowserCompApi.js"></script>
<script language="javascript" type="text/javascript">
    function Retrive() {
        var value = "";
        value = RetrieveKey("ID");
        if (value != "") {
            alert("Id = ID, Value = " + value);
        }
        else {
            alert("No key with the id: ID is stroed in your PC");
        }
    }
</script>
</head>
<body>
<img alt="RetriveKey" style="vertical-align:bottom" src="http://www.conduit.com/developers/api/Images/Toolbars/HTML/RetrieveKey.gif" onclick="Retrive()" />
</body>
</html>

<html>
<head>
<style type= "text/css">
BODY
{
margin-left:0;
margin-right:0;
margin-top:0;
margin-bottom:0;
width:100%;
height:100%;
overflow:hidden;
background-color:threedface;
}
</style>
<!-- Conduit API script declaration -->
<script type="text/javascript" language="javascript" src="http://api.conduit.com/BrowserCompApi.js"></script>
<script language="javascript" type="text/javascript">
    function Retrive() {
        var id = document.getElementById('txtId').value;
        var value = "";
        value = RetrieveKey(id);
        if (value != "") {
            alert("Id = " + id + " Value = " + value);
        }
        else {
            alert("No key with the id: " + id + " is stroed in your PC");
        }
    }
</script>
</head>
<body>
<div>Id:<input type="text" id="txtId" /></div>
<input type="button" onclick="Retrive()" value="Retrive key" />
</body>
</html>

- Code Usage

See code usage for HTML component
See code usage for gadget