File: shmem_info_get_name.3in

package info (click to toggle)
openmpi 3.1.3-11
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 118,572 kB
  • sloc: ansic: 628,972; f90: 17,993; makefile: 13,761; sh: 7,051; java: 6,360; perl: 3,215; cpp: 2,225; python: 1,350; lex: 988; fortran: 52; tcl: 12
file content (48 lines) | stat: -rw-r--r-- 1,480 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
.\" -*- nroff -*-
.\" Copyright (c) 2015      University of Houston.  All rights reserved.
.\" Copyright (c) 2015      Mellanox Technologies, Inc.
.\" $COPYRIGHT$
.de Vb
.ft CW
.nf
..
.de Ve
.ft R

.fi
..
.TH "SHMEM\\_INFO\\_GET\\_NAME" "3" "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
.SH NAME

shmem_info_get_name
\- This routine returns the vendor defined character string.
.SH SYNOPSIS

C or C++:
.Vb
#include <mpp/shmem.h>
void shmem_info_get_name(char *name);
.Ve
Fortran:
.Vb
include 'mpp/shmem.fh'
SHMEM_INFO_GET_NAME(NAME)
CHARACTER *(*)NAME
.Ve
.SH 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.
.SH SEE ALSO

\fIintro_shmem\fP(3),
\fIshmem_my_pe\fP(3),
\fIshmem_init\fP(3)