CLI 登録方式メソッド

目次
casso1283
目次
Description メソッド - 登録方式の説明を設定または取得
Description メソッドは、登録方式の説明を設定または取得します。
構文
Description メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRegScheme->Description([regDesc])
[Parameters]
Description メソッドは以下のパラメータを受け入れます。
  1. regDesc
    (文字列)
    (オプション)登録方式の説明を指定します。
戻り値
Description メソッドは以下のいずれかの値を返します。
  • 登録方式の新規または既存の説明。
  • コールに失敗した場合は、空の文字列
EnableLogging メソッド - 登録方式のログ記録を有効化または無効化
EnableLogging メソッドは、登録方式のログ記録を有効化または無効化します。
構文
EnableLogging メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRegScheme->EnableLogging([logFlag])
[Parameters]
EnableLogging メソッドは以下のパラメータを受け入れます。
  1. logFlag
    (int)
    (オプション)以下のように、登録方式のログ記録を有効にするかどうかを指定します。
    • 1 はログ記録を有効にします
    • 0 はログ記録を無効にします
戻り値
EnableLogging メソッドは以下のいずれかの値を返します。
  • ログ記録が有効な場合は、1
  • ログ記録が無効な場合は、0
  • コールに失敗する場合は、-1
Name メソッド - 登録方式名を設定または取得
Name メソッドは、登録方式名を設定または取得します。
構文
Name メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRegScheme->Name([regName])
[Parameters]
Name メソッドは、以下のパラメータを受け入れます。
  1. regName
    (文字列)
    (オプション)登録方式名を指定します。
戻り値
Name メソッドは以下のいずれかの値を返します。
  • 新規または既存の登録方式名
  • コールに失敗した場合は、
    undef
TemplatePath メソッド - 登録方式トのパスを設定または取得
TemplatePath メソッドは、登録方式テンプレートのパスを設定または取得します。
構文
TemplatePath メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRegScheme->TemplatePath([path])
[Parameters]
TemplatePath メソッドは、以下のパラメータを受け入れます。
  1. path
    (文字列)
    (オプション)登録方式テンプレートのパスを指定します。
戻り値
TemplatePath メソッドは以下のいずれかの値を返します。
  • 新規または既存のテンプレート パス
  • コールに失敗した場合は、
    undef
UserDirectory メソッド - 登録方式のユーザ ディレクトリを設定または取得
UserDirectory メソッドは、登録方式のユーザ ディレクトリを設定または取得します。
構文
UserDirectory メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRegScheme->UserDirectory([userDir])
[Parameters]
UserDirectory メソッドは、以下のパラメータを受け入れます。
  1. userDir
    (PolicyMgtUserDir)
    (オプション)登録方式のユーザ ディレクトリを指定します。
戻り値
UserDirectory メソッドは以下のいずれかの値を返します。
  • PolicyMgtUserDir オブジェクト
  • コールが失敗した場合またはユーザ ディレクトリが存在しない場合は、
    undef
WelcomePageURL メソッド - 登録方式の[ようこそ]ページ URL を設定または取得
WelcomePageURL メソッドは、登録方式のようこそページ URL を設定または取得します。
構文
WelcomePageURL メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtRegScheme->WelcomePageURL([URL])
[Parameters]
WelcomePageURL メソッドは以下のパラメータを受け入れます。
  1. URL
    (文字列)
    (オプション)登録方式のようこそページ URL を指定します。ユーザは正しく登録した後にこのページにリダイレクトされます。
    形式:
    http://my.acme.com/hr/welcome.htm
戻り値
WelcomePageURL メソッドは以下のいずれかの値を返します。
  • 新規または既存の URL
  • コールに失敗した場合は、
    undef