deviceConfigurationValue

R2026b

Class: wlanRateControl

Retrieve specified device configuration

Since R2026a

Syntax

propertyValue = deviceConfigurationValue(rateControl,propertyWLAN)

propertyValue = deviceConfigurationValue(rateControl,propertyWLAN,AllLinks=linkValue)

Description

propertyValue = deviceConfigurationValue(rateControl,propertyWLAN) returns the configured value for the specified property propertyWLAN of the rate control object rateControl.

propertyValue = deviceConfigurationValue(rateControl,propertyWLAN,AllLinks=linkValue) returns the configured values for all links of the specified property propertyWLAN.

Note

deviceConfigurationValue is a sealed method. To learn about attributes of methods, see Method Attributes.

Input Arguments

rateControl — Rate control object

object of subclass of wlanRateControl class

Rate control object, specified as an object of a subclass of the wlanRateControl class.

propertyWLAN — Property for which to retrieve value

string scalar | character vector

Property for which to retrieve the value, specified as a string scalar or character vector. This value must specify a property from a wlanDeviceConfig, wlanMultilinkDeviceConfig, or wlanLinkConfig object.

To determine whether the device on which you have installed the rate control object is of type wlanDeviceConfig or wlanMultilinkDeviceConfig, use the deviceConfigurationType method. If the device is of type wlanMultilinkDeviceConfig, you can specify a property from either the wlanDeviceConfig or wlanLinkConfig objects. Otherwise, specify a property from the corresponding device configuration object type.

linkValue — Retrieve property value from all links

true or 1 | faalse or 0

Retrieve the property value from all links, specified as a logical 1 (true) or 0 (false). When specified as true, the method returns the values of the specified property from every link in a multi-link configuration. The device on which rateControl has been installed must be a wlanMultilinkDeviceConfig object. If the device is not a multi-link device or the property is not valid for all links, the method ignores the linkValue argument.

Output Arguments

propertyValue — Configured value of specified property

array

Configured value of the specified property, returned as an array. When you set linkValue to true, the method returns an array containing the values of the specified property for all links in the multi-link configuration. If you do not specify linkValue, or set it to false, the method returns the value of the specified property for a single link.

Note

If the device configuration type is wlanMultilinkDeviceConfig and you specify to retrieve a property of the wlanLinkConfig object, the method returns the value for only the link on which you have installed the rate control object.

Attributes

Abstract	false
Access	public

To learn about attributes of methods, see Method Attributes.

Version History

Introduced in R2026a