Autodoc updated.
[AROS.git] / rom / dos / abortpkt.c
blob3dec6f8d23d27a5b72de5a6f1c97d870c9551a66
1 /*
2 Copyright © 1995-2012, The AROS Development Team. All rights reserved.
3 $Id$
5 Desc:
6 Lang: english
7 */
9 #include <proto/exec.h>
11 #include "dos_intern.h"
13 /*****************************************************************************
15 NAME */
16 #include <dos/dosextens.h>
17 #include <proto/dos.h>
19 AROS_LH2(void, AbortPkt,
21 /* SYNOPSIS */
22 AROS_LHA(struct MsgPort *, port, D1),
23 AROS_LHA(struct DosPacket *, pkt, D2),
25 /* LOCATION */
26 struct DosLibrary *, DOSBase, 44, Dos)
28 /* FUNCTION
29 This function does currently nothing. You can use WaitForChar()
30 to poll for characters from an interactive handler.
32 The planned purpose of this function is:
33 Tries to abort an asynchronous packet. There is no guarantee
34 that this succeeds. You must wait with WaitPkt() for the packet
35 to return before you can reuse or deallocate it.
37 INPUTS
38 port -- the message port to where the packet was sent
39 pkt -- the packet to be aborted
41 RESULT
43 NOTES
45 EXAMPLE
47 BUGS
49 SEE ALSO
50 SendPkt(), WaitForChar(), WaitPkt()
52 INTERNALS
54 *****************************************************************************/
56 AROS_LIBFUNC_INIT
58 /* TODO: implement this for real packets (is it possible at all) ? */
60 AROS_LIBFUNC_EXIT
61 } /* AbortPkt */