suite_create.3.in 1.2 KB

123456789101112131415161718192021222324252627282930313233343536
  1. .\" Copyright (c) LibCheck, 2001-2020.
  2. .\"
  3. .\" Permission is granted to copy, distribute and/or
  4. .\" modify this document under the terms of the GNU
  5. .\" Free Documentation License, Version 1.3 or any later
  6. .\" version published by the Free Software Foundation; with
  7. .\" no Invariant Sections, no Front-Cover Texts, and no
  8. .\" Back-Cover Texts. A copy of the license is included in
  9. .\" the section entitled "GNU Free Documentation License".
  10. .\"
  11. .TH "suite_create" "3" "" "@PROJECT_VERSION@" "LibCheck"
  12. .SH "PROLOG"
  13. This manual page is part of the Check Programmer's Manual.
  14. Additional information may be found at the Check Library
  15. home page, at https://libcheck.github.io/check/.
  16. .SH "NAME"
  17. suite_create
  18. \(em create test case container object
  19. .SH "SYNOPSIS"
  20. .LP
  21. .nf
  22. #include <check.h>
  23. .P
  24. Suite* suite_create(const char *name);
  25. .SH "DESCRIPTION"
  26. The
  27. \fIsuite_create\fR()
  28. function returns a pointer to a heap-allocated test suite
  29. object.
  30. .SH "RETURN VALUE"
  31. Upon successful completion, the
  32. \fIsuite_create\fR()
  33. function returns a pointer containing the address of the
  34. heap-allocated test suite object. Otherwise, the function
  35. prints an error message to standard error indicating that
  36. something went wrong, and then returns a NULL pointer.