[greatlrd] 30301: Update the documentation adding lite more code

Author: greatlrd
Date: Fri Nov  9 20:33:02 2007
New Revision: 30301

URL: http://svn.reactos.org/svn/reactos?rev=30301&view=rev
Log:
Update the documentation 
adding lite more code

Modified:
    branches/reactx/reactos/dll/directx/ksuser/ksuser.c
    branches/reactx/reactos/dll/directx/ksuser/ksuser.h

Modified: branches/reactx/reactos/dll/directx/ksuser/ksuser.c
URL: http://svn.reactos.org/svn/reactos/branches/reactx/reactos/dll/directx/ksuse...
==============================================================================
--- branches/reactx/reactos/dll/directx/ksuser/ksuser.c (original)
+++ branches/reactx/reactos/dll/directx/ksuser/ksuser.c Fri Nov  9 20:33:02 2007
@@ -20,17 +20,16 @@
 /*++
 * @name KsCreateAllocator
 * @implemented
-*
-* The function KsCreateAllocator
-*
-* @param 
-*
-* @param 
-*
-* @param ACCESS_MASK  DesiredAccess
-* Desrided access
-*
-* @param 
+* The function KsCreateAllocator creates a handle to an allocator for the given sink connection handle
+*
+* @param HANDLE ConnectionHandle
+* Handle to the sink connection on which to create the allocator
+*
+* @param PKSALLOCATOR_FRAMING AllocatorFraming
+* the input param we using to alloc our framing
+*
+* @param PHANDLE AllocatorHandle
+* Our new handle that we have alloc
 *
 * @return 
 * Return NTSTATUS error code or sussess code.
@@ -59,16 +58,16 @@
 * @name KsCreateClock
 * @implemented
 *
-* The function KsCreateClock
-*
-* @param 
-*
-* @param 
-*
-* @param ACCESS_MASK  DesiredAccess
-* Desrided access
-*
-* @param 
+* The function KsCreateClock  creates handle to clock instance
+*
+* @param HANDLE ConnectionHandle
+* Handle to use to create the clock 
+*
+* @param PKSCLOCK_CREATE ClockCreate
+* paramenter to use to create the clock
+*
+* @param PHANDLE  ClockHandle
+* The new handle
 *
 * @return 
 * Return NTSTATUS error code or sussess code.
@@ -92,42 +91,58 @@
                                 ClockHandle);
 }

-
-
 /*++
 * @name KsCreatePin
 * @implemented
 *
-* The function KsCreatePin
-*
-* @param 
-*
-* @param 
-*
+* The function KsCreatePin passes a connection request to device and create pin instance
+*
+* @param HANDLE FilterHandle
+* handle of the filter initiating the create request
+*
+* @param PKSPIN_CONNECT Connect
+* Pointer to a KSPIN_CONNECT structure that contains parameters for the requested connection. 
+* This should be followed in memory by a KSDATAFORMAT data structure, describing the data format
+* requested for the connection. 
+
 * @param ACCESS_MASK  DesiredAccess
 * Desrided access
 *
-* @param 
-*
-* @return 
-* Return NTSTATUS error code or sussess code.
-*
-* @remarks.
-* none
-*
-*--*/
+* @param PHANDLE ConnectionHandle
+* connection handle passed
+*
+* @return 
+* Return NTSTATUS error code or sussess code.
+*
+* @remarks.
+* The flag in PKSDATAFORMAT is not really document, 
+* to find it u need api mointor allot api and figout
+* how it works, only flag I have found is the 
+* KSDATAFORMAT_ATTRIBUTES flag, it doing a Align
+* of LONLONG size, it also round up it.
+*
+*--*/
+
 KSDDKAPI
 NTSTATUS
 NTAPI
 KsCreatePin(HANDLE FilterHandle,
             PKSPIN_CONNECT Connect,
             ACCESS_MASK DesiredAccess,
-            OUT PHANDLE  ConnectionHandle)
-{
+            PHANDLE  ConnectionHandle)
+{
+    ULONG BufferSize = sizeof(KSPIN_CONNECT);
+    PKSDATAFORMAT DataFormat = ((PKSDATAFORMAT) ( ((ULONG)Connect) + ((ULONG)sizeof(KSPIN_CONNECT)) ) );
+
+    if (DataFormat->Flags &  KSDATAFORMAT_ATTRIBUTES)
+    {
+        BufferSize += (ROUND_UP(DataFormat->FormatSize,sizeof(LONGLONG)) + DataFormat->FormatSize);
+    }
+
     return KsiCreateObjectType(FilterHandle,
                                KSSTRING_Pin,
                                Connect,
-                               sizeof(KSPIN_CONNECT),
+                               BufferSize,
                                DesiredAccess,
                                ConnectionHandle);

Modified: branches/reactx/reactos/dll/directx/ksuser/ksuser.h
URL: http://svn.reactos.org/svn/reactos/branches/reactx/reactos/dll/directx/ksuse...
==============================================================================
--- branches/reactx/reactos/dll/directx/ksuser/ksuser.h (original)
+++ branches/reactx/reactos/dll/directx/ksuser/ksuser.h Fri Nov  9 20:33:02 2007
@@ -3,6 +3,7 @@

#define _KSDDK_
 #include <windows.h>
+#include <reactos/helper.h>

#ifndef NTSTATUS
     #define NTSTATUS DWORD