Contents

CFHTTPAuthenticationIsValid(_:_:)

Returns a Boolean value that indicates whether a CFHTTPAuthentication object is valid.

Declaration

func CFHTTPAuthenticationIsValid(_ auth: CFHTTPAuthentication, _ error: UnsafeMutablePointer<CFStreamError>?) -> Bool

Parameters

  • auth:

    The CFHTTPAuthentication object to examine.

  • error:

    Pointer to a doc://com.apple.documentation/documentation/corefoundation/cfstreamerror structure, whose fields, if an error has occurred, are set to the error and the error’s domain.

Return Value

TRUE if auth contains enough information to be applied to a request.

Discussion

If this function returns FALSE, the CFHTTPAuthentication object may still contain useful information, such as the name of an unsupported authentication method.

Discussion

If this function returns TRUE for auth, the object is good for use with functions such as CFHTTPMessageApplyCredentials(_:_:_:_:_:) and CFHTTPMessageApplyCredentialDictionary(_:_:_:_:). If this function returns FALSE, auth is invalid, and authentications using it will not succeed.

See Also

HTTP Authentication