One Logo Pool Ball
X
Github
Discord

System

System · IOS API REFERENCE

SystemConfiguration

Allow applications to access a device’s network configuration settings. Determine the reachability of the device, such as whether Wi-Fi or cell connectivity are active.

25 types

95 callable entries

18 skipped

84% entry coverage

Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.

Types

AuthorizationRef

typealias

SCBondInterface

typealias

SCBondStatus

class

SCDynamicStore

class

SCDynamicStoreCallBack

typealias

SCDynamicStoreContext

struct

SCNetworkConnection

class

SCNetworkConnectionCallBack

typealias

SCNetworkConnectionContext

struct

SCNetworkConnectionFlags

typealias

SCNetworkConnectionPPPStatus

enum

SCNetworkConnectionStatus

enum

SCNetworkInterface

class

SCNetworkProtocol

class

SCNetworkReachability

class

SCNetworkReachabilityCallBack

typealias

SCNetworkReachabilityContext

struct

SCNetworkReachabilityFlags

struct

SCNetworkService

class

SCNetworkSet

class

SCPreferences

class

SCPreferencesCallBack

typealias

SCPreferencesContext

struct

SCPreferencesNotification

struct

SCVLANInterface

typealias

Functions and constants

get

kSCBondStatusLinkInvalid

TypeScript
const kSCBondStatusLinkInvalid: number
Swift declaration
var kSCBondStatusLinkInvalid: Int { get }
get

kSCBondStatusNoPartner

TypeScript
const kSCBondStatusNoPartner: number
Swift declaration
var kSCBondStatusNoPartner: Int { get }
get

kSCBondStatusNotInActiveGroup

TypeScript
const kSCBondStatusNotInActiveGroup: number
Swift declaration
var kSCBondStatusNotInActiveGroup: Int { get }
get

kSCBondStatusOK

TypeScript
const kSCBondStatusOK: number
Swift declaration
var kSCBondStatusOK: Int { get }
get

kSCBondStatusUnknown

TypeScript
const kSCBondStatusUnknown: number
Swift declaration
var kSCBondStatusUnknown: Int { get }
get

kSCNetworkFlagsConnectionAutomatic

TypeScript
const kSCNetworkFlagsConnectionAutomatic: number
Swift declaration
var kSCNetworkFlagsConnectionAutomatic: Int { get }
get

kSCNetworkFlagsConnectionRequired

TypeScript
const kSCNetworkFlagsConnectionRequired: number
Swift declaration
var kSCNetworkFlagsConnectionRequired: Int { get }
get

kSCNetworkFlagsInterventionRequired

TypeScript
const kSCNetworkFlagsInterventionRequired: number
Swift declaration
var kSCNetworkFlagsInterventionRequired: Int { get }
get

kSCNetworkFlagsIsDirect

TypeScript
const kSCNetworkFlagsIsDirect: number
Swift declaration
var kSCNetworkFlagsIsDirect: Int { get }
get

kSCNetworkFlagsIsLocalAddress

TypeScript
const kSCNetworkFlagsIsLocalAddress: number
Swift declaration
var kSCNetworkFlagsIsLocalAddress: Int { get }
get

kSCNetworkFlagsReachable

TypeScript
const kSCNetworkFlagsReachable: number
Swift declaration
var kSCNetworkFlagsReachable: Int { get }
get

kSCNetworkFlagsTransientConnection

TypeScript
const kSCNetworkFlagsTransientConnection: number
Swift declaration
var kSCNetworkFlagsTransientConnection: Int { get }
get

kSCStatusAccessError

TypeScript
const kSCStatusAccessError: number
Swift declaration
var kSCStatusAccessError: Int { get }
get

kSCStatusFailed

TypeScript
const kSCStatusFailed: number
Swift declaration
var kSCStatusFailed: Int { get }
get

kSCStatusInvalidArgument

TypeScript
const kSCStatusInvalidArgument: number
Swift declaration
var kSCStatusInvalidArgument: Int { get }
get

kSCStatusKeyExists

TypeScript
const kSCStatusKeyExists: number
Swift declaration
var kSCStatusKeyExists: Int { get }
get

kSCStatusLocked

TypeScript
const kSCStatusLocked: number
Swift declaration
var kSCStatusLocked: Int { get }
get

kSCStatusMaxLink

TypeScript
const kSCStatusMaxLink: number
Swift declaration
var kSCStatusMaxLink: Int { get }
get

kSCStatusNeedLock

TypeScript
const kSCStatusNeedLock: number
Swift declaration
var kSCStatusNeedLock: Int { get }
get

kSCStatusNoConfigFile

TypeScript
const kSCStatusNoConfigFile: number
Swift declaration
var kSCStatusNoConfigFile: Int { get }
get

kSCStatusNoKey

TypeScript
const kSCStatusNoKey: number
Swift declaration
var kSCStatusNoKey: Int { get }
get

kSCStatusNoLink

TypeScript
const kSCStatusNoLink: number
Swift declaration
var kSCStatusNoLink: Int { get }
get

kSCStatusNoPrefsSession

TypeScript
const kSCStatusNoPrefsSession: number
Swift declaration
var kSCStatusNoPrefsSession: Int { get }
get

kSCStatusNoStoreServer

TypeScript
const kSCStatusNoStoreServer: number
Swift declaration
var kSCStatusNoStoreServer: Int { get }
get

kSCStatusNoStoreSession

TypeScript
const kSCStatusNoStoreSession: number
Swift declaration
var kSCStatusNoStoreSession: Int { get }
get

kSCStatusNotifierActive

TypeScript
const kSCStatusNotifierActive: number
Swift declaration
var kSCStatusNotifierActive: Int { get }
get

kSCStatusOK

TypeScript
const kSCStatusOK: number
Swift declaration
var kSCStatusOK: Int { get }
get

kSCStatusPrefsBusy

TypeScript
const kSCStatusPrefsBusy: number
Swift declaration
var kSCStatusPrefsBusy: Int { get }
get

kSCStatusReachabilityUnknown

TypeScript
const kSCStatusReachabilityUnknown: number
Swift declaration
var kSCStatusReachabilityUnknown: Int { get }
get

kSCStatusStale

TypeScript
const kSCStatusStale: number
Swift declaration
var kSCStatusStale: Int { get }
function · iOS 2.0+

SCCopyLastError

TypeScript
SCCopyLastError(): _CoreFoundation_CFError
Swift declaration
func SCCopyLastError() -> CFError
function · iOS 2.0+

SCError

TypeScript
SCError(): number
Swift declaration
func SCError() -> Int32
function · iOS 2.0+

SCErrorString

TypeScript
SCErrorString(status: number): SDKHandle
Swift declaration
func SCErrorString(_ status: Int32) -> UnsafePointer<CChar>
function · iOS 2.0+ · Deprecated in iOS 17.4

SCNetworkReachabilityCreateWithAddress

TypeScript
SCNetworkReachabilityCreateWithAddress(allocator: (_CoreFoundation_CFAllocator) | null, address: SDKHandle): (SCNetworkReachability) | null
Swift declaration
func SCNetworkReachabilityCreateWithAddress(_ allocator: CFAllocator?, _ address: UnsafePointer<sockaddr>) -> SCNetworkReachability?
function · iOS 2.0+ · Deprecated in iOS 17.4

SCNetworkReachabilityCreateWithAddressPair

TypeScript
SCNetworkReachabilityCreateWithAddressPair(allocator?: (_CoreFoundation_CFAllocator) | null, localAddress?: (SDKHandle) | null, remoteAddress?: (SDKHandle) | null): (SCNetworkReachability) | null
Swift declaration
func SCNetworkReachabilityCreateWithAddressPair(_ allocator: CFAllocator?, _ localAddress: UnsafePointer<sockaddr>?, _ remoteAddress: UnsafePointer<sockaddr>?) -> SCNetworkReachability?
function · iOS 2.0+ · Deprecated in iOS 17.4

SCNetworkReachabilityCreateWithName

TypeScript
SCNetworkReachabilityCreateWithName(allocator: (_CoreFoundation_CFAllocator) | null, nodename: SDKHandle): (SCNetworkReachability) | null
Swift declaration
func SCNetworkReachabilityCreateWithName(_ allocator: CFAllocator?, _ nodename: UnsafePointer<CChar>) -> SCNetworkReachability?
function · iOS 2.0+ · Deprecated in iOS 17.4

SCNetworkReachabilityGetTypeID

TypeScript
SCNetworkReachabilityGetTypeID(): number
Swift declaration
func SCNetworkReachabilityGetTypeID() -> CFTypeID
function · iOS 2.0+ · Deprecated in iOS 17.4

SCNetworkReachabilityScheduleWithRunLoop

TypeScript
SCNetworkReachabilityScheduleWithRunLoop(target: SCNetworkReachability, runLoop: _CoreFoundation_CFRunLoop, runLoopMode: _CoreFoundation_CFString): boolean
Swift declaration
func SCNetworkReachabilityScheduleWithRunLoop(_ target: SCNetworkReachability, _ runLoop: CFRunLoop, _ runLoopMode: CFString) -> Bool
function · iOS 4.0+ · Deprecated in iOS 17.4

SCNetworkReachabilitySetDispatchQueue

TypeScript
SCNetworkReachabilitySetDispatchQueue(target: SCNetworkReachability, queue?: (_Dispatch_DispatchQueue) | null): boolean
Swift declaration
func SCNetworkReachabilitySetDispatchQueue(_ target: SCNetworkReachability, _ queue: dispatch_queue_t?) -> Bool
function · iOS 2.0+ · Deprecated in iOS 17.4

SCNetworkReachabilityUnscheduleFromRunLoop

TypeScript
SCNetworkReachabilityUnscheduleFromRunLoop(target: SCNetworkReachability, runLoop: _CoreFoundation_CFRunLoop, runLoopMode: _CoreFoundation_CFString): boolean
Swift declaration
func SCNetworkReachabilityUnscheduleFromRunLoop(_ target: SCNetworkReachability, _ runLoop: CFRunLoop, _ runLoopMode: CFString) -> Bool
get · iOS 2.0+

kCFErrorDomainSystemConfiguration

TypeScript
const kCFErrorDomainSystemConfiguration: _CoreFoundation_CFString
Swift declaration
let kCFErrorDomainSystemConfiguration: CFString
get

kSCNetworkConnectionBytesIn

TypeScript
const kSCNetworkConnectionBytesIn: string
Swift declaration
var kSCNetworkConnectionBytesIn: String { get }
get

kSCNetworkConnectionBytesOut

TypeScript
const kSCNetworkConnectionBytesOut: string
Swift declaration
var kSCNetworkConnectionBytesOut: String { get }
get

kSCNetworkConnectionErrorsIn

TypeScript
const kSCNetworkConnectionErrorsIn: string
Swift declaration
var kSCNetworkConnectionErrorsIn: String { get }
get

kSCNetworkConnectionErrorsOut

TypeScript
const kSCNetworkConnectionErrorsOut: string
Swift declaration
var kSCNetworkConnectionErrorsOut: String { get }
get

kSCNetworkConnectionPacketsIn

TypeScript
const kSCNetworkConnectionPacketsIn: string
Swift declaration
var kSCNetworkConnectionPacketsIn: String { get }
get

kSCNetworkConnectionPacketsOut

TypeScript
const kSCNetworkConnectionPacketsOut: string
Swift declaration
var kSCNetworkConnectionPacketsOut: String { get }
get

kSCNetworkConnectionSelectionOptionOnDemandHostName

TypeScript
const kSCNetworkConnectionSelectionOptionOnDemandHostName: string
Swift declaration
var kSCNetworkConnectionSelectionOptionOnDemandHostName: String { get }
get

kSCNetworkConnectionSelectionOptionOnDemandRetry

TypeScript
const kSCNetworkConnectionSelectionOptionOnDemandRetry: string
Swift declaration
var kSCNetworkConnectionSelectionOptionOnDemandRetry: String { get }

Skipped declarations

18 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

SCDynamicStoreContext.init(version:info:retain:release:copyDescription:)

callback cannot propagate synchronous failure

SCDynamicStoreContext.retain

closure property answers its caller

SCDynamicStoreContext.release

The iOS SDK compiler rejected this binding: a C function pointer can only be formed from a reference to a 'func' or a literal closure

SCDynamicStoreContext.copyDescription

closure property answers its caller

SCPreferencesContext.init(version:info:retain:release:copyDescription:)

callback cannot propagate synchronous failure

SCPreferencesContext.retain

closure property answers its caller

SCPreferencesContext.release

The iOS SDK compiler rejected this binding: a C function pointer can only be formed from a reference to a 'func' or a literal closure

SCPreferencesContext.copyDescription

closure property answers its caller

SCNetworkReachabilityContext.init(version:info:retain:release:copyDescription:)

callback cannot propagate synchronous failure

SCNetworkReachabilityContext.retain

closure property answers its caller

SCNetworkReachabilityContext.release

The iOS SDK compiler rejected this binding: a C function pointer can only be formed from a reference to a 'func' or a literal closure

SCNetworkReachabilityContext.copyDescription

closure property answers its caller

SCNetworkReachabilityGetFlags(_:_:)

The iOS SDK compiler rejected this binding: cannot convert value of type 'UnsafeMutablePointer<SCNetworkReachabilityFlags>' to expected argument type 'UnsafeMutablePointer<UInt32>'

SCNetworkReachabilitySetCallback(_:_:_:)

The iOS SDK compiler rejected this binding: a C function pointer cannot be formed from a closure that captures context

SCNetworkConnectionContext.init(version:info:retain:release:copyDescription:)

callback cannot propagate synchronous failure

SCNetworkConnectionContext.retain

closure property answers its caller

SCNetworkConnectionContext.release

The iOS SDK compiler rejected this binding: a C function pointer can only be formed from a reference to a 'func' or a literal closure

SCNetworkConnectionContext.copyDescription

closure property answers its caller