Platform SDK: Logon Authentication

FreeCredentialsHandle

The FreeCredentialsHandle function notifies the security system that the credentials are no longer needed. An application calls this function to free the credential handle acquired in the call to the AcquireCredentialsHandle function. When all references to this credential set have been removed, the credentials themselves can be removed.

SECURITY_STATUS FreeCredentialsHandle(
  PCredHandle phCredential  // handle to free
);

Parameters

phCredential
[in] Pointer to the credential handle obtained by using the AcquireCredentialsHandle function.

Return Values

If the function succeeds, the return value is SEC_E_OK.

If the function fails, the return value may be the following error code.

Value Meaning
SEC_E_INVALID_HANDLE The handle passed to the function is invalid.

Remarks

The FreeCredentialsHandle function allows the security system to free any resources associated with the credential handle.

The prototype for this function can be found in Sspi.h.

Requirements

  Windows NT/2000: Requires Windows NT 3.51 or later.
  Windows 95/98: Requires Windows 95 or later.
  Header: Declared in Sspi.h; include Security.h.
  Library: Use Secur32.lib.

See Also

AcquireCredentialsHandle