RemoveUser - metoda obiektu Pm
Opis:
Usunie istniejącego PROMOTIC użytkownika.
Składnia:
Boolean RemoveUser(String sId, [String sParams])
Parametry:
| sId | (String) Identyfikator istniejącego (lokalnego lub sieciowego) użytkownika.
W celu zbiorowego usunięcia wszystkich użytkowników można wprowadzić tekst "$all". |
|---|
| sParams | [opcjonalne] (String) Dodatkowe parametry użytkownika. Dane są tutaj w formacie KeyVal, na przykład "type:local;stored:tmp;".
"type:local/net;" (opcjonalne) - Typ użytkownika (local = użytkownik lokalny, net = użytkownik sieciowy).
Jeżeli jest określony typ, wtedy użytkownik jest usunięty tylko jeżeli jest określonego typu.
Jeżeli nie jest ustawione, wtedy usunięcie użytkownika nie jest zależne od jego typu.
"stored:ini/tmp;" (opcjonalne) - Sposób zapisu konfiguracji użytkownika, gdzie ini oznacza lokalny plik tekstowy INI oraz tmp oznacza tymczasowy zapis w pamięci komputera.
Jeżeli jest określony sposób zapisu, wtedy użytkownik jest usunięty tylko jeżeli jest określonego typu zapisu.
Jeżeli nie jest ustawione, wtedy usunięcie użytkownika nie jest zależne od jego typu. |
|---|
Wartość zwrotna:
true - Użytkownik usunięty z powodzeniem
false - Usunięcie użytkownika nie powiodło się
Notatka:
Metoda ta
nie działa w
Web panelach.
Uwaga:
Jeżeli parametr sId jest ustawiony na "$all" a równocześnie zupełnie brak parametru sParams, wtedy z powodu zgodności z starymi wersjami zostało zachowane, że usuwani są tylko użytkownicy zapisani tymczasowo w pamięci (tak samo jak by było określone stored:tmp;).
Jeżeli parametr sParams jest ustawiony (chociażby pusty łańcuch), wtedy operacja wykonywana jest na podstawie tego ustawienia.
Przykład1:
Usunie konkretnego PROMOTIC użytkownika L_TEST. Nie jest konieczne określenie opcjonalnego parametru sParams, ponieważ identyfikator użytkownika sId jest jednoznaczny.
JavaScriptVBScriptWybierz oraz skopiuj do schowka
var res = Pm.RemoveUser("L_TEST");
Dim res
res = Pm.RemoveUser("L_TEST")Przykład2:
Usunie wszystkich tymczasowych PROMOTIC użytkowników typu TMP (lokalnych i sieciowych).
JavaScriptVBScriptWybierz oraz skopiuj do schowka
var res = Pm.RemoveUser("$all", "stored:tmp;");
Dim res
res = Pm.RemoveUser("$all", "stored:tmp;")