blob: 1cc91adaaaf42d1849ddcea04178e32a2d63ec44 [file] [log] [blame]
Robert Shearman4253b012006-03-01 12:22:26 +00001/*
2 * NDR Types
3 *
4 * Copyright 2006 Robert Shearman (for CodeWeavers)
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
20
21#ifndef __NDRTYPES_H__
22#define __NDRTYPES_H__
23
24typedef struct
25{
26 unsigned short MustSize : 1; /* 0x0001 - client interpreter MUST size this
27 * parameter, other parameters may be skipped, using the value in
28 * NDR_PROC_PARTIAL_OIF_HEADER::constant_client_buffer_size instead. */
29 unsigned short MustFree : 1; /* 0x0002 - server interpreter MUST size this
30 * parameter, other parameters may be skipped, using the value in
31 * NDR_PROC_PARTIAL_OIF_HEADER::constant_server_buffer_size instead. */
32 unsigned short IsPipe : 1; /* 0x0004 - The parameter is a pipe handle. See
33 * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/rpc/rpc/pipes.asp
34 * for more information on pipes. */
35 unsigned short IsIn : 1; /* 0x0008 - The parameter is an input */
36 unsigned short IsOut : 1; /* 0x0010 - The parameter is an output */
37 unsigned short IsReturn : 1; /* 0x0020 - The parameter is to be returned */
38 unsigned short IsBasetype : 1; /* 0x0040 - The parameter is simple and has the
39 * format defined by NDR_PARAM_OIF_BASETYPE rather than by
40 * NDR_PARAM_OIF_OTHER. */
41 unsigned short IsByValue : 1; /* 0x0080 - Set for compound types being sent by
42 * value. Can be of type: structure, union, transmit_as, represent_as,
43 * wire_marshal and SAFEARRAY. */
44 unsigned short IsSimpleRef : 1; /* 0x0100 - parameter that is a reference
45 * pointer to anything other than another pointer, and which has no
46 * allocate attributes. */
47 unsigned short IsDontCallFreeInst : 1; /* 0x0200 - Used for some represent_as types
48 * for when the free instance routine should not be called. */
49 unsigned short SaveForAsyncFinish : 1; /* 0x0400 - Unknown */
50 unsigned short Unused : 2;
51 unsigned short ServerAllocSize : 3; /* 0xe000 - If non-zero
52 * specifies the size of the object in numbers of 8byte blocks needed.
53 * It will be stored on the server's stack rather than using an allocate
54 * call. */
55} PARAM_ATTRIBUTES;
56
Robert Shearman28f494e2006-04-20 11:44:27 +010057typedef struct
58{
59 unsigned char ServerMustSize : 1; /* 0x01 - the server must perform a
60 * sizing pass. */
61 unsigned char ClientMustSize : 1; /* 0x02 - the client must perform a
62 * sizing pass. */
63 unsigned char HasReturn : 1; /* 0x04 - procedure has a return value. */
64 unsigned char HasPipes : 1; /* 0x08 - the pipe package should be used. */
65 unsigned char Unused : 1; /* 0x10 - not used */
66 unsigned char HasAsyncUuid : 1; /* 0x20 - indicates an asynchronous DCOM
67 * procedure. */
68 unsigned char HasExtensions : 1; /* 0x40 - indicates that Win2000
69 * extensions are in use. */
70 unsigned char HasAsyncHandle : 1; /* 0x80 - indicates an asynchronous RPC
71 * procedure. */
72} INTERPRETER_OPT_FLAGS, *PINTERPRETER_OPT_FLAGS;
73
Robert Shearman98facf42006-04-20 11:44:41 +010074typedef struct
75{
76 unsigned char HasNewCorrDesc : 1; /* 0x01 - indicates new correlation
77 * descriptors in use. */
78 unsigned char ClientCorrCheck : 1; /* 0x02 - client needs correlation
79 * check. */
80 unsigned char ServerCorrCheck : 1; /* 0x04 - server needs correlation
81 * check. */
82 unsigned char HasNotify : 1; /* 0x08 - should call MIDL [notify]
83 * routine @ NotifyIndex. */
84 unsigned char HasNotify2 : 1; /* 0x10 - should call MIDL [notify_flag] routine @
85 * NotifyIndex. */
86 unsigned char Unused : 3;
87} INTERPRETER_OPT_FLAGS2, *PINTERPRETER_OPT_FLAGS2;
88
89/* Win2000 extensions */
90typedef struct
91{
92 /* size in bytes of all following extensions */
93 unsigned char Size;
94
95 INTERPRETER_OPT_FLAGS2 Flags2;
96
97 /* client cache size hint */
98 unsigned short ClientCorrHint;
99
100 /* server cache size hint */
101 unsigned short ServerCorrHint;
102
103 /* index of routine in MIDL_STUB_DESC::NotifyRoutineTable to call if
104 * HasNotify or HasNotify2 flag set */
105 unsigned short NotifyIndex;
106} NDR_PROC_HEADER_EXTS;
107
108typedef struct
109{
110 /* size in bytes of all following extensions */
111 unsigned char Size;
112
113 INTERPRETER_OPT_FLAGS2 Flags2;
114
115 /* client cache size hint */
116 unsigned short ClientCorrHint;
117
118 /* server cache size hint */
119 unsigned short ServerCorrHint;
120
121 /* index of routine in MIDL_STUB_DESC::NotifyRoutineTable to call if
122 * HasNotify or HasNotify2 flag set */
123 unsigned short NotifyIndex;
124
125 /* needed only on IA64 to cope with float/register loading */
126 unsigned short FloatArgMask;
127} NDR_PROC_HEADER_EXTS64;
128
Robert Shearman4253b012006-03-01 12:22:26 +0000129#endif