evs_context_get.3 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  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 EVS_CONTEXT_GET 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
  35. .SH NAME
  36. evs_context_get \- Gets the context variable for a EVS instance
  37. .SH SYNOPSIS
  38. .B #include <corosync/evs.h>
  39. .sp
  40. .BI "int evs_context_get(evs_handle_t " handle ", void **" context ");
  41. .SH DESCRIPTION
  42. The
  43. .B evs_context_get
  44. function is used to retrieve the context variable previously stored using
  45. .B evs_context_set(3)
  46. .SH RETURN VALUE
  47. This call returns the EVS_OK value if successful, otherwise an error is returned.
  48. .PP
  49. .SH ERRORS
  50. The errors are undocumented.
  51. .SH "SEE ALSO"
  52. .BR evs_overview (8),
  53. .BR evs_initialize (3),
  54. .BR evs_finalize (3),
  55. .BR evs_fd_get (3),
  56. .BR evs_dispatch (3),
  57. .BR evs_join (3),
  58. .BR evs_leave (3),
  59. .BR evs_mcast_joined (3),
  60. .BR evs_mcast_groups (3),
  61. .BR evs_membership_get (3)
  62. .BR evs_context_get (3)
  63. .BR evs_context_set (3)
  64. .PP