CFHTTPMessageApplyCredentials(_:_:_:_:_:)

Performs the authentication method specified by a CFHTTPAuthentication object.

Declaration

func CFHTTPMessageApplyCredentials(_ request: CFHTTPMessage, _ auth: CFHTTPAuthentication, _ username: CFString?, _ password: CFString?, _ error: UnsafeMutablePointer<CFStreamError>?) -> Bool

Parameters

request:
Request for which the authentication method is to be performed.
auth:
A CFHTTPAuthentication object specifying the authentication method to perform.
username:
Username for performing the authentication.
password:
Password for performing the authentication.
error:
If an error occurs, upon return contains a doc://com.apple.documentation/documentation/corefoundation/cfstreamerror object that describes the error and the error’s domain. Pass NULL if you don’t want to receive error information.

Return Value

TRUE if the authentication was successful, otherwise, FALSE.

Discussion

This function performs the authentication method specified by auth on behalf of the request specified by request using the credentials specified by username and password. If, in addition to a username and password, you also need to specify an account domain, call CFHTTPMessageApplyCredentialDictionary(_:_:_:_:) instead of this function.

This function is appropriate for performing several authentication requests. If you only need to make a single authentication request, consider using CFHTTPMessageAddAuthentication(_:_:_:_:_:_:) instead.

Special Considerations

This function is thread safe as long as another thread does not alter the same CFHTTPMessage object at the same time.