DeleteGlobalKey - Develop Apps

Conduit API

Case Study

HTML Apps -> DeleteGlobalKey

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

DeleteGlobalKey(key)

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

- Return Value

None.

- Remarks

This function can be used both with the HTML component and with the gadget window.
Global key values can be stored and shared cross-domain amongst all HTML components and Gadgets within a given toolbar and its group members.
*Notice: API methods must be invoked after the web page has triggered the "onload" event.

- Code Example

HTML | Gadget

<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></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 = RetrieveGlobalKey("ID");
        if (value != "") {
            DeleteGlobalKey("ID");
            alert("The global key with the Id = ID was successfully deleted");
        }
        else {
            alert("Key not found!");
        }
    }
</script>
</head>
<body>
<img alt="DeleteGlobalKey" 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></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 = RetrieveGlobalKey(id);
        if (value != "") {
            DeleteGlobalKey(id);
            alert("The global key with the Id = " + id + " was successfully deleted");
        }
        else {
            alert("No global  key with the id: " + id + " is stored in your PC");
        }
    }
</script>
</head>
<body>
<div>Id:<input type="text" id="txtId" /></div>
<input type="button" onclick="Delete()" value="Delete Globalkey" />
</body>
</html>

- Code Usage

See code usage for HTML component
See code usage for gadget