.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "HVCS_REGISTER_CONNECTION" "9" "09 October 2005" "" ""

.SH NAME
hvcs_register_connection \- establish a connection between this vty-server and
.SH SYNOPSIS
"SYNOPSIS"
.sp
\fB
.sp
int hvcs_register_connection  (uint32_t \fIunit_address\fB, uint32_t \fIp_partition_ID\fB, uint32_t \fIp_unit_address\fB);
\fR
.SH "ARGUMENTS"
.TP
\fB\fIunit_address\fB\fR
The unit address of the vty-server adapter that is to be
establish a connection.
.TP
\fB\fIp_partition_ID\fB\fR
The partition ID of the vty adapter that is to be connected.
.TP
\fB\fIp_unit_address\fB\fR
The unit address of the vty adapter to which the vty-server
is to be connected.
.SH "DESCRIPTION"
.PP
If this function is called once and -EINVAL is returned it may
indicate that the partner info needs to be refreshed for the
target unit address at which point the caller must invoke
\fBhvcs_get_partner_info\fR and then call this function again.  If,
for a second time, -EINVAL is returned then it indicates that
there is probably already a partner connection registered to a
different vty-server adapter.  It is also possible that a second
-EINVAL may indicate that one of the parms is not valid, for
instance if the link was removed between the vty-server adapter
and the vty adapter that you are trying to open.  Don't shoot the
messenger.  Firmware implemented it this way.
.SH "DESCRIPTION"
.PP
If this function is called once and -EINVAL is returned it may
indicate that the partner info needs to be refreshed for the
target unit address at which point the caller must invoke
\fBhvcs_get_partner_info\fR and then call this function again.  If,
for a second time, -EINVAL is returned then it indicates that
there is probably already a partner connection registered to a
different vty-server adapter.  It is also possible that a second
-EINVAL may indicate that one of the parms is not valid, for
instance if the link was removed between the vty-server adapter
and the vty adapter that you are trying to open.  Don't shoot the
messenger.  Firmware implemented it this way.