File: shmem_info_get_name.3.rst.txt

package info (click to toggle)
openmpi 5.0.8-10
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 201,692 kB
  • sloc: ansic: 613,078; makefile: 42,351; sh: 11,194; javascript: 9,244; f90: 7,052; java: 6,404; perl: 5,179; python: 1,859; lex: 740; fortran: 61; cpp: 20; tcl: 12
file content (51 lines) | stat: -rw-r--r-- 1,330 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
.. _shmem_info_get_name:


shmem_info_get_name
===================

.. include_body

:ref:`shmem_info_get_name` - This routine returns the vendor defined character
string.


SYNOPSIS
--------

C or C++:

.. code-block:: c++

   #include <mpp/shmem.h>

   void shmem_info_get_name(char *name)

Fortran:

.. code-block:: fortran

   include 'mpp/shmem.fh'
   SHMEM_INFO_GET_NAME(NAME)
   CHARACTER *(*)NAME


DESCRIPTION
-----------

shmem_info_get_name() This routine returns the vendor defined character
string of size defined by the constant SHMEM_MAX_NAME_LEN. The program
calling this function prepares the memory of size SHMEM_MAX_NAME_LEN,
and the implementation copies the string of size at most
SHMEM_MAX_NAME_LEN. In C, the string is terminated by a null character.
In Fortran, the string of size less than SHMEM_MAX_NAME_LEN is padded
with blank characters up to size SHMEM_MAX_NAME_LEN. The implementation
copying a string of size greater than SHMEM_MAX_NAME_LEN results in an
undefined behavior. Multiple invocations of the routine in an OpenSHMEM
program always return the same string. For a given library
implementation, the major and minor version returned by these calls is
consistent with the compile-time constants defined in its shmem.h.


.. seealso::
   *intro_shmem*\ (3) *shmem_my_pe*\ (3) *shmem_init*\ (3)