Update documentation
This commit is contained in:
48
README.md
48
README.md
@@ -1,30 +1,36 @@
|
|||||||
# WLANSetEAPUserData
|
# WLANSetEAPUserData
|
||||||
|
|
||||||
Windows helper utility to set user data for a given WLAN profile
|
Windows helper utility to set user data for a given WLAN profile
|
||||||
|
|
||||||
Binary downloads and change-logs can be found on the [project's release page](https://github.com/rozmansi/WLANSetEAPUserData/releases).
|
Binary downloads and change-logs can be found on the [project's release page](https://github.com/rozmansi/WLANSetEAPUserData/releases).
|
||||||
|
|
||||||
##Usage
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
```
|
```
|
||||||
WLANSetEAPUserData <profile> <flags> <user data URI>
|
WLANSetEAPUserData <profile> <flags> <user data URI>
|
||||||
```
|
```
|
||||||
Parameter | Explanation
|
|
||||||
----------------|------------
|
|
||||||
`profile` | The name of the network profile (not neccessarely the same as SSID)
|
|
||||||
`flags` | Flags to pass to `WlanSetProfileEapXmlUserData()` function call (decimal number: 0=Current User, 1=All Users)
|
|
||||||
`user data URI` | User data XML URI. Can be a path to an XML file, web URL where user data XML can be loaded from, etc. The XML schema varies according to the configured EAP method provider used by `profile`. For example: Microsoft's EAP-TLS requires the schema described in [EAP-TLS User Properties](https://msdn.microsoft.com/en-us/library/windows/desktop/bb204662.aspx).
|
|
||||||
|
|
||||||
##Return codes
|
| Parameter | Explanation |
|
||||||
Value | Meaning
|
| --------------- | ----------- |
|
||||||
------|--------
|
| `profile` | The name of the network profile (typically same as SSID) |
|
||||||
0 | Success (on at least one WLAN interface)
|
| `flags` | Flags to pass to `WlanSetProfileEapXmlUserData()` function call (decimal number: 0=Current User, 1=All Users) |
|
||||||
100 | CommandLineToArgvW() failed
|
| `user data URI` | User data XML URI. Can be a path to an XML file, web URL where user data XML can be loaded from, etc. The XML schema varies according to the configured EAP method provider used by `profile`. For example: Microsoft's EAP-TLS requires the schema described in [EAP-TLS User Properties](https://msdn.microsoft.com/en-us/library/windows/desktop/bb204662.aspx). |
|
||||||
101 | Not enough arguments
|
|
||||||
200 | CoInitialize() failed
|
|
||||||
300 | CoCreateInstance(CLSID_DOMDocument2) failed
|
## Return codes
|
||||||
301 | IXMLDOMDocument::load() failed
|
|
||||||
302 | IXMLDOMDocument::load() reported an error in the XML document
|
| Value | Meaning |
|
||||||
304 | IXMLDOMDocument::get_xml() failed
|
| -----:| ------------------------------------------------------------------------------------ |
|
||||||
400 | WlanOpenHandle() failed
|
| 0 | Success (on at least one WLAN interface) |
|
||||||
401 | WlanEnumInterfaces() failed
|
| 100 | `CommandLineToArgvW()` failed |
|
||||||
402 | WlanSetProfileEapXmlUserData() failed on all WLAN interfaces for the given profile
|
| 101 | Not enough arguments |
|
||||||
403 | No ready WLAN interfaces found
|
| 200 | `CoInitialize()` failed |
|
||||||
|
| 300 | `CoCreateInstance(CLSID_DOMDocument2)` failed |
|
||||||
|
| 301 | `IXMLDOMDocument::load()` failed |
|
||||||
|
| 302 | `IXMLDOMDocument::load()` reported an error in the XML document |
|
||||||
|
| 304 | `IXMLDOMDocument::get_xml()` failed |
|
||||||
|
| 400 | `WlanOpenHandle()` failed |
|
||||||
|
| 401 | `WlanEnumInterfaces()` failed |
|
||||||
|
| 402 | `WlanSetProfileEapXmlUserData()` failed on all WLAN interfaces for the given profile |
|
||||||
|
| 403 | No ready WLAN interfaces found |
|
||||||
|
Reference in New Issue
Block a user