Constify X509_SIG.

[openssl.git] / doc / crypto / X509_SIG_get0.pod

diff --git a/doc/crypto/X509_SIG_get0.pod b/doc/crypto/X509_SIG_get0.pod
index 1d61497c1c6a470787e4d678d1591801d21edfa5..a47ae448cc99155087b20e9357b93441069a05a3 100644 (file)
--- a/doc/crypto/X509_SIG_get0.pod
+++ b/doc/crypto/X509_SIG_get0.pod
@@ -2,19 +2,23 @@
 
 =head1 NAME
 
-X509_SIG_get0 - Get DigestInfo functions
+X509_SIG_get0, X509_SIG_get0_mutable - DigestInfo functions
 
 =head1 SYNOPSIS
 
  #include <openssl/x509.h>
 
- void X509_SIG_get0(X509_ALGOR **palg, ASN1_OCTET_STRING **pdigest,
-                    X509_SIG *sig);
+ void X509_SIG_get0(const X509_SIG *sig, const X509_ALGOR **palg,
+                    const ASN1_OCTET_STRING **pdigest);
+ void X509_SIG_get0_mutable(X509_SIG *sig, X509_ALGOR **palg,
+                            ASN1_OCTET_STRING **pdigest,
 
 =head1 DESCRIPTION
 
 X509_SIG_get0() returns pointers to the algorithm identifier and digest
-value in B<sig>. These values can then be examined or initialised.
+value in B<sig>. X509_SIG_get0_mutable() is identical to X509_SIG_get0()
+except the pointers returned are not constant and can be modified:
+for example to initialise them.
 
 =head1 SEE ALSO