From 754bbf7a25a8dda49b5d08ef0d0443bbf5af0e36 Mon Sep 17 00:00:00 2001 From: Craig Jennings Date: Sun, 7 Apr 2024 13:41:34 -0500 Subject: new repository --- devdocs/c/memory%2Fcalloc.html | 62 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 devdocs/c/memory%2Fcalloc.html (limited to 'devdocs/c/memory%2Fcalloc.html') diff --git a/devdocs/c/memory%2Fcalloc.html b/devdocs/c/memory%2Fcalloc.html new file mode 100644 index 00000000..4c0abf87 --- /dev/null +++ b/devdocs/c/memory%2Fcalloc.html @@ -0,0 +1,62 @@ +

calloc

Defined in header <stdlib.h> 
void* calloc( size_t num, size_t size );
+

Allocates memory for an array of num objects of size and initializes all bytes in the allocated storage to zero.

+

If allocation succeeds, returns a pointer to the lowest (first) byte in the allocated memory block that is suitably aligned for any object type with fundamental alignment.

+

If size is zero, the behavior is implementation defined (null pointer may be returned, or some non-null pointer may be returned that may not be used to access storage).

+ + +

calloc is thread-safe: it behaves as though only accessing the memory locations visible through its argument, and not any static storage.

+

A previous call to free or realloc that deallocates a region of memory synchronizes-with a call to calloc that allocates the same or a part of the same region of memory. This synchronization occurs after any access to the memory by the deallocating function and before any access to the memory by calloc. There is a single total order of all allocation and deallocation functions operating on each particular region of memory.

+		 (since C11)

Parameters

+ + +
num - number of objects
size - size of each object

Return value

On success, returns the pointer to the beginning of newly allocated memory. To avoid a memory leak, the returned pointer must be deallocated with free() or realloc().

+

On failure, returns a null pointer.

+

Notes

Due to the alignment requirements, the number of allocated bytes is not necessarily equal to num * size.

+

Initialization to all bits zero does not guarantee that a floating-point or a pointer would be initialized to 0.0 and the null pointer value, respectively (although that is true on all common platforms).

+

Originally (in C89), support for zero size was added to accommodate code such as

+
OBJ* p = calloc(0, sizeof(OBJ)); // "zero-length" placeholder
+...
+while(1)
+{
+    p = realloc(p, c * sizeof(OBJ)); // reallocations until size settles
+    ... // code that may change c or break out of loop
+}

Example

#include <stdio.h>
+#include <stdlib.h>
+ 
+int main(void)
+{
+    int* p1 = calloc(4, sizeof(int));    // allocate and zero out an array of 4 int
+    int* p2 = calloc(1, sizeof(int[4])); // same, naming the array type directly
+    int* p3 = calloc(4, sizeof *p3);     // same, without repeating the type name
+ 
+    if (p2)
+    {
+        for (int n = 0; n < 4; ++n) // print the array
+            printf("p2[%d] == %d\n", n, p2[n]);
+    }
+ 
+    free(p1);
+    free(p2);
+    free(p3);
+}

Output:

+
p2[0] == 0
+p2[1] == 0
+p2[2] == 0
+p2[3] == 0

References

See also

+
C++ documentation for calloc
+

+ © cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
+ https://en.cppreference.com/w/c/memory/calloc +

+
-- cgit v1.2.3