Edit

ICertificate2::Load method

  • Article

[CAPICOM is a 32-bit only component that is available for use in the following operating systems: Windows Server 2008, Windows Vista, and Windows XP. Instead, use the X509Certificate2 Class in the System.Security.Cryptography.X509Certificates namespace.]

The Load method imports a certificate from a file. This method was introduced in CAPICOM 2.0.

Syntax

Certificate.Load( _
  ByVal FileName, _
  [ ByVal Password ], _
  [ ByVal KeyStorageFlag ], _
  [ ByVal KeyLocation ] _
)

Parameters

FileName [in]

A string that contains the path to a .cer or .pfx file that contains the certificate data.

Password [in, optional]

A string that contains the plaintext password to the private key file. The password can contain up to 32 Unicode characters, including a terminating null character. For information about protecting the password, see Handling Passwords.

KeyStorageFlag [in, optional]

A value of the CAPICOM_KEY_STORAGE_FLAG enumeration that defines key storage flags. The default is CAPICOM_KEY_STORAGE_DEFAULT. The following table shows the possible values.

Value Meaning
CAPICOM_KEY_STORAGE_DEFAULT
 Default key storage.
CAPICOM_KEY_STORAGE_EXPORTABLE
 The key is exportable.
CAPICOM_KEY_STORAGE_USER_PROTECTED
 The key is user protected.

 

KeyLocation [in, optional]

A value of the CAPICOM_KEY_LOCATION enumeration that defines key location types. The default value is CAPICOM_CURRENT_USER_KEY. The following table shows the possible values.

Value Meaning
CAPICOM_CURRENT_USER_KEY
 The key is a user key.
CAPICOM_LOCAL_MACHINE_KEY
 The key is a machine key.

 

Return value

This method does not return a value.

Remarks

This method raises CAPICOM_E_NOT_ALLOWED when it is scripted from a web-based application.

Requirements

Requirement Value
End of client support
 Windows Vista
End of server support
 Windows Server 2008
Redistributable
 CAPICOM 2.0 or later on Windows Server 2003 and Windows XP
DLL
Capicom.dll