wclWiFiClientEnumBss Method |
The method retrieves a list of the basic service set (BSS)
entries of the wireless network or networks on a given wireless
LAN interface.
Namespace: wclWiFiAssembly: wclWiFiFramework (in wclWiFiFramework.dll) Version: 7.13.1.0 (7.13.1.0)
Syntaxpublic int EnumBss(
Guid IfaceId,
string Ssid,
wclWiFiBssType BssType,
bool SecurityEnabled,
out wclWiFiBss[] BssList
)
Public Function EnumBss (
IfaceId As Guid,
Ssid As String,
BssType As wclWiFiBssType,
SecurityEnabled As Boolean,
<OutAttribute> ByRef BssList As wclWiFiBss()
) As Integer
public:
int EnumBss(
Guid IfaceId,
String^ Ssid,
wclWiFiBssType BssType,
bool SecurityEnabled,
[OutAttribute] array<wclWiFiBss>^% BssList
)
Parameters
- IfaceId Guid
- The Wireless LAN interface's ID to
be queried.
- Ssid String
The SSID of the network from which the BSS
list is requested. This parameter is optional. When set to the empty
string, the returned list contains all of available BSS entries on a
wireless LAN interface.
In addition, the BssType parameter must be set to either
bssInfrastructure or bssindependent and the
SecurityEnabled parameter must be specified.
- BssType wclWiFiBssType
- The BSS type of the network. This parameter is
ignored if the SSID of the network for the BSS list is unspecified
(the Ssid parameter is the empty string).
- SecurityEnabled Boolean
- A value that indicates whether security
is enabled on the network. This parameter is only valid when the SSID
of the network for the BSS list is specified (the Ssid
parameter is not an empty string).
- BssList wclWiFiBss
- A storage to receive the returned list of of BSS
entries. The caller is responsible to dispose the allocated
memory.
Return Value
Int32 If the function succeed the return value is
WCL_E_SUCCESS. Otherwise the method returns one of
the WCL error codes.
Remarks The caller is responsible to despose the memory allocated for
the dynamic array contains the BSS list.
See Also