diff options
author | Steve Holme <steve_holme@hotmail.com> | 2016-08-31 11:57:28 +0100 |
---|---|---|
committer | Steve Holme <steve_holme@hotmail.com> | 2016-08-31 11:57:28 +0100 |
commit | ef5d3facd58f2af751d1b7098b61915cee6ccc79 (patch) | |
tree | e69fe7be13fa931215c49ca07505e31ce5541c51 /lib | |
parent | dafef391f7630c323e02ebd93458e7a40e5f363e (diff) |
curl_sspi.c: Updated function description comments
* Added description to Curl_sspi_free_identity()
* Added parameter and return explanations to Curl_sspi_global_init()
* Added parameter explaination to Curl_sspi_global_cleanup()
Diffstat (limited to 'lib')
-rw-r--r-- | lib/curl_sspi.c | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/lib/curl_sspi.c b/lib/curl_sspi.c index ee3f1b1c1..11a7120a9 100644 --- a/lib/curl_sspi.c +++ b/lib/curl_sspi.c @@ -64,6 +64,12 @@ PSecurityFunctionTable s_pSecFn = NULL; * * Once this function has been executed, Windows SSPI functions can be * called through the Security Service Provider Interface dispatch table. + * + * Parameters: + * + * None. + * + * Returns CURLE_OK on success. */ CURLcode Curl_sspi_global_init(void) { @@ -102,8 +108,11 @@ CURLcode Curl_sspi_global_init(void) * Curl_sspi_global_cleanup() * * This deinitializes the Security Service Provider Interface from libcurl. + * + * Parameters: + * + * None. */ - void Curl_sspi_global_cleanup(void) { if(s_hSecDll) { @@ -205,6 +214,15 @@ CURLcode Curl_create_sspi_identity(const char *userp, const char *passwdp, return CURLE_OK; } +/* + * Curl_sspi_free_identity() + * + * This is used to free the contents of a SSPI identifier structure. + * + * Parameters: + * + * identity [in/out] - The identity structure. + */ void Curl_sspi_free_identity(SEC_WINNT_AUTH_IDENTITY *identity) { if(identity) { |