Rob Shearman : rpcrt4: Document NdrAllocate.

[Alexandre Julliard]

Module: wine
Branch: master
Commit: 4a028589eb67e72ecdd9110209ee0270f22253d5
URL:    http://source.winehq.org/git/wine.git/?a=commit;h=4a028589eb67e72ecdd9110209...

Author: Rob Shearman 
Date:   Thu Dec 13 16:14:51 2007 +0000

rpcrt4: Document NdrAllocate.

---

dlls/rpcrt4/ndr_marshall.c |   17 +++++++++++++++++
 1 files changed, 17 insertions(+), 0 deletions(-)

diff --git a/dlls/rpcrt4/ndr_marshall.c b/dlls/rpcrt4/ndr_marshall.c
index 5e77d18..0efa4d2 100644
--- a/dlls/rpcrt4/ndr_marshall.c
+++ b/dlls/rpcrt4/ndr_marshall.c
@@ -341,6 +341,23 @@ typedef struct _NDR_MEMORY_LIST

#define MEML_MAGIC  ('M' << 24 | 'E' << 16 | 'M' << 8 | 'L')

+/***********************************************************************
+ *            NdrAllocate [RPCRT4.@]
+ *
+ * Allocates a block of memory using pStubMsg->pfnAllocate.
+ *
+ * PARAMS
+ *  pStubMsg [I/O] MIDL_STUB_MESSAGE structure.
+ *  len      [I]   Size of memory block to allocate.
+ *
+ * RETURNS
+ *  The memory block of size len that was allocated.
+ *
+ * NOTES
+ *  The memory block is always 8-byte aligned.
+ *  If the function is unable to allocate memory an ERROR_OUTOFMEMORY
+ *  exception is raised.
+ */
 void * WINAPI NdrAllocate(MIDL_STUB_MESSAGE *pStubMsg, size_t len)
 {
     size_t aligned_len;