build_msg2db_index_path()

build_msg2db_index_path()#

build_msg2db_index_path() constructs a file system path for a message database index using the provided database name, topic name, and key.

Prototype

char *build_msg2db_index_path(
    char       *bf,
    int         bfsize,
    const char *msg2db_name,
    const char *topic_name,
    const char *key
);

Parameters

Key

Type

Description

bf

char *

Buffer to store the constructed path.

bfsize

int

Size of the buffer bf in bytes.

msg2db_name

const char *

Name of the message database.

topic_name

const char *

Name of the topic within the message database.

key

const char *

Key used to generate the index path.


Return Value

Returns a pointer to bf containing the constructed index path.

Notes

Ensure that bf has sufficient space (bfsize) to store the generated path to prevent buffer overflows.

Prototype

// Not applicable in JS

Prototype

# Not applicable in Python
Examples
// TODO C examples
// TODO JS examples
# TODO Python examples