Set group properties
Set group properties ( refGrupo ; nome ; proprietario {; membros} ) -> Resultado
| Parâmetro | Tipo | Descrição | |
|---|---|---|---|
| refGrupo | Integer | → | Número de ID do grupo; ou -1 para adicionar um grupo Designer, ou -2 para adicionar um grupo Administrador |
| ← | Número de ID única do grupo adicionado (se houver) | ||
| nome | Text | → | Novo nome do grupo |
| proprietario | Integer | → | Número de ID do novo proprietário do grupo |
| membros | Integer array | → | Novos membros do grupo |
| Resultado | Integer | ← | Nº de ID do novo grupo |
Esse comando não é seguro para thread e não pode ser usado em código adequado.
Descrição
Set group properties permite modificar e atualizar as propriedades de um grupo existente cujo número de referência único se passa em refGrupo, ou para adicionar um novo grupo
Se modificar as propriedades de um grupo existente, deve passar um número de referência válido retornado pelo comando GET GROUP LIST.
Para adicionar um novo grupo passe -1 em refGrupo (veja as notas para bancos de dados binários).
Depois da chamada, se o grupo for adicionado com sucesso, retorna seu número de referência único em refGrupo.
Se não passa -1, -2 ou um número de referência de grupo válido, Set group properties não faz nada.
Passe o novo nome do grupo no parâmetro nome.
(Apenas para Bancos de Dados Binários) Passe o número da ID de referência do novo proprietário do grupo no parâmetro proprietário. Este parâmetro é ignorado em bancos de dados projeto.
Se não quiser mudar todas as propriedades do grupo (além dos membros, ver abaixo) primeiro chame GET GROUP PROPERTIES e passe os valores retornados para as propriedades que quiser deixar intactas.
Se não passar o parâmetro opcional membros, a lista atual de membros do grupo permanece sem mudanças. Se não passar membros enquanto adiciona um grupo, o grupo não terá membros.
Se passa o parâmetro opcional membros, modifica toda a lista de membros para este grupo. Antes de chamar esta rotina, deve preencher o array membros com os números de referência únicos dos usuários e grupos que o grupo terá como membros.
Para eliminar todos os membros de um grupo, passe um array vazio no parâmetro membros.
Nota para bancos de dados binários:
- Valores de ID de Grupo e Usuário dependem do criador (Designer, Administrador ou proprietário de grupo afiliado). Para saber mais veja o parágrafo User and group ID ranges. Para criar um grupo afiliado com o Designer, passe -1 em grupoID. Para criar um grupo afiliado com o Administrador, passe -2 em grupoID.
- o proprietário de um grupo não está definido automaticamente como membro do grupo que possuir. É sua decisão incluir ao proprietário do grupo no grupo, utilizando o parâmetro membros.
Gestão de erros
Se você não tiver os acessos de privilégio para chamar Set group properties ou se o sistema de senhas já estiver acessado para outro processo, um erro de privilégio de acesso é gerado. Você pode interceptar o erro com um método de gestão de erros instalado usando ON ERR CALL.