mpiControlDefaultFile
Definition
MPI_DECL1 MPI_RESULT MPI_DECL2
mpiControlDefaultFile(MPIControl control,
MPIControlFileType fileType,
char *filenameBuffer,
size_t filenameBufferSize,
size_t *requiredSize);
Required Header: stdmpi.h
Change History: Added in 04.00.
Description
mpiControlDefaultFile reports the default file for special controller files.
The minimum size for filenameBuffer can be obtained by calling mpiControlDefaultFile with filenameBuffer set to NULL and filenameBufferSize set to 0.
| control | The controller for which to find the default firmware filenames. |
|---|---|
| fileType | The type of file for which to return a path. |
| filePathBuffer | A buffer to return the path in. |
| filePathBufferSize | The size of filenameBuffer in chars. |
| requiredSize | The minimum required size of filenameBuffer is returned through this pointer. |
| Return Values |
|---|
| MPIMessageUNSUPPORTED |
| MPIMessageARG_INVALID |
| MPIControlMessageBUFFER_TOO_SMALL |
Sample Code
void defaultBinFile (MPIControl control) { MPI_RESULT returnValue; char filenameBuffer[512]; size_t requiredSize; returnValue = mpiControlDefaultFile(control, MPIControlFileTypeFIRMWARE, filenameBuffer, 512, &requiredSize, NULL); msgCHECK(returnValue); } }