Add path to examples folder.

addpath(fullfile(matlabroot,'extern','examples','shrlib'))

Display functions in library.

if not(libisloaded('shrlibsample'))
    loadlibrary('shrlibsample')
end
libfunctions('shrlibsample')

Functions in library shrlibsample:

addDoubleRef              exportedDoubleValue       printExportedDoubleValue  
addMixedTypes             getListOfStrings          readEnum                  
addStructByRef            multDoubleArray           stringToUpper             
addStructFields           multDoubleRef             
allocateStruct            multiplyShort             
deallocateStruct          print2darray              

Clean up.

unloadlibrary shrlibsample

Suppose that you have a library, mylib, with the header file, mylib.h. The header file contains the statement, #include header2.h. To use functions defined in header2.h, call loadlibrary with the addheader option.

loadlibrary('mylib','mylib.h','addheader','header2')

if libisloaded('shrlibsample')
    unloadlibrary('shrlibsample')
else
    addpath(fullfile(matlabroot,'extern','examples','shrlib'))
end

Create an alias name lib for library shrlibsample.

loadlibrary('shrlibsample','shrlibsample.h','alias','lib')

Call function stringToUpper using the alias name.

str = 'This was a Mixed Case string';
calllib('lib','stringToUpper',str)

ans =

THIS WAS A MIXED CASE STRING

Clean up.

unloadlibrary lib

Add path to folder containing shrlibsample and its header file, shrlibsample.h.

addpath(fullfile(matlabroot,'extern','examples','shrlib'))

The shrlibsample.h header file includes the header file, shrhelp.h. If shrhelp.h is in a different folder, for example, c:\work, use the 'includepath' option to tell MATLAB where to find the file.

loadlibrary('shrlibsample','shrlibsample.h','includepath','c:\work')

Cleanup.

unloadlibrary shrlibsample

This example shows how to replace the mxGetNumberOfDimensions function name in the MATLAB Matrix Library API with a shorter alias name, mxGetDims. To define the alias name, create a prototype file then load the library using the prototype file as the header file.

Use a folder for which you have write-access.

cd('c:\work')

Create a prototype file, mxproto.m.

hfile = fullfile(matlabroot,'extern','include','matrix.h');
[notfound,warnings] = loadlibrary('libmx',hfile,'mfilename','mxproto')

MATLAB creates the prototype file in the current folder. Ignore the warning message, Type 'longdouble' was not found.

Add the alias name to the prototype file. Open the file in MATLAB Editor.

edit mxproto.m

Search for the function mxGetNumberOfDimensions.

The following command assigns the alias mxGetDims.

fcns.alias{fcnNum}='mxGetDims';

Add the command to the line before the command to increment fcnNum. The new function prototype, with the new command shown in bold, looks like the following:

fcns.name{fcnNum}='mxGetNumberOfDimensions'; 
fcns.calltype{fcnNum}='cdecl';
fcns.LHS{fcnNum}='int32'; 
fcns.RHS{fcnNum}={'MATLAB array'};
fcns.alias{fcnNum}='mxGetDims'; % Alias defined
fcnNum=fcnNum+1; % Increment fcnNum

Reload libmx using the prototype file.

unloadlibrary libmx
loadlibrary('libmx',@mxproto)

Call the function by its alias name.

y = rand(4,7,2);
calllib('libmx','mxGetDims',y)

ans =
     3

Cleanup.

unloadlibrary shrlibsample