Content-type: text/html Man page of cfg_connect

cfg_connect

Section: C Library Functions (3)
Index Return to Main Contents
 

NAME

cfg_connect - Connect to the configuration management server on a remote host  

LIBRARY

Configuration Management Library (libcfg.a)  

SYNOPSIS

#include <cfg.h> cfg_status_t cfg_connect(
        caddr_t host,
        cfg_handle_t *handle,
        unsigned int flags);  

PARAMETERS

Specifies the name of the host system to be configured. Returns a connection handle that you use in other calls to the configuration management library. This handle is a structure that identifies the means of communication between your application and the configuration management server. Specifies options to the connection. Currently, one option is supported. CFG_FLAG_VERBOSE requests that the system display status information to the application user during the processing of routines in the configuration management library. This flag is normally used only for debugging your application.  

DESCRIPTION

Before your application can perform operations on remote kernel subsystems, it must call the cfg_connect() routine. This routine invokes the configuration management server and establishes a socket connection between the server and your application. The routine returns the handle parameter, which identifies the socket connection between your application and the remote configuration management server. You must pass the handle in calls to other libcfg routines.

For local operations, you need not establish a connection to the configuration management server, so you do not need to call the cfg_connect() routine.  

EXAMPLES

The following example illustrates the use of the cfg_connect() library routine:

cfg_status_t retval; cfg_handle_t handle;

retval = cfg_connect("madmax", &handle, 0);

if (retval != CFG_SUCCESS)
   print_error(retval);

In this example, the cfg_connect() call attempts to establish a connection between your application and the configuration management server on host madmax. If successful, the call returns data describing how your application will communicate with the configuration management server. If the return value is not CFG_SUCCESS, the application calls the print_error routine, which displays an error message. (The print_error routine is not part of the libcfg library. For an example of this routine, see libcfg(3).)  

RETURN VALUES

Upon successful completion, cfg_connect() returns CFG_SUCCESS. Other return values indicate that an error has occurred. For information about handling return values from routines in the configuration management library, see libcfg(3).  

RELATED INFORMATION

Commands: cfgmgr(8), sysconfig(8)

Routines: cfg_disconnect(3), libcfg(3) delim off


 

Index

NAME
LIBRARY
SYNOPSIS
PARAMETERS
DESCRIPTION
EXAMPLES
RETURN VALUES
RELATED INFORMATION

This document was created by man2html, using the manual pages.
Time: 02:42:40 GMT, October 02, 2010