matlab.mpm.PackageIdentifier

Package Identifier

Since R2026a

Description

A matlab.mpm.PackageIdentifier object stores package identifying information (including Name, Version, and UUID) for a single installed package. For more information about how MATLAB uses this information, see Distinguish Between Packages Using Package Identifiers.

Creation

There are two ways to create a matlab.mpm.PackageIdentifier object:

• PackageIdentifier function — Use this function to create a package identifier by specifying a matlab.mpm.Package object.

• matlab.mpm.PackageIdentifier function (described below) — Use this function to create a package identifier by specifying the package name, version, and UUID.

pkgid = PackageIdentifier(pkg)

Syntax

pkgid = matlab.mpm.PackageIdentifier(name,semver,id)

Description

pkgid = matlab.mpm.PackageIdentifier(name,semver,id) creates a package identifier using the specified information.

Input Arguments

name — Package name

string scalar | character vector

Package name, specified as a string scalar or character vector containing the name of the package. name must be a valid MATLAB identifier.

This argument sets the Name property.

semver — Package version

string scalar | character vector | matlab.mpm.Version object

Package version, specified as a string scalar or character vector containing a semantic version, or a matlab.mpm.Version object.

Version syntax follows the Semantic Versioning 2.0.0 format: <major version>.<minor version>.<patch version>, where each version number must be a nonnegative integer, for example 1.2.3. You can optionally specify a pre-release version by adding -<pre-release version> to the end of the version, for example, 1.2.3-alpha. Optionally specify a build version by adding +<build version>.

This argument sets the Version property

id — Package UUID

string scalar | character vector

Package UUID, specified as a string scalar or character vector containing a universally unique identifier (UUID).

This argument sets the ID property

Output Arguments

pkgid — Package identifier

matlab.mpm.PackageIdentifier object

Package identifier, returned as a matlab.mpm.PackageIdentifier object.

Properties

Name — Package name

Read-only: string scalar

This property is read-only.

Package name, represented as a string scalar containing the name of the package.

Version — Package version

Read-only: matlab.mpm.Version object

This property is read-only.

Package version, represented as a string scalar containing a semantic version or matlab.mpm.Version object.

ID — Package UUID

Read-only: string scalar

This property is read-only.

Package UUID, returned as a string scalar containing a universally unique identifier (UUID).

Examples

Create Package Identifier

Create a package identifier for a package named MyPackage.

pkgid = matlab.mpm.PackageIdentifier("MyPackage","1.0.0","bf479616-a9ff-47a5-a2ba-076ee4e2f297")

pkgid = 

  PackageIdentifier with properties:

       Name: "MyPackage"
    Version: 1.0.0 (1×1 Version)
         ID: "bf479616-a9ff-47a5-a2ba-076ee4e2f297"

Version History

Introduced in R2026a