mpiLicenseInfoTextFree

Declaration

MPI_DECL1 MPI_RESULT MPI_DECL2 
   mpiLicenseInfoTextFree (const char **infoText)

 

Required Header: stdmpi.h

Change History: Added in 04.00.

Description

mpiLicenseInfoTextFree deletes the infomation text string and sets *infoText to NULL

Note: mpiLicenseInfoTextFree is a wrapper for mpiControlVersionTextFree.

**infoText A pointer to the information text string to be freed.
Return Values
MPIMessageOK
MPIMessageNO_MEMORY
MPIMessageHANDLE_INVALID

Sample Code

 const char      *infoText = 0;

 // Display runtime license information 
 returnValue = mpiLicenseInfoText(control, &infoText);

 if (versionText != 0) {
   mpiPlatformConsole("%s\n", infoText);
 }
 
 if (returnValue == MPIMessageOK) {
   returnValue = mpiLicenseInfoTextFree(&infoText);
 }

See Also

mpiLicenseInfoText | mpiControlVersionTextFree