RemoveUser - metoda objektu Pm
Popis:
Smaže existujícího PROMOTIC uživatele.
Syntaxe:
Boolean RemoveUser(String sId, [String sParams])
Parametry:
| sId | (String) Identifikátor existujícího (lokálního nebo síťového) uživatele.
Pro hromadné smazání všech uživatelů lze zadat text "$all". |
|---|
| sParams | [nepovinné] (String) Dodatečné parametry uživatele. Údaje jsou zde ve formátu KeyVal, například "type:local;stored:tmp;".
"type:local/net;" (nepovinné) - Typ uživatele (local = lokální uživatel, net = síťový uživatel).
Pokud je typ uveden, pak uživatel je smazán pouze pokud je daného typu.
Pokud není nastaveno, pak na typu uživatele nezáleží.
"stored:ini/tmp;" (nepovinné) - Způsob uložení konfigurace uživatele, kde ini je v lokálním textovém INI souboru a tmp je dočasně v paměti počítače.
Pokud je způsob uložení uveden, pak uživatel je smazán pouze pokud je daného způsobu uložení.
Pokud není nastaveno, pak na způsob uložení uživatele nezáleží. |
|---|
Vrácená hodnota:
true - Uživatel byl úspěšně smazán
false - Smazání uživatele selhalo
Poznámka:
Tato metoda
není funkční ve
Web obrazech.
Upozornění:
Pokud parametr sId je nastaven na "$all" a současně zcela chybí parametr sParams, pak kvůli kompatabilitě se starými verzemi zůstalo zachováno, že se mažou pouze uživatelé uložení dočasně v paměti (stejně jako by bylo zadáno stored:tmp;).
Pokud parametr sParams je nastaven (např. i na prázdný řetězec), pak se operace řídí podle tohoto nastavení.
Příklad1:
Smaže konkrétního PROMOTIC uživatele L_TEST.
Není nutno zadávat volitelný parametr sParams, protože identifikátor uživatele sId je jednoznačný.
JavaScriptVBScriptVyber a zkopíruj do schránky
var res = Pm.RemoveUser("L_TEST");
Dim res
res = Pm.RemoveUser("L_TEST")Příklad2:
Smaže všechny dočasné PROMOTIC uživatele typu typu TMP (lokální i síťové).
JavaScriptVBScriptVyber a zkopíruj do schránky
var res = Pm.RemoveUser("$all", "stored:tmp;");
Dim res
res = Pm.RemoveUser("$all", "stored:tmp;")