mpiSqNodeDriveMapParamCount

Declaration

int32_t mpiSqNodeDriveMapParamCount (MPISqNode    sqNode,
                                  MPIDriveMap  driveMap,
                                  int32_t         driveIndex,
                                  int32_t         *paramsCount);

Required Header: stdmpi.h

Description

mpiSqNodeDriveMapParamCount scans the drive map file for a drive entry that matches this node on the network. If an entry is found, then this function returns the number of drive parameters that need to be preserved for the configuration of the drive.

This function is normally used with the mpiSqNodeDriveMapParamList(...) function. First, this function is called in order to get the size of the drive parameter list. Then the user can use this size to allocate enough memory to hold the complete parameter list before calling mpiSqNodeDriveMapParamList(...) to fill in the 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 pointer to the variable that will be set by this function.
Return Values
MPIMessageOK

See Also

mpiSqNodeDriveMapParamList