Functions

General Description

Functions
cy_rslt_t	cy_enterprise_security_create (cy_enterprise_security_t *handle, cy_enterprise_security_parameters_t *ent_parameters)
	Creates an Enterprise Security instance. More...
cy_rslt_t	cy_enterprise_security_delete (cy_enterprise_security_t *handle)
	Deletes the given Enterprise Security instance and resources allocated by the cy_enterprise_security_create function. More...
cy_rslt_t	cy_enterprise_security_join (cy_enterprise_security_t handle)
	Joins an enterprise security network (802.1x Access point) More...
cy_rslt_t	cy_enterprise_security_leave (cy_enterprise_security_t handle)
	Leaves an enterprise security network (802.1x Access point) More...

Function Documentation

cy_enterprise_security_create()

cy_rslt_t cy_enterprise_security_create	(	cy_enterprise_security_t *	handle,
		cy_enterprise_security_parameters_t *	ent_parameters
	)

Creates an Enterprise Security instance.

This function initializes the Enterprise Security library with the given Enterprise Security parameters and returns an Enterprise Security instance to application.

Parameters

[out]	handle	: Pointer to store the Enterprise Security instance handle allocated by this function on successful return.
[in]	ent_parameters	: Pointer to cy_enterprise_security_parameters_t structure, initialized by the caller with the details required for establishing connection with the enterprise network.

Returns

cy_rslt_t : CY_RSLT_SUCCESS - on success, an error code otherwise. Error codes returned by this function are:
CY_RSLT_ENTERPRISE_SECURITY_BADARG
CY_RSLT_ENTERPRISE_SECURITY_NOMEM

cy_enterprise_security_delete()

cy_rslt_t cy_enterprise_security_delete

(

cy_enterprise_security_t *

handle

)

Deletes the given Enterprise Security instance and resources allocated by the cy_enterprise_security_create function.

Parameters

[in]

handle

: Handle to Enterprise Security instance returned by cy_enterprise_security_create function.

Returns

cy_rslt_t : CY_RSLT_SUCCESS - on success, an error code otherwise. Error codes returned by this function are:
CY_RSLT_ENTERPRISE_SECURITY_BADARG

cy_enterprise_security_join()

cy_rslt_t cy_enterprise_security_join

(

cy_enterprise_security_t

handle

)

Joins an enterprise security network (802.1x Access point)

Parameters

[in]

handle

: Handle to Enterprise Security instance returned by cy_enterprise_security_create function.

Returns

cy_rslt_t : CY_RSLT_SUCCESS - on success, an error code otherwise. Error codes returned by this function are:
CY_RSLT_ENTERPRISE_SECURITY_BADARG
CY_RSLT_ENTERPRISE_SECURITY_ALREADY_CONNECTED
CY_RSLT_ENTERPRISE_SECURITY_NOMEM
CY_RSLT_ENTERPRISE_SECURITY_JOIN_ERROR
CY_RSLT_ENTERPRISE_SECURITY_SUPPLICANT_ERROR

cy_enterprise_security_leave()

cy_rslt_t cy_enterprise_security_leave

(

cy_enterprise_security_t

handle

)

Leaves an enterprise security network (802.1x Access point)

Parameters

[in]

handle

: Handle to Enterprise Security instance returned by cy_enterprise_security_create function.

Returns

cy_rslt_t : CY_RSLT_SUCCESS - on success, an error code otherwise. Error codes returned by this function are:
CY_RSLT_ENTERPRISE_SECURITY_BADARG
CY_RSLT_ENTERPRISE_SECURITY_NOT_CONNECTED
CY_RSLT_ENTERPRISE_SECURITY_LEAVE_ERROR
CY_RSLT_ENTERPRISE_SECURITY_SUPPLICANT_ERROR