Referência ao ficheiro log.h

Protótipos e esqueletos para o módulo log.c. Mais...

#include <stdio.h>
#include <mycommdef.h>

Ir para o código fonte deste ficheiro.

Macros
#define	FILE_NAME   "log"
#define	FILE_EXTENTION   ".txt"
#define	MAX_LOGS   999
#define	SIZE_OF_COMPLEMENT   3
Funções
bool	OpenLog (void)
	Abre arquivo de log.
void	CloseLog (void)
	Fecha arquivo de log e libera memória.
char *	GetLogFileName (void)
	Obtém nome do arquivo de log.
int	LogMessage (const char *,...)
	Constrói uma string da mesma forma que printf, e grava no arquivo de log.
Variáveis
FILE *	g_StreamLog

---

Descrição detalhada

Protótipos e esqueletos para o módulo log.c.

Data:

07/05/12 16:23

Versão:

0.0.1

Autor:

Alessandro Elias, ae11@inf.ufpr.br

Ruanito Diego Santos, rds@inf.ufpr.br

---

Documentação das macros

#define FILE_EXTENTION   ".txt"

Sufixo do nome do arquivo de log.

#define FILE_NAME   "log"

Prefixo do nome do arquivo de log.

#define MAX_LOGS   999

Numero maximo de logs que pode existir em um mesmo diretorio.

#define SIZE_OF_COMPLEMENT   3

Tamanho em bytes (char's) necessário para gerar o número como strings (999 3 chars).

---

Documentação das funções

char* GetLogFileName

(

void

)

Obtém nome do arquivo de log.

Retorna:

Retorna ponteiro para o buffer contento nome do arquivo. Antes de finalizar o programa este ponteiro deve ser liberado.

Observações:

Esta função garante que a cada instância de teste, somente um arquivo de log correspondete ao número daquela instância será gerado. O número máximo de arquivos é MAX_LOGS.

Veja também:

MAX_LOGS, PERRLN, WaitReturn,

int LogMessage	(	const char *	format,
			...
	)

Constrói uma string da mesma forma que printf, e grava no arquivo de log.

Parâmetros:

[in]	format	- formato da string, mesmo padrão que printf.
	...	- número de parâmetros variável.

Retorna:

número de char's escrito no arquivo, 0 em caso de erro.

Veja também:

PERRLN, WaitReturn

bool OpenLog

(

void

)

Abre arquivo de log.

Retorna:

TRUE se log foi aberto com sucesso, FALSO caso contrário.

Veja também:

GetLogFileName, PERRLN, WaitReturn

---

Documentação das variáveis

FILE* g_StreamLog

Referência para o stream do arquivo de log.