arm_get_correlator_length(3)

1arm_get_correlator_length(3)ARM 4 Programmer's Manuaalrm_get_correlator_length(3)
2
3
4

NAME

6       arm_get_correlator_length - get length of correlator
7

SYNOPSIS

9       #include <arm4.h>
10
11       arm_error_t
12       arm_get_correlator_length(
13           const arm_correlator_t *correlator,
14           arm_correlator_length_t *length);
15

DESCRIPTION

17       arm_get_correlator_length()  returns  the length of a correlator, based
18       on the length field within the correlator header. Note that this length
19       is not necessarily the length of the buffer containing the correlator.
20
21       A   correlator   header   contains  a  length  field.  arm_get_correla‐
22       tor_length() is used to return the length.  The  function  handles  any
23       required  conversion from the network byte order used in the header and
24       the endian (big versus little) of the platform. See arm_generate_corre‐
25       lator() for a description of a correlator.
26
27       correlator  is a pointer to a buffer containing a correlator. It serves
28       no purpose to make the call if the pointer is null.
29
30       length is a pointer to an arm_correlator_length_t  (a  16-bit  integer)
31       into  which  the ARM implementation will store the length. It serves no
32       purpose to make the call if the pointer is null. The stored value  will
33       be  the  actual value if the value is apparently correct; otherwise, it
34       will be zero.  Examples of when zero would be stored are when the input
35       correlator  pointer  is  null  or  the length field is invalid, such as
36       being greater than 512 (ARM_CORR_MAX_LENGTH) bytes.
37

RETURN VALUE

39       On success, the function returns ARM_SUCCESS. A  non-zero  value  indi‐
40       cates an error.
41

ERRORS

43       If  the  return code is negative, an error occurred. If the return code
44       is not negative, an error may or may not have occurred - the determina‐
45       tion  of  what  is an error and whether an error code is returned is at
46       the discretion of the ARM implementation. The application can test  the
47       return code if it wants to provide its own error logging.
48
49       The following errors are recognized by this implementation, but may not
50       be portable to other implementations:
51
52
53       ARM_FAILURE_NULL_ARGUMENT
54              The length must not be null.
55

CONFORMING TO

57       ARM Issue 4.0 C Language Bindings, Version 2
58

EXAMPLE

60       None.
61