man/cpg_context_set.3

   1 .\"/*
   2 .\" * Copyright (c) 2007 Red Hat, Inc.
   3 .\" *
   4 .\" * All rights reserved.
   5 .\" *
   6 .\" * Author: Patrick Caulfield <pcaulfie@redhat.com>
   7 .\" *
   8 .\" * This software licensed under BSD license, the text of which follows:
   9 .\" *
  10 .\" * Redistribution and use in source and binary forms, with or without
  11 .\" * modification, are permitted provided that the following conditions are met:
  12 .\" *
  13 .\" * - Redistributions of source code must retain the above copyright notice,
  14 .\" *   this list of conditions and the following disclaimer.
  15 .\" * - Redistributions in binary form must reproduce the above copyright notice,
  16 .\" *   this list of conditions and the following disclaimer in the documentation
  17 .\" *   and/or other materials provided with the distribution.
  18 .\" * - Neither the name of the MontaVista Software, Inc. nor the names of its
  19 .\" *   contributors may be used to endorse or promote products derived from this
  20 .\" *   software without specific prior written permission.
  21 .\" *
  22 .\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  23 .\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  26 .\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27 .\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28 .\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29 .\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30 .\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  32 .\" * THE POSSIBILITY OF SUCH DAMAGE.
  33 .\" */
  34 .TH CPG_CONTEXT_SET 3 2004-08-31 "openais Man Page" "Openais Programmer's Manual"
  35 .SH NAME
  36 cpg_context_set \- Sets the context variable for a CPG instance
  37 .SH SYNOPSIS
  38 .B #include <openais/cpg.h>
  39 .sp
  40 .BI "int cpg_context_set(cpg_handle_t " handle ", void *" context ");
  41 .SH DESCRIPTION
  42 The
  43 .B cpg_context_set
  44 function is used to set the context variable for a cpg instance. It has no
  45 meaning insire libcpg itself and will not be touched by the library. It can
  46 be retrieved using
  47 .B cpg_context_get(3)
  48 .SH RETURN VALUE
  49 This call returns the CPG_OK value if successful, otherwise an error is returned.
  50 .PP
  51 .SH ERRORS
  52 The errors are undocumented.
  53 .SH "SEE ALSO"
  54 .BR cpg_overview (8),
  55 .BR cpg_initialize (3),
  56 .BR cpg_finalize (3),
  57 .BR cpg_dispatch (3),
  58 .BR cpg_join (3),
  59 .BR cpg_leave (3),
  60 .BR cpg_mcast_joined (3),
  61 .BR cpg_membership_get (3)
  62 .BR cpg_context_get (3)
  63 .PP