← Back to branch summary

~ubuntu-branches/ubuntu/trusty/net-snmp/trusty

« back to all changes in this revision

Viewing changes to man/netsnmp_snmp_client.3

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2004-09-13 12:06:21 UTC
  • Revision ID: james.westby@ubuntu.com-20040913120621-g952ntonlleihcvm
Tags: upstream-5.1.1
Import upstream version 5.1.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/netsnmp_snmp_client.3
 
1
.TH "various PDU processing routines" 3 "19 Mar 2004" "net-snmp" \" -*- nroff -*-
 
2
.ad l
 
3
.nh
 
4
.SH NAME
 
5
various PDU processing routines \- 
 
6
.SS "Functions"
 
7
 
 
8
.in +1c
 
9
.ti -1c
 
10
.RI "int \fBsnmp_set_var_typed_value\fP (netsnmp_variable_list *newvar, u_char type, const u_char *val_str, size_t val_len)"
 
11
.br
 
12
.RI "\fIsnmp_set_var_typed_value is used to set data into the netsnmp_variable_list structure.\fP"
 
13
.in -1c
 
14
.SH "FUNCTION DOCUMENTATION"
 
15
.PP 
 
16
.SS "int snmp_set_var_typed_value (netsnmp_variable_list * newvar, u_char type, const u_char * val_str, size_t val_len)"
 
17
.PP
 
18
snmp_set_var_typed_value is used to set data into the netsnmp_variable_list structure.
 
19
.PP
 
20
Used to return data to the snmp request via the netsnmp_request_info structure's requestvb pointer.
 
21
.PP
 
22
\fBParameters: \fP
 
23
.in +1c
 
24
.TP
 
25
\fB\fInewvar\fP\fP
 
26
the structure gets populated with the given data, type, val_str, and val_len. 
 
27
.TP
 
28
\fB\fItype\fP\fP
 
29
is the asn data type to be copied 
 
30
.TP
 
31
\fB\fIval_str\fP\fP
 
32
is a buffer containing the value to be copied into the newvar structure.  
 
33
.TP
 
34
\fB\fIval_len\fP\fP
 
35
the length of val_str
 
36
.PP
 
37
\fBReturns: \fP
 
38
.in +1c
 
39
returns 0 on success and 1 on a malloc error 
 
40
.PP
 
41
\fBExamples: \fP
 
42
.in +1c
 
43
\fBdelayed_instance.c\fP.
 
44
.PP
 
45
Definition at line 669 of file snmp_client.c.
 
46
.PP
 
47
References variable_list::type.
 
48
.PP
 
49
Referenced by check_acm(), check_getnext_results(), handle_pdu(), netsnmp_check_getnext_reply(), netsnmp_old_api_helper(), netsnmp_table_build_result(), and netsnmp_table_data_build_result().
 
50
.SH "VARIABLE DOCUMENTATION"
 
51
.PP 
 
52
.SS "const char* error_string[19]"
 
53
.PP
 
54
\fBInitial value:\fP
 
55
.PP
 
56
.nf
 
57
 {
 
58
    '(noError) No Error',
 
59
    '(tooBig) Response message would have been too large.',
 
60
    '(noSuchName) There is no such variable name in this MIB.',
 
61
    '(badValue) The value given has the wrong type or length.',
 
62
    '(readOnly) The two parties used do not have access to use the specified SNMP PDU.',
 
63
    '(genError) A general failure occured',
 
64
    'noAccess',
 
65
    'wrongType (The set datatype does not match the data type the agent expects)',
 
66
    'wrongLength (The set value has an illegal length from what the agent expects)',
 
67
    'wrongEncoding',
 
68
    'wrongValue (The set value is illegal or unsupported in some way)',
 
69
    'noCreation (that table does not support row creation)',
 
70
    'inconsistentValue (The set value is illegal or unsupported in some way)',
 
71
    'resourceUnavailable (This is likely a out-of-memory failure within the agent)',
 
72
    'commitFailed',
 
73
    'undoFailed',
 
74
    'authorizationError (access denied to that object)',
 
75
    'notWritable (that object does not support modification)',
 
76
    'inconsistentName'
 
77
}
 
78
.fi
 
79
.PP
 
80
Definition at line 925 of file snmp_client.c.