X-Git-Url: http://git.silcnet.org/gitweb/?a=blobdiff_plain;f=lib%2Fsilcutil%2Fsilcutil.h;h=57c5b1db9434d3013ab603097fa1dfbafd241995;hb=413da0f8686910f5e627393157566ae729ca99c4;hp=05995416320e674ecb62a3671953bf72d147329c;hpb=bd14b1977e4208f67f1c1b338185ca9c7835d450;p=silc.git diff --git a/lib/silcutil/silcutil.h b/lib/silcutil/silcutil.h index 05995416..57c5b1db 100644 --- a/lib/silcutil/silcutil.h +++ b/lib/silcutil/silcutil.h @@ -63,14 +63,16 @@ int silc_check_line(char *buf); * * SYNOPSIS * - * char *silc_get_time(); + * const char *silc_get_time(SilcUInt32 timeval) * * DESCRIPTION * - * Returns current time as string. + * Returns time as string. If the the `timeval' is non-zero that + * value is returned as string. If it is zero the current time of the + * local machine is returned. * ***/ -char *silc_get_time(); +const char *silc_get_time(SilcUInt32 timeval); /****f* silcutil/SilcUtilAPI/silc_to_upper * @@ -391,7 +393,8 @@ char *silc_client_chumode_char(SilcUInt32 mode); * * DESCRIPTION * - * Creates fingerprint from data, usually used with SHA1 digests. + * Return a textual representation of the fingerprint in *data, the + * caller must free the returned string. * ***/ char *silc_fingerprint(const unsigned char *data, SilcUInt32 data_len); @@ -469,13 +472,28 @@ char *silc_get_input(const char *prompt, bool echo_off); * * DESCRIPTION * - * Return current time to struct timeval. - * - * This function is system dependant. + * Return current time to struct timeval. This function is system + * dependant. Returns 0 on success and -1 on error. * ***/ int silc_gettimeofday(struct timeval *p); +/****f* silcutil/SilcUtilAPI/silc_compare_timeval + * + * SYNOPSIS + * + * bool silc_compare_timeval(struct timeval *smaller, + * struct timeval *bigger) + * + * DESCRIPTION + * + * Compare two timeval structures and return TRUE if the first + * time value is smaller than the second time value. + * + ***/ +bool silc_compare_timeval(struct timeval *smaller, + struct timeval *bigger); + /****f* silcutil/SilcUtilAPI/silc_string_regexify * * SYNOPSIS @@ -533,7 +551,8 @@ int silc_string_match(const char *string1, const char *string2); * DESCRIPTION * * Returns the username of the user. If the global variable LOGNAME - * does not exists we will get the name from the passwd file. + * does not exists we will get the name from the passwd file. The + * caller must free the returned name. * * This function is system dependant. * @@ -548,7 +567,8 @@ char *silc_get_username(); * * DESCRIPTION * - * Returns the real name of ther user from the passwd file. + * Returns the real name of ther user from the passwd file. The + * caller must free the returned name. * * This function is system dependant. *