githubmirror/adcli

library/adutil.h
93 строки2 KB
Stef Walter
Less complicated message logging
08 апр 2013, 19:04
08 апр 2013, 19:04c581500
/*
 * adcli
 *
 * Copyright (C) 2012 Red Hat Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301 USA
 *
 * Author: Stef Walter <stefw@gnome.org>
 */

#ifndef ADUTIL_H_
#define ADUTIL_H_

#include <stdlib.h>

typedef enum {
	/* Successful completion */
	ADCLI_SUCCESS = 0,

	/*
	 * Invalid input or unexpected system behavior.
	 *
	 * This is almost always caused by a bug, or completely broken
	 * system configuration or state. This is returned when memory
	 * allocation fails, but the process will almost certainly have
	 * been killed first.
	 *
	 * This is returned for invalid inputs (such an unexpected
	 * NULL) to adcli.
	 */
	ADCLI_ERR_UNEXPECTED = -2,

	/*
	 * A general failure, that doesn't fit into the other categories.
	 * Not much the caller can do.
	 */
	ADCLI_ERR_FAIL = -3,

	/*
	 * A problem with the active directory or connecting to it.
	 */
	ADCLI_ERR_DIRECTORY = -4,

	/*
	 * A logic problem with the configuration of the local system, or
	 * the settings passed into adcli.
	 */
	ADCLI_ERR_CONFIG = -5,

	/*
	 * Invalid credentials.
	 *
	 * The credentials are invalid, or don't have the necessary
	 * access rights.
	 */
	ADCLI_ERR_CREDENTIALS = -6,
} adcli_result;

typedef enum {
	ADCLI_MESSAGE_INFO,
	ADCLI_MESSAGE_WARNING,
	ADCLI_MESSAGE_ERROR
} adcli_message_type;

const char *      adcli_result_to_string        (adcli_result res);

int               adcli_mem_clear               (void *data,
                                                 size_t length);


typedef void      (* adcli_message_func)        (adcli_message_type type,
                                                 const char *message);

void              adcli_set_message_func        (adcli_message_func message_func);

void              adcli_clear_last_error        (void);

const char *      adcli_get_last_error          (void);

#endif /* ADUTIL_H_ */