marshalling.c File Reference

#include <windef.h>
#include <winbase.h>
#include <marshalling/marshalling.h>

Include dependency graph for marshalling.c:

Go to the source code of this file.

Macros
#define	WIN32_NO_STATUS

Functions
MarshallDownStructure
Prepare a structure for marshalling/serialization by replacing absolute pointer addresses in its fields by relative offsets. Parameters pStructure Pointer to the structure to operate on. pInfo Array of MARSHALLING_INFO elements containing information about the fields of the structure as well as how to modify them. See the documentation on MARSHALLING_INFO for more information. You have to indicate the end of the array by setting the dwOffset field to MAXDWORD. cbStructureSize Size in bytes of the structure. This parameter is unused in my implementation. bSomeBoolean Unknown boolean value, set to TRUE. Returns TRUE if the structure was successfully adjusted, FALSE otherwise.
BOOL WINAPI	MarshallDownStructure (PVOID pStructure, const MARSHALLING_INFO *pInfo, DWORD cbStructureSize, BOOL bSomeBoolean)
MarshallDownStructuresArray
Prepare an array of structures for marshalling/serialization by replacing absolute pointer addresses in its fields by relative offsets. Parameters pStructuresArray Pointer to the array of structures to operate on. cElements Number of array elements. pInfo Array of MARSHALLING_INFO elements containing information about the fields of the structure as well as how to modify them. See the documentation on MARSHALLING_INFO for more information. You have to indicate the end of the array by setting the dwOffset field to MAXDWORD. cbStructureSize Size in bytes of each structure array element. bSomeBoolean Unknown boolean value, set to TRUE. Returns TRUE if the array was successfully adjusted, FALSE otherwise.
BOOL WINAPI	MarshallDownStructuresArray (PVOID pStructuresArray, DWORD cElements, const MARSHALLING_INFO *pInfo, DWORD cbStructureSize, BOOL bSomeBoolean)
MarshallUpStructure
Unmarshall/deserialize a structure previuosly marshalled by MarshallDownStructure by replacing relative offsets in its fields by absolute pointer addresses again. Parameters cbSize Size in bytes of the memory allocated for both the structure and its data. The function will check if all relative offsets are within the bounds given by this size. pStructure Pointer to the structure to operate on. pInfo Array of MARSHALLING_INFO elements containing information about the fields of the structure as well as how to modify them. See the documentation on MARSHALLING_INFO for more information. You have to indicate the end of the array by setting the dwOffset field to MAXDWORD. cbStructureSize Size in bytes of the structure. This parameter is unused in my implementation. bSomeBoolean Unknown boolean value, set to TRUE. Returns TRUE if the structure was successfully adjusted, FALSE otherwise.
BOOL WINAPI	MarshallUpStructure (DWORD cbSize, PVOID pStructure, const MARSHALLING_INFO *pInfo, DWORD cbStructureSize, BOOL bSomeBoolean)
MarshallUpStructuresArray
Unmarshall/deserialize an array of structures previuosly marshalled by MarshallDownStructuresArray by replacing relative offsets in its fields by absolute pointer addresses again. Parameters cbSize Size in bytes of the memory allocated for the entire structure array and its data. The function will check if all relative offsets are within the bounds given by this size. pStructuresArray Pointer to the array of structures to operate on. cElements Number of array elements. pInfo Array of MARSHALLING_INFO elements containing information about the fields of the structure as well as how to modify them. See the documentation on MARSHALLING_INFO for more information. You have to indicate the end of the array by setting the dwOffset field to MAXDWORD. cbStructureSize Size in bytes of each structure array element. bSomeBoolean Unknown boolean value, set to TRUE. Returns TRUE if the array was successfully adjusted, FALSE otherwise.
BOOL WINAPI	MarshallUpStructuresArray (DWORD cbSize, PVOID pStructuresArray, DWORD cElements, const MARSHALLING_INFO *pInfo, DWORD cbStructureSize, BOOL bSomeBoolean)

Macro Definition Documentation

WIN32_NO_STATUS

#define WIN32_NO_STATUS

Definition at line 8 of file marshalling.c.

Function Documentation

MarshallDownStructure()

BOOL WINAPI MarshallDownStructure	(	PVOID	pStructure,
		const MARSHALLING_INFO *	pInfo,
		DWORD	cbStructureSize,
		BOOL	bSomeBoolean
	)

Definition at line 38 of file marshalling.c.

{
    // Sanity checks
    if (!pStructure || !pInfo)
    {
        SetLastError(ERROR_INVALID_PARAMETER);
        return FALSE;
    }
 
    // Loop until we reach an element with offset set to MAXDWORD.
    while (pInfo->dwOffset != MAXDWORD)
    {
        PULONG_PTR pCurrentField = (PULONG_PTR)((PBYTE)pStructure + pInfo->dwOffset);
 
        if (pInfo->bAdjustAddress && *pCurrentField)
        {
            // Make a relative offset out of the absolute pointer address.
            *pCurrentField -= (ULONG_PTR)pStructure;
        }
 
        // Advance to the next field description.
        pInfo++;
    }
 
    return TRUE;
}

Referenced by _RpcAddJob(), _RpcGetForm(), _RpcGetJob(), _RpcGetPrinter(), _RpcGetPrinterDriver(), _RpcGetPrinterDriver2(), MarshallDownStructuresArray(), and YGetPrinterDriver2().

MarshallDownStructuresArray()

BOOL WINAPI MarshallDownStructuresArray	(	PVOID	pStructuresArray,
		DWORD	cElements,
		const MARSHALLING_INFO *	pInfo,
		DWORD	cbStructureSize,
		BOOL	bSomeBoolean
	)

Definition at line 91 of file marshalling.c.

{
    PBYTE pCurrentElement = pStructuresArray;
 
    // Call MarshallDownStructure on all array elements given by cElements of cbStructureSize.
    while (cElements--)
    {
        if (!MarshallDownStructure(pCurrentElement, pInfo, cbStructureSize, bSomeBoolean))
            return FALSE;
 
        // Advance to the next array element.
        pCurrentElement += cbStructureSize;
    }
 
    return TRUE;
}

Referenced by _RpcEnumForms(), _RpcEnumJobs(), _RpcEnumMonitors(), _RpcEnumPorts(), _RpcEnumPrinterDrivers(), _RpcEnumPrinters(), _RpcEnumPrintProcessorDatatypes(), _RpcEnumPrintProcessors(), and START_TEST().

MarshallUpStructure()

BOOL WINAPI MarshallUpStructure	(	DWORD	cbSize,
		PVOID	pStructure,
		const MARSHALLING_INFO *	pInfo,
		DWORD	cbStructureSize,
		BOOL	bSomeBoolean
	)

Definition at line 137 of file marshalling.c.

{
    // Sanity checks
    if (!pStructure || !pInfo)
    {
        SetLastError(ERROR_INVALID_PARAMETER);
        return FALSE;
    }
 
    // Loop until we reach an element with offset set to MAXDWORD.
    while (pInfo->dwOffset != MAXDWORD)
    {
        PULONG_PTR pCurrentField = (PULONG_PTR)((PBYTE)pStructure + pInfo->dwOffset);
 
        if (pInfo->bAdjustAddress && *pCurrentField)
        {
            // Verify that the offset in the current field is within the bounds given by cbSize.
            if (cbSize <= *pCurrentField)
            {
                SetLastError(ERROR_INVALID_DATA);
                return FALSE;
            }
 
            // Make an absolute pointer address out of the relative offset.
            *pCurrentField += (ULONG_PTR)pStructure;
        }
 
        // Advance to the next field description.
        pInfo++;
    }
 
    return TRUE;
}

Referenced by AddJobW(), GetFormW(), GetJobW(), GetPrinterDriverW(), GetPrinterW(), and MarshallUpStructuresArray().

MarshallUpStructuresArray()

BOOL WINAPI MarshallUpStructuresArray	(	DWORD	cbSize,
		PVOID	pStructuresArray,
		DWORD	cElements,
		const MARSHALLING_INFO *	pInfo,
		DWORD	cbStructureSize,
		BOOL	bSomeBoolean
	)

Definition at line 202 of file marshalling.c.

{
    PBYTE pCurrentElement = pStructuresArray;
 
    // Call MarshallUpStructure on all array elements given by cElements of cbStructureSize.
    while (cElements--)
    {
        if (!MarshallUpStructure(cbSize, pCurrentElement, pInfo, cbStructureSize, bSomeBoolean))
            return FALSE;
 
        // Advance to the next array element.
        pCurrentElement += cbStructureSize;
    }
 
    return TRUE;
}

Referenced by EnumFormsW(), EnumJobsW(), EnumMonitorsW(), EnumPortsW(), EnumPrinterDriversW(), EnumPrintersW(), EnumPrintProcessorDatatypesW(), EnumPrintProcessorsW(), and START_TEST().