CellularApnContext CellularApnContext CellularApnContext CellularApnContext Class

This class contains properties used to specify an Access Point Name (APN) for a 3GPP based cellular Data Connection (PDP context). A CellularApnContext object is passed with a AcquireConnectionAsync(CellularApnContext) call to establish a connection to a specific access point.

Syntax

Declaration

public sealed class CellularApnContextpublic sealed class CellularApnContextPublic NotInheritable Class CellularApnContextpublic sealed class CellularApnContext

Constructors summary

Creates an instance of CellularApnContext.

Properties summary

Indicates the name of the access point to establish a connection with.

Indicates the authentication method, as defined by CellularApnAuthenticationType, that is used by the access point.

Indicates if data compression will be used at the data link for header and data transfer.

Indicates the password used to authenticate when connecting to the access point.

Indicates the provider ID associated with the access point.

Indicates the user name used to authenticate when connecting to the access point.

Constructors

  • CellularApnContext()
    CellularApnContext()
    CellularApnContext()
    CellularApnContext()

    Creates an instance of CellularApnContext.

    public CellularApnContext()public New()Public Sub New()public CellularApnContext()

Properties

  • AccessPointName
    AccessPointName
    AccessPointName
    AccessPointName

    Indicates the name of the access point to establish a connection with.

    public string AccessPointName { get; set; }public string AccessPointName { get; set; }Public ReadWrite Property AccessPointName As stringpublic string AccessPointName { get; set; }

    Property Value

    • string
      string
      string
      string

      The access point name.

  • AuthenticationType
    AuthenticationType
    AuthenticationType
    AuthenticationType

    Indicates the authentication method, as defined by CellularApnAuthenticationType, that is used by the access point.

    public CellularApnAuthenticationType AuthenticationType { get; set; }public CellularApnAuthenticationType AuthenticationType { get; set; }Public ReadWrite Property AuthenticationType As CellularApnAuthenticationTypepublic CellularApnAuthenticationType AuthenticationType { get; set; }

    Property Value

    Remarks

    This property can have one of the following values:

    ValueDescription
    NONENo authentication protocol.
    PAPUnencrypted password authentication.
    CHAPChallenge Handshake Authentication Protocol(CHAP).
    MsCHAPv2Use Microsoft’s Challenge Handshake Authentication Protocol(CHAP) v2.0.

  • IsCompressionEnabled
    IsCompressionEnabled
    IsCompressionEnabled
    IsCompressionEnabled

    Indicates if data compression will be used at the data link for header and data transfer.

    public bool IsCompressionEnabled { get; set; }public bool IsCompressionEnabled { get; set; }Public ReadWrite Property IsCompressionEnabled As boolpublic bool IsCompressionEnabled { get; set; }

    Property Value

    • bool
      bool
      bool
      bool

      A Boolean value. TRUE if enabled; otherwise FALSE.

  • Password
    Password
    Password
    Password

    Indicates the password used to authenticate when connecting to the access point.

    public string Password { get; set; }public string Password { get; set; }Public ReadWrite Property Password As stringpublic string Password { get; set; }

    Property Value

    • string
      string
      string
      string

      The password associated with the user name.

  • ProviderId
    ProviderId
    ProviderId
    ProviderId

    Indicates the provider ID associated with the access point.

    public string ProviderId { get; set; }public string ProviderId { get; set; }Public ReadWrite Property ProviderId As stringpublic string ProviderId { get; set; }

    Property Value

    • string
      string
      string
      string

      The provider ID.

  • UserName
    UserName
    UserName
    UserName

    Indicates the user name used to authenticate when connecting to the access point.

    public string UserName { get; set; }public string UserName { get; set; }Public ReadWrite Property UserName As stringpublic string UserName { get; set; }

    Property Value

    • string
      string
      string
      string

      The user name.

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ActivatableAttribute
Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.DualApiPartitionAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute

Details

Assembly

Windows.Networking.Connectivity.dll