maride/guacamole-spice-protocol
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

GUAC-1389: Document guac_telnet_compile_regex().

Browse Source
This commit is contained in:
Michael Jumper 2016-03-14 20:12:55 -07:00
parent 9253d877a2
commit 35746efca8
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/protocols/telnet/settings.c
View File

@ -125,6 +125,17 @@ enum TELNET_ARGS_IDX {
/** /**
* Compiles the given regular expression, returning NULL if compilation fails. * Compiles the given regular expression, returning NULL if compilation fails.
* The returned regex_t must be freed with regfree() AND free().
*
* @param user
* The user who provided the setting associated with the given regex
* pattern. Error messages will be logged on behalf of this user.
*
* @param pattern
* The regular expression pattern to compile.
*
* @return
* The compiled regular expression, or NULL if compilation fails.
*/ */
static regex_t* guac_telnet_compile_regex(guac_user* user, char* pattern) { static regex_t* guac_telnet_compile_regex(guac_user* user, char* pattern) {