man > dmmp_mpath_array_get(3)

man perldoc info pydoc3 ri search

📛 NAME

dmmp_mpath_array_get - Query all existing multipath devices.

🚀 Quick Reference

Use Case	Command	Description
Query all multipath devices	dmmp_mpath_array_get(ctx, &dmmp_mps, &dmmp_mp_count)	Retrieve pointer array of all multipath device objects
Free the array	dmmp_mpath_array_free(dmmp_mps, dmmp_mp_count)	Release memory allocated by the get function

📖 SYNOPSIS

int dmmp_mpath_array_get (struct dmmp_context *ctx, struct dmmp_mpath ***dmmp_mps, uint32_t *dmmp_mp_count);

📥 ARGUMENTS

ctx — Pointer of 'struct dmmp_context'. If this pointer is NULL, your program will be terminated by assert.

dmmp_mps — Output pointer array of 'struct dmmp_mpath'. If this pointer is NULL, your program will be terminated by assert.

dmmp_mp_count — Output pointer of uint32_t. Hold the size of 'dmmp_mps' pointer array. If this pointer is NULL, your program will be terminated by assert.

📝 DESCRIPTION

Query all existing multipath devices and store them into a pointer array. The memory of 'dmmp_mps' should be freed via dmmp_mpath_array_free.

📤 RETURN

int. Valid error codes are:

• ✅ DMMP_OK
• ❌ DMMP_ERR_BUG
• ❌ DMMP_ERR_NO_MEMORY
• ❌ DMMP_ERR_NO_DAEMON
• ❌ DMMP_ERR_INCONSISTENT_DATA

Error number could be converted to string by dmmp_strerror.

🚪 Exit Codes

• ✅ DMMP_OK — Success
• ❌ DMMP_ERR_BUG — Internal bug
• ❌ DMMP_ERR_NO_MEMORY — Memory allocation failure
• ❌ DMMP_ERR_NO_DAEMON — Multipathd daemon not running
• ❌ DMMP_ERR_INCONSISTENT_DATA — Corrupted or inconsistent data

📛 NAME 🚀 Quick Reference 📖 SYNOPSIS 📥 ARGUMENTS 📝 DESCRIPTION 📤 RETURN 🚪 Exit Codes