mpiSqNodeSegmentUserDataGet

Declaration

int32_t mpiSqNodeSegmentUserDataGet(MPISqNode                 node,
                                 int32_t                      segment,
                                 MPISqNodeSegmentUserData  *data);

Required Header: stdmpi.h
Change History: Added in the 03.02.00

Description

Modules attached to a SQID node have a small section of non-volatile memory that can be used for any purpose by the user. mpiSqNodeSegmentUserDataGet gets the user data from a segment on a SynqNet node.

node a handle to a SynqNet node object.
segment the index of the slice/module attached to this SynqNet node.
For more information, please see the Overview of MPI I/O.
data a pointer to where the user data is written by this function.
Return Values
MPIMessageOK

Sample Code

The following MPI code reads the contents on the non-volatile memory on segment 0 of node 1:

MPISqNodeSegmentUserData nodeData;
mpiSqNodeSegmentUserDataGet(sqNode1, 0, &nodeData);

See Also

mpiSqNodeSegmentUserDataSet | MPI Overview I/O: User Data | Overview of MPI I/O