Difference between revisions of "LlDeleteKeyValue"
Jump to navigation
Jump to search
Quartz Mole (talk | contribs) m (fixed broken lsl formatting) |
m |
||
| Line 4: | Line 4: | ||
|func=llDeleteKeyValue | |func=llDeleteKeyValue | ||
|func_desc=Start an asynchronous transaction to delete a key-value pair associated with the given experience key with the given key. | |func_desc=Start an asynchronous transaction to delete a key-value pair associated with the given experience key with the given key. | ||
|func_footnote | |func_footnote=If the key does not exist the [[dataserver]] will return a failure along with the error [[XP_ERROR_STORAGE_EXCEPTION]]. | ||
|return_type=key|return_subtype=handle | |return_type=key|return_subtype=handle | ||
|return_text=that can be used to identify the corresponding [[dataserver]] event to determine if this command succeeded or failed and the results. | |return_text=that can be used to identify the corresponding [[dataserver]] event to determine if this command succeeded or failed and the results. | ||
Revision as of 18:17, 25 March 2015
| LSL Portal | Functions | Events | Types | Operators | Constants | Flow Control | Script Library | Categorized Library | Tutorials |
Summary
Function: key llDeleteKeyValue( string k );
Start an asynchronous transaction to delete a key-value pair associated with the given experience key with the given key.
Returns a handle (a key) that can be used to identify the corresponding dataserver event to determine if this command succeeded or failed and the results.
| • string | k | – | The key for the key-value pairThe key for the key-value pair |
If the key does not exist the dataserver will return a failure along with the error XP_ERROR_STORAGE_EXCEPTION.
Specification
Dataserver
The dataserver callback parameters are:
- A key containing the handle returned from llDeleteKeyValue
- A string containing a comma-delimited list (cdl).
llDumpList2String([ integer success ] + components);- components vary depending upon success or failure of request.
- Failure:
cdl = llDumpList2String([ 0, integer error],",") - Success:
cdl = llDumpList2String([ 1, string value ],",")
String Components
| • integer | success | – | A boolean specifying if the transaction succeeded (1) or not (0). | |
| • integer | error | – | An XP_ERROR_* flag that describes why the operation failed. | |
| • string | value | – | The value for the key-value pair. Maximum 2047 characters, or 4095 if using Mono. Note! This value may contain commas. |
Caveats
Examples
key trans;
default
{
state_entry()
{
trans = llDeleteKeyValue("FOO");
}
dataserver(key t, string value)
{
if (t == trans)
{
// our llDeleteKeyValue transaction is done
list result = llCSV2List(value);
if (llList2Integer(result, 0) == 1)
{
// the key-value pair was successfully deleted
llSay(0, "New key-value pair was deleted");
}
else
{
// the key-value pair was not deleted
llSay(0, "Key-value failed to delete: " + llList2String(result, 1) );
}
}
}
}