Platforms to show: All Mac Windows Linux Cross-Platform

Back to CWInterfaceMBS class.

CWInterfaceMBS.associateToEnterpriseNetwork(network as CWNetworkMBS, SecIdentityRef as Integer, username as string, password as string, byref error as NSErrorMBS) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 13.5 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Connects to the given enterprise network.

network: The network to which the interface will associate.
username: The username to use for IEEE 802.1X authentication.
password: The password to use for IEEE 802.1X authentication.
identity: The identity to use for IEEE 802.1X authentication. Holds the corresponding client certificate.
error: An NSError object passed by reference, which will be populated with the error code and the error description if an error occurs during the execution of this method.

Returns a Boolean value which will indicate whether or not a failure occurred during execution. True indicates no error occurred.

This method will block for the duration of the association. This operation may require an administrator password.

CWInterfaceMBS.associateToNetwork(network as CWNetworkMBS, parameters as dictionary, byref error as NSErrorMBS) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.0 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Attempts to associate to the given CWNetworkMBS, with the given association parameters.

parameters: A dicitonary object containing association parameters.
error: An error object passed by reference, which will be populated with error code and error description if an error occurs during the execution of the method. This parameter is optional.

Returns a boolean value which will indicate whether or not a failure occured. True indicates no error occured.

See the association parameters defined in CWGlobalsMBS for more information. Certain networks will require specific authentication credentials for association (i.e. a network using WPA2 Personal authentication will require a passphrase). This method will block for the duration of the association. This method may prompt for an administrator password if the corresponding preference is enabled in the current configuration.

See also:

CWInterfaceMBS.associateToNetwork(network as CWNetworkMBS, password as string, byref error as NSErrorMBS) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Associates to a given network using the given network passphrase.

network: The network to which the interface will associate.
password: The network passphrase or key. Required for association to WEP, WPA Personal, and WPA2 Personal networks.
error: An NSErrorMBS object passed by reference, which will be populated with the error code and the error description if an error occurs during the execution of this method. This parameter is optional and can be passed as nil.

Returns a boolean value which will indicate whether or not a failure occurred during execution. true indicates no error occurred.

This method will block for the duration of the association. This operation may require an administrator password.

Available on Mac OS X 10.7 or later.

See also:

CWInterfaceMBS.cachedScanResults as CWNetworkMBS()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
The networks currently in the scan cache for the WLAN interface.

Returns empty array in the case of an error.
Available on Mac OS X 10.7 or later.

Some examples using this method:

CWInterfaceMBS.commitConfiguration(config as CWConfigurationMBS, byref error as NSErrorMBS) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.0 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Changing the interface configuration.

config: An CWConfiguration object containing the desired changes to the current CW configuration preferences.
error: An error object passed by reference, which will be populated with error code and error description if an error occurs during the execution of the method. This parameter is optional.

Returns a boolean value which will indicate whether or not a failure occured. True indicates no error occured.

This method uses the SFAuthorization property of the given CWInterface object to commit the given configuration. The SFAuthorization property must be authorized with administrative privileges.

See also:

CWInterfaceMBS.commitConfiguration(config as CWConfigurationMBS, SFAuthorizationRef as Integer, byref error as NSErrorMBS) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 13.5 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Commit a configuration for the given WLAN interface.

configuration: The configuration to commit.
authorization: An SFAuthorization object to use for authorizing the commit. This parameter is optional and can be passed as 0.
error: An NSError object passed by reference, which will be populated with the error code and the error description if an error occurs during the execution of this method.

Returns a Boolean value which will indicate whether or not a failure occurred during execution. True indicates no error occurred.

This method requires the caller have root privileges or obtain administrator privileges with the authorization parameter.

See also:

CWInterfaceMBS.Constructor

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.0 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Creates an CWInterface for the primary interface.
Example
dim c as new CWInterfaceMBS

MsgBox c.description

See also:

CWInterfaceMBS.Constructor(name as string)

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.0 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Creates an interface object linked to the interface of the given name.
Example
dim c as new CWInterfaceMBS("en0")

MsgBox c.description

See also:

CWInterfaceMBS.disassociate

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.0 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Disassociates the CoreWLAN interface from the currently associated network.

This method is a no-op if the given CoreWLAN interface is not associated to a network. This method may prompt for an administrator password if the corresponding preference is enabled in the current configuration.

CWInterfaceMBS.enableIBSSWithParameters as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.0 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Attempts to create a computer-to-computer network with the given parameters.

parameters: A dictionary object containing optional parameters for creating an IBSS network. This parameter is optional and may be passed as nil.
error: An error object passed by reference, which will be populated with error code and error description if an error occurs during the execution of the method. This parameter is optional and can be passed as nil.

Return a boolean value which will indicate whether or not a failure occured. True indicates no error occured.

See the IBSS creation parameters defined in CWGlobals.h for more information. If no IBSS creation parameters are present, the default behavior is to create an open authentication computer-to-computer network using the machine name as the network name. This method may prompt for an administrator password if the corresponding preference is enabled in the current configuration.

See also:

CWInterfaceMBS.enableIBSSWithParameters(byref error as NSErrorMBS) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.0 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Attempts to create a computer-to-computer network with the given parameters.

parameters: A dictionary object containing optional parameters for creating an IBSS network. This parameter is optional and may be passed as nil.
error: An error object passed by reference, which will be populated with error code and error description if an error occurs during the execution of the method. This parameter is optional and can be passed as nil.

Return a boolean value which will indicate whether or not a failure occured. True indicates no error occured.

See the IBSS creation parameters defined in CWGlobals.h for more information. If no IBSS creation parameters are present, the default behavior is to create an open authentication computer-to-computer network using the machine name as the network name. This method may prompt for an administrator password if the corresponding preference is enabled in the current configuration.

See also:

CWInterfaceMBS.enableIBSSWithParameters(parameters as dictionary) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.0 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Attempts to create a computer-to-computer network with the given parameters.

parameters: A dictionary object containing optional parameters for creating an IBSS network. This parameter is optional and may be passed as nil.
error: An error object passed by reference, which will be populated with error code and error description if an error occurs during the execution of the method. This parameter is optional and can be passed as nil.

Return a boolean value which will indicate whether or not a failure occured. True indicates no error occured.

See the IBSS creation parameters defined in CWGlobals.h for more information. If no IBSS creation parameters are present, the default behavior is to create an open authentication computer-to-computer network using the machine name as the network name. This method may prompt for an administrator password if the corresponding preference is enabled in the current configuration.

See also:

CWInterfaceMBS.enableIBSSWithParameters(parameters as dictionary, byref error as NSErrorMBS) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.0 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Attempts to create a computer-to-computer network with the given parameters.

parameters: A dictionary object containing optional parameters for creating an IBSS network. This parameter is optional and may be passed as nil.
error: An error object passed by reference, which will be populated with error code and error description if an error occurs during the execution of the method. This parameter is optional and can be passed as nil.

Return a boolean value which will indicate whether or not a failure occured. True indicates no error occured.

See the IBSS creation parameters defined in CWGlobals.h for more information. If no IBSS creation parameters are present, the default behavior is to create an open authentication computer-to-computer network using the machine name as the network name. This method may prompt for an administrator password if the corresponding preference is enabled in the current configuration.

See also:

CWInterfaceMBS.isEqualToInterface(otherInterface as CWInterfaceMBS) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.0 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Comparing interfaces.

Two CWInterface objects are considered equal if their corresponding <i>name</i> and capabilities properties are equal.

Returns true if both interfaces are equal.

CWInterfaceMBS.scanForNetworksWithName(networkName as string, byref error as NSErrorMBS) as CWNetworkMBS()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Scans for networks.

networkName: The name (SSID) of the network for which to scan.
error: An NSErrorMBS object passed by reference, which will be populated with the error code and the error description if an error occurs during the execution of this method. This parameter is optional and can be passed as nil.

Returns an array of CWNetworkMBS objects.

If ssid parameter is present, a directed scan will be performed by the interface, otherwise a broadcast scan will be performed. This method will block for the duration of the scan.

Available on Mac OS X 10.7 or later.

CWInterfaceMBS.scanForNetworksWithParameters as CWNetworkMBS()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.0 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Performs a scan with the given CoreWLAN interface, returning any found networks.

parameters: A dicitonary object containing optional scan parameters which can be used to control the behavior of the scan. This parameter is optional.

error: A error object passed by reference, which will be populated with error code and error description if an error occurs during the execution of the method. This parameter is optional.

Returns an array containing CWNetworkMBS objects representing the networks found in the scan.

See the scan parameters defined in CWGlobalsMBS for controlling scan behavior. If no scan parameters are present, the default behavior is to perform a broadcast scan on active channels, for all supported PHY modes. This method will block for the duration of the scan.

See also:

CWInterfaceMBS.scanForNetworksWithParameters(byref error as NSErrorMBS) as CWNetworkMBS()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.0 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Performs a scan with the given CoreWLAN interface, returning any found networks.

parameters: A dicitonary object containing optional scan parameters which can be used to control the behavior of the scan. This parameter is optional.

error: A error object passed by reference, which will be populated with error code and error description if an error occurs during the execution of the method. This parameter is optional.

Returns an array containing CWNetworkMBS objects representing the networks found in the scan.

See the scan parameters defined in CWGlobalsMBS for controlling scan behavior. If no scan parameters are present, the default behavior is to perform a broadcast scan on active channels, for all supported PHY modes. This method will block for the duration of the scan.

See also:

CWInterfaceMBS.scanForNetworksWithParameters(parameters as dictionary) as CWNetworkMBS()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.0 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Performs a scan with the given CoreWLAN interface, returning any found networks.

parameters: A dicitonary object containing optional scan parameters which can be used to control the behavior of the scan. This parameter is optional.

error: A error object passed by reference, which will be populated with error code and error description if an error occurs during the execution of the method. This parameter is optional.

Returns an array containing CWNetworkMBS objects representing the networks found in the scan.

See the scan parameters defined in CWGlobalsMBS for controlling scan behavior. If no scan parameters are present, the default behavior is to perform a broadcast scan on active channels, for all supported PHY modes. This method will block for the duration of the scan.

See also:

CWInterfaceMBS.scanForNetworksWithParameters(parameters as dictionary, byref error as NSErrorMBS) as CWNetworkMBS()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.0 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Performs a scan with the given CoreWLAN interface, returning any found networks.

parameters: A dicitonary object containing optional scan parameters which can be used to control the behavior of the scan. This parameter is optional.

error: A error object passed by reference, which will be populated with error code and error description if an error occurs during the execution of the method. This parameter is optional.

Returns an array containing CWNetworkMBS objects representing the networks found in the scan.

See the scan parameters defined in CWGlobalsMBS for controlling scan behavior. If no scan parameters are present, the default behavior is to perform a broadcast scan on active channels, for all supported PHY modes. This method will block for the duration of the scan.

See also:

CWInterfaceMBS.scanForNetworksWithSSID(ssid as memoryblock, byref error as NSErrorMBS) as CWNetworkMBS()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Scans for networks.

ssid The SSID for which to scan.
error: An NSErrorMBS object passed by reference, which will be populated with the error code and the error description if an error occurs during the execution of this method. This parameter is optional and can be passed as nil.

Returns an array of CWNetworkMBS objects.

If ssid parameter is present, a directed scan will be performed by the interface, otherwise a broadcast scan will be performed. This method will block for the duration of the scan.

Available on Mac OS X 10.7 or later.

CWInterfaceMBS.setChannel(channel as UInt32) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.0 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Sets the channel for the given CoreWLAN interface.

channel: An integer representing the channel to which the CoreWLAN interface should be tuned.
error: A error object passed by reference, which will be populated with error code and error description if an error occurs during the execution of the method. This parameter is optional.

Returns a boolean value which will indicate whether or not a failure occured. True indicates no error occured.

The current channel cannot be changed if the CoreWLAN interface is associated to a network. channel must be supported by the given interface.

See also:

CWInterfaceMBS.setChannel(channel as UInt32, byref error as NSErrorMBS) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.0 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Sets the channel for the given CoreWLAN interface.

channel: An integer representing the channel to which the CoreWLAN interface should be tuned.
error: A error object passed by reference, which will be populated with error code and error description if an error occurs during the execution of the method. This parameter is optional.

Returns a boolean value which will indicate whether or not a failure occured. True indicates no error occured.

The current channel cannot be changed if the CoreWLAN interface is associated to a network. channel must be supported by the given interface.

See also:

CWInterfaceMBS.setPairwiseMasterKey(key as Memoryblock, byref error as NSErrorMBS) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 13.5 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Sets the interface pairwise master key (PMK).

key: A memoryblock containing the pairwise master key (PMK).
error: An NSError object passed by reference, which will be populated with the error code and the error description if an error occurs during the execution of this method.
Returns a Boolean value which will indicate whether or not a failure occurred during execution. True indicates no error occurred.

Key must be 32 octets. If key is nil, this method clears the PMK for the interface.

CWInterfaceMBS.setPower(p as boolean) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.0 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Sets the power state for the given CoreWLAN interface.

power: A boolean value indicating the power state to which the CoreWLAN interface should be set. False indicates the "OFF" state.

error: A error object passed by reference, which will be populated with error code and error description if an error occurs during the execution of the method. This parameter is optional.

Returns a boolean value which will indicate whether or not a failure occured. True indicates no error occured.

This method may prompt for an administrator password if the corresponding preference is enabled in the current configuration.

See also:

CWInterfaceMBS.setPower(p as boolean, byref error as NSErrorMBS) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.0 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Sets the power state for the given CoreWLAN interface.

power: A boolean value indicating the power state to which the CoreWLAN interface should be set. False indicates the "OFF" state.

error: A error object passed by reference, which will be populated with error code and error description if an error occurs during the execution of the method. This parameter is optional.

Returns a boolean value which will indicate whether or not a failure occured. True indicates no error occured.

This method may prompt for an administrator password if the corresponding preference is enabled in the current configuration.

See also:

CWInterfaceMBS.setWEPKey(key as Memoryblock, flags as Integer, index as Integer, byref error as NSErrorMBS) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 13.5 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Sets the interface WEP key.

key: A memoryblock containing the WEP key.
flags: The cipher key flags to use for the specified key. Combination of kCWCipherKeyFlagsNone, kCWCipherKeyFlagsUnicast, kCWCipherKeyFlagsMulticast, kCWCipherKeyFlagsTx or kCWCipherKeyFlagsRx.
index: Integer which default key index to use for the specified key.
error An NSError object passed by reference, which will be populated with the error code and the error description if an error occurs during the execution of this method.

Returns a boolean value which will indicate whether or not a failure occurred during execution. True indicates no error occurred.

Key must be 5 octets for WEP-40 or 13 octets for WEP-104. if key is nil, this method clears the WEP key for the interface. index must correspond to default key index 1-4.

CWInterfaceMBS.setWLANChannel(channel as CWChannelMBS, byref error as NSErrorMBS) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Sets the interface channel.

channel: A CWChannel object corresponding to the channel.
error: An NSErrorMBS object passed by reference, which will be populated with the error code and the error description if an error occurs during the execution of this method. This parameter is optional and can be passed as nil.

A Boolean value which will indicate whether or not a failure occurred during execution. True indicates no error occurred.

The channel cannot be changed if the interface is associated to a network.

Available on Mac OS X 10.7 or later.

CWInterfaceMBS.startIBSSModeWithSSID(ssidData as MemoryBlock, security as Integer, channel as Integer, password as string, byref error as NSErrorMBS) as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 13.5 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Creates a computer-to-computer (ad-hoc) network with the given network name, security type, and password on the specified channel.

security: The security type to be used. kCWIBSSModeSecurityNone, kCWIBSSModeSecurityWEP40 or kCWIBSSModeSecurityWEP104.
channel: The channel on which the network will be created.
password: The password to be used. This paramter is not applicable to open system authentication.

Returns a Boolean value which will indicate whether or not a failure occurred during execution. True indicates no error occurred.

This operation may require an administrator password.

CWInterfaceMBS.supportedChannels as Integer()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.0 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Array of channels supported by the CoreWLAN interface for the active country code.

Dynamically queries the interface for the supported channels.

CWInterfaceMBS.supportedPHYModes as Integer()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.0 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
Array of PHY modes supported by the CoreWLAN interface.

Dynamically queries the interface for the supported PHY modes.

CWInterfaceMBS.supportedWLANChannels as CWChannelMBS()

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Network MBS MacFrameworks Plugin 11.2 ✅ Yes ❌ No ❌ No ❌ No Desktop, Console & Web
An array of channels supported by the interface for the active country code.
Example
dim c as CWInterfaceMBS = CWInterfaceMBS.interfaceWithName("en0")
dim channels() as CWChannelMBS = c.supportedWLANChannels
dim lines() as string
for each ch as CWChannelMBS in channels
lines.append str(ch.channelNumber) + ": "+ str(ch.channelBand)
next
MsgBox join(lines,", ")

Dynamically queries the interface for the supported channels. Returns an array of CWChannel objects, or nil in the case of an error.

Available on Mac OS X 10.7 or later.

The items on this page are in the following plugins: MBS MacFrameworks Plugin.


The biggest plugin in space...