Flummi/amxmodx
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fix vault.inc documentation (#550)

Browse Source 
* Fix vault.inc documentation

* Add missing *

* Fix typos
This commit is contained in:
HamletEagle 2018-09-08 00:42:17 -07:00 committed by Vincent Herbet
parent b4927bfb1f
commit 579a83c2a4
1 changed files with 35 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
plugins/include/vault.inc
View File

@ -16,16 +16,45 @@
#endif
#define _vault_included
/* Reads a data from given key.
* If len is set to zero then get_vaultdata
* returns value as an number. */
/**
* Reads data from a given key.
*
*
* @param key Key to get the value from
* @param data Buffer to copy the value to
* @param len Buffer size. If len is set to 0 then the function will
* return the value as a number
*
* @return If len is not 0 the function will return the number of characters written.
If len is 0 the function will return the numerical value associated with the key.
*/
native get_vaultdata(const key[], data[] = "", len = 0);
/* Sets a data under given key. */
/**
* Sets data for a given key.
*
* @param key Key to set the value for
* @param data Data to set for the given key
*
* @noreturn
*/
native set_vaultdata(const key[], const data[] = "");
/* Removes a key from vault.*/
/**
* Removes a key and its data from the vault.
*
* @param key Key to remove
*
* @noreturn
*/
native remove_vaultdata(const key[]);
/* Checks if a key exists in the vault.*/
/**
* Checks if a key exists in the vault.
*
* @param key Key to check
*
* @return 1 if an entry was found, 0 otherwise.
*/
native vaultdata_exists(const key[]);