DecodeString: Difference between revisions

Revision as of 09:28, 25 January 2020

This function decodes an encoded string using the specified algorithm. The counterpart of this function is encodeString.

string decodeString ( string algorithm, string input, table options [, function callback ] )

algorithm: The algorithm to use.
input: The input to decode.
options: A table with options and other neccessary data for the algorithm, as detailed below.

callback: providing a callback will run this function asynchronously, the arguments to the callback are the same as the returned values below.

Returns the decoded string if successful, false otherwise. If a callback was provided, the decoded string is argument to the callback.

	Script Example Missing Function DecodeString needs a script example, help out by writing one.
	Before submitting check out Editing Guidelines Script Examples.

-- TODO

@@ Line 7: / Line 7: @@
 ==Syntax==
 <syntaxhighlight lang="lua">
-string decodeString ( string algorithm, string input, table options )
+string decodeString ( string algorithm, string input, table options [, function callback ] )
 </syntaxhighlight>
@@ Line 19: / Line 19: @@
 ** ''key'': A key to decode the input with.
+===Optional Arguments===
+{{New feature/item|3.0160|1.5.7|20394|
+*'''callback:''' providing a callback will run this function asynchronously, the arguments to the callback are the same as the returned values below.
+}}
 ===Returns===
-Returns the decoded string if successful, ''false'' otherwise.
+Returns the decoded string if successful, ''false'' otherwise. If a callback was provided, the decoded string is argument to the callback.
 ==Example==