sam_data_restore man page

sam_data_restore — Restore previously saved user data

Synopsis

#include <corosync/sam.h>

cs_error_t sam_data_restore (void *data, size_t size);

Description

The sam_data_restore function is used to restore data, previously saved by calling sam_data_store(3). Such data survives between instances.

The data parameter is pointer to memory initialized by caller. Stored data are copied there. This also means, that caller is responsible for freeing memory.

The size parameter is length of data. This one must be at least same length as previously stored data otherwise error is returned. Parameter can be larger but only stored data size bytes are changed.

Use sam_data_getsize(3) to find out length of stored data.

Return Value

This call return CS_OK value if successful, otherwise and error is returned.

Errors

CS_ERR_BAD_HANDLE
component was not initialized by calling sam_initialize(3) or it was finalized.
CS_ERR_INVALID_PARAM
data parameter is NULL or size is less then currently stored data length

See Also

sam_data_getsize(3), sam_data_store(3)

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 inturrupted by a signal

CS_ERR_NOT_SUPPORTED The requested protocol/functuality not supported

CS_ERR_MESSAGE_ERROR Incorrect auth message received

CS_ERR_NO_MEMORY Not enough memory to completed the requested task

Referenced By

sam_data_getsize(3), sam_data_store(3), sam_overview(8).

04/15/2010 corosync Man Page Corosync Cluster Engine Programmer's Manual