Discuss this help topic in SecureBlackbox Forum

TElX509Certificate.LoadKeyFromStreamPEM

TElX509Certificate     See also     


Filter: C#/Java  VB.NET  Pascal  C++  PHP  


Reads the certificate's private key from the stream. The key should be contained in PEM format.

Declaration

[C#/Java]
    int LoadKeyFromStreamPEM(System.IO.Stream Stream, string PassPhrase, int Count);

[VB.NET]
    Function LoadKeyFromStreamPEM(ByVal Stream As System.IO.Stream, ByVal PassPhrase As String, ByVal Count As Integer) As Integer

[Pascal]
    function LoadKeyFromStreamPEM(Stream : TStream; PassPhrase : string; Count : integer = 0) : integer;

[C++]
    int32_t LoadKeyFromStreamPEM(TStream &Stream, const std::string &PassPhrase, int32_t Count);
    int32_t LoadKeyFromStreamPEM(TStream *Stream, const std::string &PassPhrase, int32_t Count);

[PHP]
    integer LoadKeyFromStreamPEM(TStream $Stream, string $PassPhrase, integer $Count)

Parameters

  • Stream - The stream from which the private key is loaded.
  • Count - Optional parameter that specified the number of bytes to be read. If this parameter is zero, the whole stream (from current position till the end) is read.
  • PassPhrase - The pass phrase to decrypt the private key. If the key is not encrypted, set this parameter to empty string

Return value

    0 - if the key was successfully loaded.
    Otherwise PEM error code.

Description

    Use this method to read the certificate's private key from the stream. The read operation is started at current stream position and finished when the end of the stream reached or when the number of bytes specified in Count parameter is read. The private key must have been saved in PEM format.

Discuss this help topic in SecureBlackbox Forum