ndmpsendrequest.l

来自「网络数据管理协议的开发」· L 代码 · 共 55 行

.\" Copyright (c) 1996,1997 PDC, Network Appliance. All Rights Reserved.
.\" $Id: ndmpSendRequest.l,v 1.3 1997/02/01 09:50:35 tim Exp $
'\"macro stdmacro
.nr X
.TH ndmpSendRequest l "02 Jan 1997"
.SH NAME
ndmpSendRequest \- send an NDMP request message
.SH SYNOPSIS
.LP
.nf
.ft 3
#include <ndmp_common.h>
.ft
.fi
.LP
.BI "int ndmpSendRequest(NdmpConnection connectionHandle,"
.if n .ti +5n
.BI "ndmp_message message,"
.if n .ti +5n
.BI "ndmp_error err,"
.if n .ti +5n
.BI "void* request_data,"
.if n .ti +5n
.BI "void** reply" );
.SH DESCRIPTION
.B ndmpSendRequest(\|)
sends an NDMP request message.
.IR connection
is the NDMP connection handle returned by 
.B ndmpCreateConnection(\|)
or 
.B ndmpRun(\|).
.IR message
identifies the NDMP message being sent.
.IR err
specifies the error code to be placed in the message header.
If
.IR err
is not NDMP_NO_ERR, then the message body is not sent.
.IR request_data
is the message body to be sent.
The reply to the message is placed in the location pointed to by 
.IR reply
if 
.IR reply
is not NULL.
Returned reply messages should be freed using 
.B ndmpFreeMessage(\|).
.SH "RETURN VALUES"
Upon successful completion, 0 is returned.
Otherwise a value of -1 is returned.
.SH "SEE ALSO"
.BR ndmpCreateConnection (l),
.BR ndmpFreeMessage (l)