moparisthebest/curl
1
0
Fork 0
mirror of https://github.com/moparisthebest/curl synced 2024-12-21 23:58:49 -05:00
Code Issues Releases Wiki Activity

curl_sspi.c: Updated function description comments

Browse Source 
* 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()
This commit is contained in:
Steve Holme 2016-08-31 11:57:28 +01:00
parent dafef391f7
commit ef5d3facd5
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
lib/curl_sspi.c
View File

@ -64,6 +64,12 @@ PSecurityFunctionTable s_pSecFn = NULL;
* *
* Once this function has been executed, Windows SSPI functions can be * Once this function has been executed, Windows SSPI functions can be
* called through the Security Service Provider Interface dispatch table. * called through the Security Service Provider Interface dispatch table.
*
* Parameters:
*
* None.
*
* Returns CURLE_OK on success.
*/ */
CURLcode Curl_sspi_global_init(void) CURLcode Curl_sspi_global_init(void)
{ {
@ -102,8 +108,11 @@ CURLcode Curl_sspi_global_init(void)
* Curl_sspi_global_cleanup() * Curl_sspi_global_cleanup()
* *
* This deinitializes the Security Service Provider Interface from libcurl. * This deinitializes the Security Service Provider Interface from libcurl.
*
* Parameters:
*
* None.
*/ */
void Curl_sspi_global_cleanup(void) void Curl_sspi_global_cleanup(void)
{ {
if(s_hSecDll) { if(s_hSecDll) {
@ -205,6 +214,15 @@ CURLcode Curl_create_sspi_identity(const char *userp, const char *passwdp,
return CURLE_OK; 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) void Curl_sspi_free_identity(SEC_WINNT_AUTH_IDENTITY *identity)
{ {
if(identity) { if(identity) {