---
name: "cpg_iteration_finalize"
section: "3"
platform: "linux"
package: "libcpg-dev"
version: "3.1.9-2+deb13u1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/cpg_iteration_finalize"
---

# cpg\_iteration\_finalize(3)

Finalize iterator for members of CPG

## NAME

cpg\_iteration\_finalize - Finalize iterator for members of CPG

## SYNOPSIS

**#include \<corosync/cpg.h\>**

**cs\_error\_t** **cpg\_iteration\_finalize (cpg\_iteration\_handle\_t** *handle***);**

## DESCRIPTION

The **cpg\_iteration\_finalize** function is used to free up memory associated with iteration obtained by calling of **[cpg\_iteration\_initialize(3)](/cpg_iteration_initialize/3.md)** function. The *handle* argument is iterator handle obtained by **[cpg\_iteration\_initialize(3)](/cpg_iteration_initialize/3.md)** function.

## RETURN VALUE

This call returns the CS\_OK value if successful. CS\_ERR\_BAD\_HANDLE error is returned when handle is invalid.

## SEE ALSO

[**cpg\_iteration\_initialize**(3)](/cpg_iteration_initialize/3.md), [**cpg\_overview**(3)](/cpg_overview/3.md)

**CS\_ERR\_TRY\_AGAIN** Resource temporarily unavailable

**CS\_ERR\_INVALID\_PARAM** Invalid argument

**CS\_ERR\_ACCESS** Permission denied

**CS\_ERR\_LIBRARY** The connection failed

**CS\_ERR\_INTERRUPT** System call interrupted by a signal

**CS\_ERR\_NOT\_SUPPORTED** The requested protocol/functionality not supported

**CS\_ERR\_MESSAGE\_ERROR** Incorrect auth message received

**CS\_ERR\_NO\_MEMORY** Not enough memory to complete the requested task