DeleteKey - Develop Apps | Community Toolbar

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

DeleteKey(key)

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

None.

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.

HTML | Gadget

This example contains an icon DeleteKey

that when clicked, will attempts to retrieve a key represented by the string "ID". If the key exists, the key, together with its value, will be deleted.

<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 Delete() {
        var value = "";
        value = RetrieveKey("ID");
        if (value != "") {
            DeleteKey("ID");
            alert("The key with the Id = ID was successfully deleted");
        }
        else {
            alert("Key not found!");
        }
    }
</script>
</head>
<body>
<img alt="DeleteKey" style="vertical-align:bottom" src="http://www.conduit.com/developers/api/Images/Toolbars/HTML/DeleteKey.gif" onclick="Delete();" />
</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 Delete() {
        var id = document.getElementById('txtId').value;
        var value = "";
        value = RetrieveKey(id);
        if (value != "") {
            DeleteKey(id);
            alert("The key with the Id = " + id + " was successfully deleted");
        }
        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="Delete()" value="Delete key" />
</body>
</html>

See code usage for HTML component
See code usage for gadget