From df336e545f08102a9415c4b343cb6a388941cf4d Mon Sep 17 00:00:00 2001 From: Simon Rozman Date: Wed, 9 May 2018 17:36:17 +0200 Subject: [PATCH] Update documentation --- README.md | 48 +++++++++++++++++++++++++++--------------------- 1 file changed, 27 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 1749bfd..ddfd057 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,36 @@ # WLANSetEAPUserData + 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). -##Usage + +## Usage + ``` WLANSetEAPUserData ``` -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 -Value | Meaning -------|-------- - 0 | Success (on at least one WLAN interface) - 100 | CommandLineToArgvW() failed - 101 | Not enough arguments - 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 +| Parameter | Explanation | +| --------------- | ----------- | +| `profile` | The name of the network profile (typically 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 + +| Value | Meaning | +| -----:| ------------------------------------------------------------------------------------ | +| 0 | Success (on at least one WLAN interface) | +| 100 | `CommandLineToArgvW()` failed | +| 101 | Not enough arguments | +| 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 |