marshalling.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_MARSHALLING_INFO
struct	_MARSHALLING

Typedefs
typedef struct _MARSHALLING_INFO	MARSHALLING_INFO
typedef struct _MARSHALLING	MARSHALLING

Functions
BOOL WINAPI	MarshallDownStructure (PVOID pStructure, const MARSHALLING_INFO *pInfo, DWORD cbStructureSize, BOOL bSomeBoolean)
BOOL WINAPI	MarshallDownStructuresArray (PVOID pStructuresArray, DWORD cElements, const MARSHALLING_INFO *pInfo, DWORD cbStructureSize, BOOL bSomeBoolean)
BOOL WINAPI	MarshallUpStructure (DWORD cbSize, PVOID pStructure, const MARSHALLING_INFO *pInfo, DWORD cbStructureSize, BOOL bSomeBoolean)
BOOL WINAPI	MarshallUpStructuresArray (DWORD cbSize, PVOID pStructuresArray, DWORD cElements, const MARSHALLING_INFO *pInfo, DWORD cbStructureSize, BOOL bSomeBoolean)

Typedef Documentation

MARSHALLING

typedef struct _MARSHALLING MARSHALLING

MARSHALLING_INFO

typedef struct _MARSHALLING_INFO MARSHALLING_INFO

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().