3-4-2 ユーザー情報関連

ユーザー情報関連の操作を行うためのAPIについて記載します。

ユーザー情報を取得する

メソッド名 UserInfo GetUserInfo()
戻り値 ユーザー情報(UserInfo)
詳細は「3-5-1 ユーザー情報クラス(userInfo)プロパティ」を参照してください。
例外
  • RdConnectException
    ユーザー情報取得に失敗した場合
使用例
//ユーザー情報を取得
ServiceRef.UdkConnect.userInfo ui = udkConnect.GetUserInfo();

現在ログイン中のユーザー名を取得する

メソッド名 String GetLoginUserName()
戻り値 現在ログイン中のユーザー名
例外
  • RdConnectException
    ユーザー名取得に失敗した場合
使用例
String userName = udkConnect.GetLoginUserName();

ユーザーパスワードを変更する

メソッド名 void ChangeUserPassword( p1, p2 );
パラメーター
  • p1
    String oldPassword(旧パスワード)
  • p2
    String newPassword(新パスワード)
例外
  • RdConnectException
    パスワード変更に失敗した場合
使用例
String oldPassword = "pass123";
String newPassword = "pass456";
UdkConnect.ChangeUserPassword( oldPassword, newPassword );
注意

Active Directory連携で取得したユーザーのパスワードは変更できません。

ユーザー情報を更新する

メソッド名 void UpdateUserInfo( p1 );
パラメーター
例外
  • RdConnectException
    ユーザー情報更新に失敗した場合
使用例
//ユーザー情報を取得
ServiceRef.UdkConnect.userInfo ui = udkConnect.GetUserInfo();
//ユーザー情報の編集
ui.oldPassword = "pass123"; 	// 旧パスワード
ui.newPassword = "pass456";  	// 新パスワード
ui.explanation = "hoge"     	// 説明
//ユーザー情報を更新
udkConnect.UpdateUserInfo ( ui );
注意
  • パスワード、説明のみ更新可能です。そのほかのプロパティを変更しても更新されません。
  • Active Directory連携で取得したユーザーの情報は更新できません。

ユーザー定義カラム情報を取得する

メソッド名 DefineColumnInfo[] GetDefineColumnInfo()
戻り値 ユーザー定義カラム情報の配列
詳細は「3-5-7 ユーザー定義カラム情報クラス(defineColumnInfo)プロパティ」を参照してください。
例外
  • RdConnectException
    情報取得に失敗した場合
使用例
//ユーザー定義カラム情報を取得
ServiceRef.UdkConnect.defineColumnInfo[] colInfo = udkConnect.GetDefineColumnInfo();
for( int i = 0; i < colInfo.Length; i++ )
{
Console.WriteLine( colInfo[i].fieldName + " = " + colInfo[i].fieldIndex ); 
}