Auto Connect C API

C functions for the Auto Connect API. More...

Collaboration diagram for Auto Connect C API:

Typedefs
typedef uint32_t	ACConfigId
	An ID number representing a network configuration. More...

Functions
NNResult	ACInitialize ()
	Initialise the Auto Connect library. More...
void	ACFinalize ()
	Cleanup the Auto Connect library. More...
NNResult	ACConnect ()
	Connects synchronically to a network, using the default configuration May be blocking until the console successfully connects or has an timeout. More...
NNResult	ACConnectAsync ()
	Connects asynchronically to a network, using the default configuration. More...
NNResult	ACClose ()
	Closes connections made with ACConnect. More...
NNResult	ACGetCloseStatus ()
NNResult	ACIsApplicationConnected (BOOL *connected)
	Checks whether the console is currently connected to a network. More...
NNResult	ACGetStartupId (ACConfigId *configId)
	Gets the default connection configuration id. More...
NNResult	ACConnectWithConfigId (ACConfigId configId)
	Connects to a network, using the configuration represented by the given ACConfigId. More...
NNResult	ACGetAssignedAddress (uint32_t *ip)
	Gets the IP address assosciated with the currently active connection. More...

Detailed Description

C functions for the Auto Connect API.

Typedef Documentation

ACConfigId

typedef uint32_t ACConfigId

An ID number representing a network configuration.

These are the same IDs as shown in System Settings' Connection List.

Definition at line 20 of file ac_c.h.

Function Documentation

ACInitialize()

NNResult ACInitialize

(

)

Initialise the Auto Connect library.

Call this function before any other AC functions.

Returns

A Result - see NNResult_IsSuccess and NNResult_IsFailure.

See also

• ACFinalize

ACFinalize()

void ACFinalize

(

)

Cleanup the Auto Connect library.

Do not call any AC functions (other than ACInitialize) after calling this function.

See also

• ACInitialize

ACConnect()

NNResult ACConnect

(

)

Connects synchronically to a network, using the default configuration May be blocking until the console successfully connects or has an timeout.

Returns

A Result - see NNResult_IsSuccess and NNResult_IsFailure.

ACConnectAsync()

NNResult ACConnectAsync

(

)

Connects asynchronically to a network, using the default configuration.

Returns

A Result - see NNResult_IsSuccess and NNResult_IsFailure.

ACClose()

NNResult ACClose

(

)

Closes connections made with ACConnect.

Use GetCloseStatus to get the status.

Returns

A Result - see NNResult_IsSuccess and NNResult_IsFailure.

ACGetCloseStatus()

NNResult ACGetCloseStatus

(

)

ACIsApplicationConnected()

NNResult ACIsApplicationConnected

(

BOOL *

connected

)

Checks whether the console is currently connected to a network.

Returns

A Result - see NNResult_IsSuccess and NNResult_IsFailure.

ACGetStartupId()

NNResult ACGetStartupId

(

ACConfigId *

configId

)

Gets the default connection configuration id.

This is the default as marked in System Settings.

Parameters

configId

A pointer to an ACConfigId to write the config ID to. Must not be NULL.

Returns

A Result - see NNResult_IsSuccess and NNResult_IsFailure.

ACConnectWithConfigId()

NNResult ACConnectWithConfigId

(

ACConfigId

configId

)

Connects to a network, using the configuration represented by the given ACConfigId.

Parameters

configId

The ACConfigId representing the network to connect to.

Returns

A Result - see NNResult_IsSuccess and NNResult_IsFailure.

ACGetAssignedAddress()

NNResult ACGetAssignedAddress

(

uint32_t *

ip

)

Gets the IP address assosciated with the currently active connection.

Parameters

ip	A pointer to write the IP address to, in numerical form.

Returns

A Result - see NNResult_IsSuccess and NNResult_IsFailure.