IProvisioningDomain::Add method
Note Wireless Provisioning Services (WPS) is no longer available as of Windows Vista.
The Add method adds XML provisioning information to the client. The provisioning data is added for a domain and languages specified through the Master XML file. Although the Master XML file can define multiple languages, only the provisioning data for languages supported by the client will be added.
Syntax
HRESULT Add(
[in] LPCWSTR pszwPathToFolder
);
Parameters
- pszwPathToFolder [in]
Pointer to a string that identifies the folder containing the XML subfiles. WPS also uses this string to locate the Master XML file.
Return value
If the method succeeds, the return value is 0 (S_OK); otherwise, returns one of the following codes:
| Return code | Description |
|---|---|
| S_FAIL | The XML data could not be added because the domain (as specified in the Master file) already exists in the WPS provisioning store. |
| E_ACCESSDENIED | The method failed due to a permissions problem. |
| E_OUTOFMEMORY | The method was unable to allocate required memory. |
| E_POINTER | A pointer passed as a parameter is not valid. |
Remarks
OEMs will normally use this method to load the XML files directly onto the computer before sending it to the end user.
The Master XML file must be named with the domain of the WISP. For example, if the WISP's domain is MyWISP.com, the Master XML file must be named MyWISP.com.xml. The Master XML data must be in the format defined for the Master schema.
All related subfiles must reside in a folder that is also named with the WISP's domain. This folder must be in the same folder where the Master XML file resides and must have the following directory structure:
The first level contains the language directories. More than one language directory can exist. Each language directory must be named using the format defined in RFC 1766.
Note A language directory for English ( en) subfiles is required. Other language directories are optional.
The second level contains the WPS configuration and EAP-based authentication files. The XML files must be in the format defined for the configuration schemas and connection property schemas.
Only the subfiles identified within the Master XML file will be added to the WPS provisioning store.
The following example is based on the XML data described in Sample Master XML Data. The folder C:\SampleWISP\XMLFiles contains WPS XML files for a WISP named SampleWISP. The WISP's domain name is SampleWISP.com, which is used in the name of the Master XML file as well as the folder containing the subfiles.
These files define the WISP's network connections in both English and Japanese languages:
C:\SampleWISP\XMLFiles\SampleWISP.com.xml
C:\SampleWISP\XMLFiles\SampleWISP.com\en\ssid.xml
C:\SampleWISP\XMLFiles\SampleWISP.com\en\connection.xml
C:\SampleWISP\XMLFiles\SampleWISP.com\en\branding.xml
C:\SampleWISP\XMLFiles\SampleWISP.com\en\locations.xml
C:\SampleWISP\XMLFiles\SampleWISP.com\en\help.xml
C:\SampleWISP\XMLFiles\SampleWISP.com\en\register.xml
C:\SampleWISP\XMLFiles\SampleWISP.com\ja\ssid.xml
C:\SampleWISP\XMLFiles\SampleWISP.com\ja\connection.xml
C:\SampleWISP\XMLFiles\SampleWISP.com\ja\branding.xml
C:\SampleWISP\XMLFiles\SampleWISP.com\ja\locations.xml
C:\SampleWISP\XMLFiles\SampleWISP.com\ja\help.xml
C:\SampleWISP\XMLFiles\SampleWISP.com\ja\register.xml
In this example, when the Add method is called, the pszwPathToFolder parameter points to a string containing "C:\SampleWISP\XMLFiles\SampleWISP.com".
Requirements
Target platform |
Desktop |
Version |
Not available beginning with Windows Vista. |
Header |
Netprov.h (include Netprov.h) |
See also