mpiMapStringToPtr
Declaration
MPI_DECL1 MPI_RESULT MPI_DECL2 mpiMapPtrToString(MPIMap mpiMap, const char *addressString, MPIMapPtr *mapPtr);
Required Header: map.h
Change History: Added in 04.00.
Description
mpiMapStringToPtr translates a controller address string to an MPIMapPtr structure. This is useful when restoring configuration information from a file. For more information about valid string formats, see mpiMapPtrToString.
mpiMap | The MPIMap object used to translate addresses. |
---|---|
addressString | A pointer to the address string. |
mapPtr | A pointer to the MPIMapPtr structure where the memory information is to be written. |
Return Values |
---|
MPIMapMessageMAP_INVALID |
MPIMessageARG_INVALID |
MPIMapMessageBAD_ADDRESS_STRING |
MPIMapMessageVERSION_DEPENDENT_STRING |
See Also