ProvisioningAgent.ProvisionFromXmlDocumentAsync(String) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provisions a device for network connectivity asynchronously, based on the supplied XML document.
Note
This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators.
If you want to use this API and publish your app to the Microsoft Store, then you'll need special approval. For more information, see the Restricted capabilities section in the App capability declarations topic.
public:
virtual IAsyncOperation<ProvisionFromXmlDocumentResults ^> ^ ProvisionFromXmlDocumentAsync(Platform::String ^ provisioningXmlDocument) = ProvisionFromXmlDocumentAsync;/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<ProvisionFromXmlDocumentResults> ProvisionFromXmlDocumentAsync(winrt::hstring const& provisioningXmlDocument);[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<ProvisionFromXmlDocumentResults> ProvisionFromXmlDocumentAsync(string provisioningXmlDocument);function provisionFromXmlDocumentAsync(provisioningXmlDocument)Public Function ProvisionFromXmlDocumentAsync (provisioningXmlDocument As String) As IAsyncOperation(Of ProvisionFromXmlDocumentResults)Parameters
- provisioningXmlDocument
-
String
Platform::String
winrt::hstring
An instance of CarrierControlSchema that contains the network connectivity provisioning information.
Returns
An asynchronous handler to start the provisioning attempt and track its completion.
- Attributes
Windows requirements
| App capabilities |
cellularDeviceControl
networkConnectionManagerProvisioning
networkDataPlanProvisioning
cellularDeviceIdentity
|
Remarks
You can retrieve the results of the provisioning attempt using the ProvisionResultsXml method when the provisioning attempt has completed.
ProvisionFromXmlDocumentAsync returns critical errors as HRESULTs that are then translated into exceptions. The most common HRESULTs returned are listed below:
| Name | HRESULT | Description |
|---|---|---|
| E_ACCESSDENIED | 0x80070005L | Caller is an operator app, but attempted to provision a different operator’s profiles |
| PROVCORE_E_XML_MALFORMED | 0x82170001 | Provisioning file is not well-formed XML |
| PROVCORE_E_XML_INVALID | 0x82170002 | Provisioning file does not conform to schema |
| PROVCORE_E_XML_SIGNATURE_INVALID | 0x82170003 | Provisioning file signature is invalid |
| PROVCORE_E_XML_SIGNATURE_UNTRUSTED | 0x82170004 | Signing certificate is not chained to a trusted root CA |
| PROVCORE_E_XML_DIGEST_INVALID | 0x82170005 | Provisioning file was modified after being signed |
| PROVCORE_E_XML_SIGNER_UNTRUSTED | 0x82170006 | User did not approve provisioning from this certificate. |
| PROVCORE_E_NO_LEAF_CERT | 0x82170007 | No leaf certificate was included in XML signature |
| PROVCORE_E_SIGNING_CERTIFICATE_INVALID_FOR_SIGNING | 0x8217000D | Signing certificate does not meet requirements (Extended Validation, digital signature usage) |
| PROVCORE_E_XML_MISSING_SIGNATURE | 0x8217000E | XML was not signed (and caller was not a mobile broadband operator app) |