Improve doc about length of strings written

This commit is contained in:
Manuel Pégourié-Gonnard 2015-06-23 12:10:45 +02:00
parent d23f593737
commit e244f9ffc0
4 changed files with 12 additions and 12 deletions

View File

@ -222,8 +222,8 @@ mbedtls_x509_time;
* \param size Maximum size of buffer * \param size Maximum size of buffer
* \param dn The X509 name to represent * \param dn The X509 name to represent
* *
* \return The amount of data written to the buffer, or -1 in * \return The length of the string written (not including the
* case of an error. * terminated nul byte), or a negative error code.
*/ */
int mbedtls_x509_dn_gets( char *buf, size_t size, const mbedtls_x509_name *dn ); int mbedtls_x509_dn_gets( char *buf, size_t size, const mbedtls_x509_name *dn );
@ -235,8 +235,8 @@ int mbedtls_x509_dn_gets( char *buf, size_t size, const mbedtls_x509_name *dn );
* \param size Maximum size of buffer * \param size Maximum size of buffer
* \param serial The X509 serial to represent * \param serial The X509 serial to represent
* *
* \return The amount of data written to the buffer, or -1 in * \return The length of the string written (not including the
* case of an error. * terminated nul byte), or a negative error code.
*/ */
int mbedtls_x509_serial_gets( char *buf, size_t size, const mbedtls_x509_buf *serial ); int mbedtls_x509_serial_gets( char *buf, size_t size, const mbedtls_x509_buf *serial );

View File

@ -143,8 +143,8 @@ int mbedtls_x509_crl_parse_file( mbedtls_x509_crl *chain, const char *path );
* \param prefix A line prefix * \param prefix A line prefix
* \param crl The X509 CRL to represent * \param crl The X509 CRL to represent
* *
* \return The amount of data written to the buffer, or -1 in * \return The length of the string written (not including the
* case of an error. * terminated nul byte), or a negative error code.
*/ */
int mbedtls_x509_crl_info( char *buf, size_t size, const char *prefix, int mbedtls_x509_crl_info( char *buf, size_t size, const char *prefix,
const mbedtls_x509_crl *crl ); const mbedtls_x509_crl *crl );

View File

@ -228,8 +228,8 @@ int mbedtls_x509_crt_parse_path( mbedtls_x509_crt *chain, const char *path );
* \param prefix A line prefix * \param prefix A line prefix
* \param crt The X509 certificate to represent * \param crt The X509 certificate to represent
* *
* \return The amount of data written to the buffer, or -1 in * \return The length of the string written (not including the
* case of an error. * terminated nul byte), or a negative error code.
*/ */
int mbedtls_x509_crt_info( char *buf, size_t size, const char *prefix, int mbedtls_x509_crt_info( char *buf, size_t size, const char *prefix,
const mbedtls_x509_crt *crt ); const mbedtls_x509_crt *crt );
@ -243,8 +243,8 @@ int mbedtls_x509_crt_info( char *buf, size_t size, const char *prefix,
* \param prefix A line prefix * \param prefix A line prefix
* \param flags Verification flags created by mbedtls_x509_crt_verify() * \param flags Verification flags created by mbedtls_x509_crt_verify()
* *
* \return The amount of data written to the buffer, or -1 in * \return The length of the string written (not including the
* case of an error. * terminated nul byte), or a negative error code.
*/ */
int mbedtls_x509_crt_verify_info( char *buf, size_t size, const char *prefix, int mbedtls_x509_crt_verify_info( char *buf, size_t size, const char *prefix,
uint32_t flags ); uint32_t flags );

View File

@ -126,8 +126,8 @@ int mbedtls_x509_csr_parse_file( mbedtls_x509_csr *csr, const char *path );
* \param prefix A line prefix * \param prefix A line prefix
* \param csr The X509 CSR to represent * \param csr The X509 CSR to represent
* *
* \return The length of the string written (exluding the terminating * \return The length of the string written (not including the
* null byte), or a negative value in case of an error. * terminated nul byte), or a negative error code.
*/ */
int mbedtls_x509_csr_info( char *buf, size_t size, const char *prefix, int mbedtls_x509_csr_info( char *buf, size_t size, const char *prefix,
const mbedtls_x509_csr *csr ); const mbedtls_x509_csr *csr );