mpiLicenseInfoText

Declaration

MPI_DECL1 MPI_RESULT MPI_DECL2 
   mpiLicenseInfoText (MPIControl  control,
                       const char  **infoText)

Required Header: stdmpi.h

Change History: Added in 04.00.

Description

mpiLicenseInfoText reads the runtime license information for the controller such as licensed axis count, expiration date (if any), licensed features, and packages. It also writes the string into the address pointed to by infoText.

Note: mpiControlVersionText is used in the version utility and displays the same information as part of its output.

control	A MPIControl handle for the controller.
**infoText	A pointer to an information text string to which the license information is written.

Return Values
MPIMessageOK
MPIControlMessageOBJECT_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);
 }

mpiLicenseInfoText

Declaration

Description

Sample Code

See Also