mpiSqNodeDriveMapParamList

Declaration

long mpiSqNodeDriveMapParamList (MPISqNode             sqNode,
                                 MPIDriveMap           driveMap,
                                 long                  driveIndex,
                                 long                  paramsCount,
                                 MPIDriveParamInfo     *driveParamInfo);

Required Header: stdmpi.h

Description

mpiSqNodeDriveMapParamList scans the drive map file for an entry that matches the node on the network. If a drive entry is found, this function writes the drive parameter information about each of the drive parameters to the driveParamInfo list.

This function is normally used with the mpiSqNodeDriveMapParamCount(...) function. The mpiSqNodeDriveMapParamCount(...) function is called first to get the size of the parameter list, the user can then use this size to allocate enough memory to hold the complete parameter list before calling this function to fill in the parameter list.

sqNode a handle to a SynqNet node object.
driveMap a handle to a DriveMap object.
driveIndex an index to the drive (0, 1, 2, etc), relative to the node.
paramsCount the number of drive parameter information records that can be written to the driveParamInfo list.
*driveParamInfo pointer to the list of drive parameter information records that will be filled in by this function.
Return Values
MPIMessageOK

See Also

mpiSqNodeDriveMapParamCount