Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

CngUIPolicy Class

Encapsulates optional configuration parameters for the user interface (UI) that Cryptography Next Generation (CNG) displays when you access a protected key.

System.Object
  System.Security.Cryptography.CngUIPolicy

Namespace:  System.Security.Cryptography
Assembly:  System.Core (in System.Core.dll)
[HostProtectionAttribute(SecurityAction.LinkDemand, MayLeakOnAbort = true)]
public sealed class CngUIPolicy

The CngUIPolicy type exposes the following members.

  NameDescription
Public methodCngUIPolicy(CngUIProtectionLevels)Initializes a new instance of the CngUIPolicy class by using the specified protection level.
Public methodCngUIPolicy(CngUIProtectionLevels, String)Initializes a new instance of the CngUIPolicy class by using the specified protection level and friendly name.
Public methodCngUIPolicy(CngUIProtectionLevels, String, String)Initializes a new instance of the CngUIPolicy class by using the specified protection level, friendly name, and description.
Public methodCngUIPolicy(CngUIProtectionLevels, String, String, String)Initializes a new instance of the CngUIPolicy class by using the specified protection level, friendly name, description string, and use context.
Public methodCngUIPolicy(CngUIProtectionLevels, String, String, String, String)Initializes a new instance of the CngUIPolicy class by using the specified protection level, friendly name, description string, use context, and title.
Top
  NameDescription
Public propertyCreationTitleGets the title that is displayed by the UI prompt.
Public propertyDescriptionGets the description string that is displayed by the UI prompt.
Public propertyFriendlyNameGets the friendly name that is displayed by the UI prompt.
Public propertyProtectionLevelGets the UI protection level for the key.
Public propertyUseContextGets the description of how the key will be used.
Top
  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

This class enables you to create a UI policy for displaying prompts about key operations such as smart card PIN prompts. It also enables you to enforce user interaction to access a key, even if the key is stored in a software key storage provider (KSP) instead of in a smart card. CNG displays these configuration parameters for the UI when you access a protected key.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: MayLeakOnAbort. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.