Update documentation

This commit is contained in:
2018-05-09 17:36:17 +02:00
parent 52a417f351
commit df336e545f

View File

@@ -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
----------------|------------ | 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) | `profile` | The name of the network profile (typically same as SSID) |
`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). | `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 ## Return codes
Value | Meaning
------|-------- | Value | Meaning |
0 | Success (on at least one WLAN interface) | -----:| ------------------------------------------------------------------------------------ |
100 | CommandLineToArgvW() failed | 0 | Success (on at least one WLAN interface) |
101 | Not enough arguments | 100 | `CommandLineToArgvW()` failed |
200 | CoInitialize() failed | 101 | Not enough arguments |
300 | CoCreateInstance(CLSID_DOMDocument2) failed | 200 | `CoInitialize()` failed |
301 | IXMLDOMDocument::load() failed | 300 | `CoCreateInstance(CLSID_DOMDocument2)` failed |
302 | IXMLDOMDocument::load() reported an error in the XML document | 301 | `IXMLDOMDocument::load()` failed |
304 | IXMLDOMDocument::get_xml() failed | 302 | `IXMLDOMDocument::load()` reported an error in the XML document |
400 | WlanOpenHandle() failed | 304 | `IXMLDOMDocument::get_xml()` failed |
401 | WlanEnumInterfaces() failed | 400 | `WlanOpenHandle()` failed |
402 | WlanSetProfileEapXmlUserData() failed on all WLAN interfaces for the given profile | 401 | `WlanEnumInterfaces()` failed |
403 | No ready WLAN interfaces found | 402 | `WlanSetProfileEapXmlUserData()` failed on all WLAN interfaces for the given profile |
| 403 | No ready WLAN interfaces found |