Main Content

license

ライセンス ステータスの取得、ライセンスの有無のテスト、フィーチャー ライセンスのチェックアウト

説明

関数 license を使用すると、使用中のライセンス番号が返されるほか、現在のセッションでチェックアウトされているライセンスの一覧表示、ライセンスに含まれる特定のフィーチャーがチェックアウトされているかどうかの判別、ライセンスに含まれる特定のフィーチャーのチェックアウトを実行できます。ライセンス管理タスクを実行するには (ライセンスの更新方法やそのアクティベーションの停止方法など)、ライセンス管理を参照してください。

license は、現在使用中の MATLAB® のライセンス番号を返します。番号以外の値が返されることもあり、たとえば、MATLAB デモ バージョンの場合は 'demo'、MATLAB Student Version の場合は 'student' が返されます。

license('inuse') は、現在の MATLAB セッションでチェックアウトされたライセンスのリストを表示します。ライセンスのリストは、ライセンス フィーチャー名に基づきアルファベット順に並んでいます。これらの名前は、入力 feature の有効な値と同じです。

S = license('inuse') は、現在のセッションでチェックアウトされたライセンスとユーザーの名前を示す構造体の配列を返します。

S = license('inuse',feature) は、feature が現在の MATLAB セッションでチェックアウトされているかどうかをチェックします。フィーチャーがチェックアウトされている場合、license は、現在のセッションのライセンスの名前とユーザーの名前を返します。それ以外の場合、S のフィールドは空です。

status = license('test',feature) は、feature で指定された値のライセンスが存在するかどうかをテストします。

license('test',feature,toggle) は、toggle の値に応じて feature で指定された値のテストを有効または無効にします。

[status,errmsg] = license('checkout',feature) は、指定されたフィーチャーのライセンスをチェックアウトします。オプションの第 2 出力引数 errmsg を指定すると、チェックアウトが失敗した場合、発生したエラー メッセージのテキストが license によって返されます。

すべて折りたたむ

現在使用中のライセンスのリストを表示します。license はフィーチャーのリストを、使用している構成のライセンス フィーチャー名ごとに、アルファベット順で表示します。

license('inuse')
image_toolbox
map_toolbox
matlab

使用中のライセンスのリストと現在のユーザーの名前を取得します。license は構造体配列を返します。

S = license('inuse');

S の最初の要素を表示します。

S(1)
ans = 

    feature: 'image_toolbox'
       user: 'juser'

MATLAB のライセンスが使用中かどうかを判定します。ライセンスが使用中の場合、S は空でないフィールドの構造体配列です。

S = license('inuse','MATLAB')
S = 

    feature: 'matlab'
       user: 'jsmith'

Mapping Toolbox™ のライセンスが存在するかどうかを判定します。ライセンスが存在する場合、license1 を返します。

status = license('test','MAP_Toolbox')
status =

    1

Control System Toolbox™ のライセンスをチェックアウトします。チェックアウトが正常に完了した場合、出力 status1、出力 errmsg は空になります。

[status,errmsg] = license('checkout','Control_Toolbox')
status =

     1


errmsg =

     ''

入力引数

すべて折りたたむ

ライセンス フィーチャー名。文字ベクトルとして指定します。feature の値では大文字と小文字が区別されません。ライセンス ファイルの INCREMENT 行は有効なフィーチャーを示します。ライセンス ファイルを見つけるには、Where can I find MATLAB license files? を参照してください。

ライセンスの有無をテストする機能。'enable' または 'disable' として指定します。

  • toggle'enable' に指定すると、license('test',feature) 構文はライセンスが存在する場合に 1 を、存在しない場合は 0 を返します。

  • toggle'disable' に指定すると、license('test',feature) 構文は指定されたフィーチャーについて常に 0 (ライセンスなし) を返します。

メモ

特定のライセンスのテストを無効にすると、license コマンドで実行するテストだけではなく、ライセンスの有無に関する他のテストにも影響を与える可能性があります。

出力引数

すべて折りたたむ

チェックアウトされたライセンス。チェックアウトされたライセンスを示す構造体の配列として返されます。構造体には、以下の 2 つのフィールドが含まれます。

  • feature — ライセンス フィーチャー名

  • user — 現在のセッションのユーザーの名前

フィールドが空の場合、ライセンスは現在チェックアウトされていません。

テストまたはチェックアウトのステータス。1 または 0 が返されます。

  • ライセンスの有無をテストしている場合、1 はライセンスが存在することを、0 はライセンスが存在しないことを示します。

    ライセンスが存在していても、そのライセンスをチェックアウトできない場合や、そのライセンスのフィーチャーがインストールされていないこともあります。ライセンスのすべてのキーが使用中の場合でもテストで 1 が返されますが、実際のチェックアウトは失敗します。

  • ライセンスをチェックアウトする場合、1 はチェックアウトに成功したことを、0 は関数 license がライセンスをチェックアウトできなかったことを示します。

ライセンスのチェックアウトに失敗した場合のエラー メッセージ。文字ベクトルとして返されます。チェックアウトが正常に完了した場合、errmsg は空です。

通常、エラー メッセージは問題の解決方法を示します。以下に例を示します。

License checkout failed.
License Manager Error -5
Cannot find a license for FEATURENAME.

Troubleshoot this issue by visiting:
https://www.mathworks.com/support/lme/R2021b/5

表示されるライセンスのチェックアウト エラーは、所有しているライセンスのタイプによって異なります。

ヒント

  • ライセンス タイプ、フィーチャーの使用、有効期限情報など、アカウントにリンクされているすべてのライセンスの詳細については、MathWorks® アカウントにサインインしてください。

  • ライセンス管理タスクを実行するには (ライセンスの更新方法やそのアクティベーションの停止方法など)、ライセンス管理を参照してください。

拡張機能

バージョン履歴

R2006a より前に導入