Main Content

prodserver.addon.installFolder

Path to installation folder of MATLAB Production Server add-on

    Description

    example

    path = prodserver.addon.installFolder(name,host,port) returns the full path to the folder on a local machine where a MATLAB® Production Server™ add-on is installed. If the add-on is not present on the local machine, the function returns an empty string. The server does not have to be active for the function to return the path to the installation folder.

    This function requires MATLAB Client for MATLAB Production Server.

    example

    path = prodserver.addon.installFolder(name,host,port,'TransportLayerSecurity',tf) additionally specifies a URI scheme (HTTP or HTTPS) when specifying the server address.

    example

    path = prodserver.addon.installFolder(name,endpoint) specifies a network address endpoint for the server instance.

    Examples

    collapse all

    Get the full path to an installed add-on from a server that uses the default HTTP scheme.

    Install the fractal add-on from a server running at IP address 10.2.2.5 and port 57142. Get the path to the fractal add-on.

    path = prodserver.addon.installFolder('fractal','10.2.2.5',57142)
    path = 
    
        "C:\Users\username\AppData\Roaming\MathWorks\MATLAB Add-Ons\Toolboxes\fractal_ Hosted by MATLAB Production Server"

    Get the full path to an installed add-on from a server that uses the HTTPS scheme.

    Install the fractal add-on from a server using HTTPS, and running at IP address 10.2.2.5 and port 57144. Get the path to the fractal add-on.

    path = prodserver.addon.installFolder('fractal','10.2.2.5',57144,'TransportLayerSecurity',true)
    path = 
    
        "C:\Users\username\AppData\Roaming\MathWorks\MATLAB Add-Ons\Toolboxes\fractal_ Hosted by MATLAB Production Server(2)"

    Get the full path to an installed add-on by specifying the network address of the server from which it was installed.

    Install the fractal add-on from a server running at IP address 10.2.2.5 and port 57142.

    Get the path to the fractal add-on.

    path = prodserver.addon.installFolder('fractal','http://10.2.2.5:57142')
    path = 
    
        "C:\Users\username\AppData\Roaming\MathWorks\MATLAB Add-Ons\Toolboxes\fractal_ Hosted by MATLAB Production Server"

    Input Arguments

    collapse all

    Name of the MATLAB Production Server add-on, specified as a character vector or string scalar.

    Example: 'fractal'

    Data Types: char | string

    Host name of the server hosting a deployable archive from which the add-on is installed, specified as a character vector or string scalar.

    Example: '144.213.5.7'

    Data Types: char | string

    Port number of the server hosting a deployable archive from which the add-on is installed, specified as a positive scalar.

    Example: 9920

    Data Types: uint8 | uint16

    Network address of the server hosting a deployable archive from which the add-on is installed, specified as a character vector or string scalar. The network address has the format scheme://host_name_of_server:port_number.

    Example: 'https://144.213.5.7:9920'

    Data Types: char | string

    Flag to set the URI scheme that the add-on uses when communicating with a server, specified as a logical scalar. If you do not set tf or if you set tf to false, the function uses HTTP. If you set tf to true, the function uses HTTPS.

    Example: true

    Data Types: logical

    Introduced in R2020b