ESim class usage and instantiation

Verica Radulovic 5

Hello.

I need to instantiate the ESim class to be able to use it for the purpose of profile handling.

I am trying to run the UWP application from Visual Studio 2022 and to instantiate ESimWatcher using ESimManager.TryCreateESimWatcher() method. This method returns NULL.

The device I am running the application on has an ESim component.

How can I get my application to have a valid instance of ESim class that I can use to call methods like GetProfiles() etc?

I need an actual example of how to instantiate the ESim object that I would use to call these methods.

And, please, do not point me to the documentation examples. They didn't help me much so far.

Thanks in advance for any assistance.

Junjie Zhu - MSFT 18,736 Reputation points Microsoft Vendor

2023-11-01T03:11:50.6833333+00:00

Hi @Verica Radulovic ,

Welcome to Microsoft Q&A!

Using TryCreateESimWatcher to instantiate ESim and obtain the profile, this is the right direction. But now you can't get the correct return value. According to the document, if the caller's user security identifier (SID) is not authorized by the Windows service that handles eSIM-related operation requests, ESimManager.TryCreateESimWatcher() method will return null.

Have you checked custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe ?

Thank you.
Verica Radulovic 5 Reputation points

2023-11-01T06:27:59.9233333+00:00

Hi @Junjie Zhu - MSFT

Thanks for the reply.

I tried adding specified custom capability but my project won't build when I do.

I get an error The system failed to register the Windows capability extension due to the following error: The system cannot find the file specified.

I added capability using

<uap4:CustomCapability Name="Microsoft.eSIMManagement_8wekyb3d8bbwe"/>

Now, I am running the application in Debug mode from Visual Studio on a Windows 11 machine.

I don't know if I have to set up my development environment somewhat differently in this case.

How does the user SID become authorized to handle eSIM operation requests?

Thanks again for any help.

Regards,

Verica

Junjie Zhu - MSFT 18,736 Microsoft Vendor

<Package
  xmlns="http://schemas.microsoft.com/appx/manifest/foundation/windows10"
  xmlns:mp="http://schemas.microsoft.com/appx/2014/phone/manifest"
  xmlns:uap="http://schemas.microsoft.com/appx/manifest/uap/windows10"
  xmlns:uap4="http://schemas.microsoft.com/appx/manifest/uap/windows10/4"
  IgnorableNamespaces="uap mp uap4">
...
  <Capabilities>     
    <Capability Name="internetClient" />     
    <uap4:CustomCapability Name="Microsoft.eSIMManagement_8wekyb3d8bbwe"/>   
  </Capabilities> 
</Package>

I can build the project, you can refer to the XAML code above.

Verica Radulovic 5 Reputation points

2023-11-01T09:17:35.48+00:00

Hi @Junjie Zhu - MSFT.

Thanks for replying again.

I have done exactly the same thing and that is where I get the error.

I hope this can help clarify an issue.

Thanks for helping.

Regards,

Verica
Junjie Zhu - MSFT 18,736 Reputation points Microsoft Vendor

2023-11-01T10:06:42.4933333+00:00

Hi @Verica Radulovic ,

If you create a blank UWP project and then add this CustomCapability, can the same problem be reproduced?
Verica Radulovic 5 Reputation points

2023-11-01T10:13:49.8433333+00:00

Hi @Junjie Zhu - MSFT.

I created a new empty project and added capability. Same error as with the previous project.

So, there must be something missing from the machine itself.

Thanks again for any help.

Regards,

Verica
Junjie Zhu - MSFT 18,736 Reputation points Microsoft Vendor

2023-11-02T07:36:10.91+00:00

Hi @Verica Radulovic ,

For your scenario, I suggest that you might need to open a support ticket for this. Please contact our paid support at MS Support.

You will get 1:1 support on that. Select Developer Tools -> Windows UWP Development -> Windows 10 Universal App Dev -> System Services Development-> Networking API in the support page and you could contact the team. Please kindly note that your support ticket will be free if it is Microsoft's issue.
Yaguang Ruan 20 Reputation points

2024-03-06T01:57:25.1733333+00:00

Hello, excuse me, has this problem been solved in the end?
Verica Radulovic 5 Reputation points

2024-03-11T06:53:10.03+00:00

Hi Yaguang.

The problem was solved in the end, thanks to Microsoft support guys. The issue was in the SCCD file and how is the certificate number interpreted.
Yaguang Ruan 20 Reputation points

2024-03-12T06:17:54.7466667+00:00

Hi , Can you tell me exactly what steps to take to fix this?
Deleted

This comment has been deleted due to a violation of our Code of Conduct. The comment was manually reported or identified through automated detection before action was taken. Please refer to our Code of Conduct for more information.

mgal 0

i use this SCCD and succeeded to get the Watcher:

<?xml version="1.0" encoding="utf-8"?>
<CustomCapabilityDescriptor xmlns="http://schemas.microsoft.com/appx/2018/sccd" xmlns:s="http://schemas.microsoft.com/appx/2018/sccd">
	<CustomCapabilities>
		<CustomCapability Name="Microsoft.eSIMManagement_8wekyb3d8bbwe"></CustomCapability>
	</CustomCapabilities>
	<AuthorizedEntities AllowAny="true"/>
	<Catalog>0000</Catalog>
</CustomCapabilityDescriptor>

but still have issues with the Download profile that returns me CardGeneralFailure

  var result = await _eSim.DownloadProfileMetadataAsync("-----");

any idea?

Share via

ESim class usage and instantiation

Your answer