Gestão de Estados

Funções para manipulação de unidades federativas. Mais...

Funções
const char *	get_state_abbr_by_name (const char *name)
	Obtém a sigla de um estado pelo nome completo.
const char *	get_state_name_by_abbr (const char *abbr)
	Obtém o nome completo de um estado pela sigla.
const char *	current_state_name (void)
	Obtém o nome completo do estado atualmente selecionado no sistema, de acordo com o índice interno de controle de estados.
const char *	current_state_abbr (void)
	Obtém a sigla do estado atualmente selecionado no sistema, de acordo com o índice interno de controle de estados.
void	next_state (void)
	Avança para o próximo estado na lista de estados, incrementando o índice interno de controle de estados Se o índice atingir o final da lista, volta para o primeiro estado, criando um ciclo.
void	previous_state (void)
	Retrocede para o estado anterior na lista de estados, decrementando o índice interno de controle de estados Se o índice já estiver no início da lista (primeiro estado), retrocede para o último estado, completando o ciclo de navegação.
void	reset_state_counter (void)
	Reinicia o contador de estados interno para o início da sequência, fazendo com que o estado a ser acessado pela função current_state_*() seja o primeiro estado da lista cadastrada (Acre)

Descrição detalhada

Funções para manipulação de unidades federativas.

Estas funções permitem obter informações sobre os estados da federação brasileira, como siglas e nomes completos.

Aviso

Mantém um índice que itera sequencialmente sobre todos os estados brasileiros em ordem alfabética crescente (Acre à Tocantins). O módulo é carregado sempre fazendo referência ao primeiro estado da lista (Acre). Ao atingir o último estado da sequencia (Tocantins), a próxima chamada de next_state() fará com que o índice retorne ao primeiro estado.

Nota

A ordem completa segue a lista oficial de UFs: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO

Documentação das funções

current_state_abbr()

const char * current_state_abbr

(

void

)

Obtém a sigla do estado atualmente selecionado no sistema, de acordo com o índice interno de controle de estados.

Retorna

const char* Sigla do estado atual (ex: "MS")

current_state_name()

const char * current_state_name

(

void

)

Obtém o nome completo do estado atualmente selecionado no sistema, de acordo com o índice interno de controle de estados.

Retorna

const char* Nome completo do estado atual (ex: "Mato Grosso do Sul")

get_state_abbr_by_name()

const char * get_state_abbr_by_name

(

const char *

name

)

Obtém a sigla de um estado pelo nome completo.

Parâmetros

name	Nome completo do estado (ex: "Mato Grosso do Sul")

Retorna

const char* Sigla de 2 letras (ex: "MS") ou NULL se não encontrado

get_state_name_by_abbr()

const char * get_state_name_by_abbr

(

const char *

abbr

)

Obtém o nome completo de um estado pela sigla.

Parâmetros

abbr	Sigla de 2 letras (ex: "MS")

Retorna

const char* Nome completo (ex: "Mato Grosso do Sul") ou NULL se não encontrado