mpiLibraryInstallPath

Declaration

MPI_DECL1 MPI_RESULT MPI_DECL2
   mpiLibraryInstallPath(char       *installPath,
                         size_t     installPathBufferSize,
                         size_t     *requiredSize,
                         const char *additionalDirectories);

Required Header: stdmpi.h

Change History: Added in 04.00.

Description

mpiLibraryInstallPath returns the path to the directory where the MPI is installed. It also returns the size of the buffer necessary to hold the path.

installPath	If not NULL, then the installation directory is returned in this buffer.
installPathBufferSize	The size of the installPath buffer.
requiredSize	If not NULL, the size of the buffer necessary to return the installation path.
additionalDirectories	If not NULL, then include these directories in the search for the MPI installation directory. Allowable text is in the same format as the PATH environment variable. This argument specifies possible locations of the MPI application directory (MPI_Install_Dir\Win32 on Windows). The argument is not used if either of the MPI_MDK_DIR environment variables are set. For customer applications, this argument would normally be NULL.

Return Values
MPIMessageARG_INVALID
MPIPlatformMessageINSTALL_VARIABLE_NOT_SET
MPIPlatformMessagePATH_DOES_NOT_EXIST
MPIPlatformMessagePATH_IS_NOT_A_DIRECTORY

Sample Code

char           buffer[512];
MPI_RESULT     returnValue =
               mpiLibraryInstallPath(
                  buffer,
                  512,
                  NULL,
                  NULL);