index.rst (2433B)
1 .. _mozilla_projects_nss_blank_function: 2 3 Function_Name 4 ============= 5 6 .. container:: 7 8 One-line description of what the function does (more than just what it returns). 9 10 `Syntax <#syntax>`__ 11 ~~~~~~~~~~~~~~~~~~~~ 12 13 .. container:: 14 15 .. code:: 16 17 #include <headers.h> 18 ReturnType Function_Name( 19 20 ParamType ParamName, 21 ParamType ParamName, ); 22 23 `Parameters <#parameters>`__ 24 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 25 26 .. container:: 27 28 +---------------+---------------------------------------------------------------------------------+ 29 | ``ParamName`` | Sample: *in* pointer to a `CERTCertDBHandle </en-US/NSS/CERTCertDBHandle>`__ | 30 | | representing the certificate database to look in | 31 +---------------+---------------------------------------------------------------------------------+ 32 | ``ParamName`` | Sample: *in* pointer to an `SECItem </en-US/NSS/SECItem>`__ whose ``type`` must | 33 | | be ``siDERCertBuffer`` and whose ``data`` contains a DER-encoded certificate | 34 +---------------+---------------------------------------------------------------------------------+ 35 36 `Description <#description>`__ 37 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 38 39 .. container:: 40 41 Long description of this function, what it does, and why you would use it. Describe all 42 side-effects on "out" parameters. Avoid describing the return until the next section, for 43 example: 44 45 This function looks in the NSSCryptoContext and the NSSTrustDomain to find the certificate that 46 matches the DER-encoded certificate. A match is found when the issuer and serial number of the 47 DER-encoded certificate are found on a certificate in the certificate database. 48 49 `Returns <#returns>`__ 50 ~~~~~~~~~~~~~~~~~~~~~~ 51 52 .. container:: 53 54 Full description of the return value, for example: 55 56 A pointer to a `CERTCertificate </en-US/NSS/CERTCertificate>`__ representing the certificate in 57 the database that matched the ``derCert``, or ``NULL`` if none was found. The certificate is a 58 shallow copy, use `CERT_DestroyCertificate </en-US/NSS/CERT_DestroyCertificate>`__ to decrement 59 the reference count on the certificate instance. 60 61 .. _see_also: 62 63 `See Also <#see_also>`__ 64 ~~~~~~~~~~~~~~~~~~~~~~~~ 65 66 .. container:: 67 68 Copy of the MXR link, with the following text 69 70 Occurrences of ``Function_Name`` in the current NSS source code (generated by MXR).