clipboard.h File Reference

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

Go to the source code of this file.

Classes
struct	_CLIP

Typedefs
typedef struct _CLIP	CLIP
typedef struct _CLIP *	PCLIP

Functions
UINT APIENTRY	UserEnumClipboardFormats (UINT uFormat)
VOID FASTCALL	UserClipboardRelease (PWND pWindow)
VOID FASTCALL	UserClipboardFreeWindow (PWND pWindow)
BOOL NTAPI	UserOpenClipboard (HWND hWnd)
BOOL NTAPI	UserCloseClipboard (VOID)
BOOL NTAPI	UserEmptyClipboard (VOID)
VOID NTAPI	UserEmptyClipboardData (struct _WINSTATION_OBJECT *pWinSta)
HANDLE NTAPI	UserSetClipboardData (UINT fmt, HANDLE hData, PSETCLIPBDATA scd)

Typedef Documentation

CLIP

typedef struct _CLIP CLIP

PCLIP

typedef struct _CLIP * PCLIP

Function Documentation

UserClipboardFreeWindow()

VOID FASTCALL UserClipboardFreeWindow

(

PWND

pWindow

)

Definition at line 414 of file clipboard.c.

{
    PWINSTATION_OBJECT pWinStaObj;
 
    pWinStaObj = IntGetWinStaForCbAccess();
    if (!pWinStaObj)
        return;
 
    if (pWindow == pWinStaObj->spwndClipOwner)
    {
        /* The owner window was destroyed */
        pWinStaObj->spwndClipOwner = NULL;
    }
 
    /* Check if clipboard is not locked by this window, if yes, unlock it */
    if (pWindow == pWinStaObj->spwndClipOpen)
    {
        /* The window that opens the clipboard was destroyed */
        pWinStaObj->spwndClipOpen = NULL;
        pWinStaObj->ptiClipLock = NULL;
    }
    /* Remove window from window chain */
    if (pWindow == pWinStaObj->spwndClipViewer)
        pWinStaObj->spwndClipViewer = NULL;
 
    ObDereferenceObject(pWinStaObj);
}

Referenced by co_UserFreeWindow().

UserClipboardRelease()

VOID FASTCALL UserClipboardRelease

(

PWND

pWindow

)

Definition at line 374 of file clipboard.c.

{
    PWINSTATION_OBJECT pWinStaObj;
 
    if (!pWindow)
        return;
 
    pWinStaObj = IntGetWinStaForCbAccess();
    if (!pWinStaObj)
        return;
 
    co_IntSendMessage(UserHMGetHandle(pWinStaObj->spwndClipOwner), WM_RENDERALLFORMATS, 0, 0);
 
    /* If the window being destroyed is the current clipboard owner... */
    if (pWindow == pWinStaObj->spwndClipOwner)
    {
        /* ... make it release the clipboard */
        pWinStaObj->spwndClipOwner = NULL;
    }
 
    if (pWinStaObj->fClipboardChanged)
    {
        /* Add synthesized formats - they are rendered later */
        IntAddSynthesizedFormats(pWinStaObj);
 
        /* Notify viewer windows in chain */
        pWinStaObj->fClipboardChanged = FALSE;
        if (pWinStaObj->spwndClipViewer)
        {
            TRACE("Clipboard: sending WM_DRAWCLIPBOARD to %p\n", UserHMGetHandle(pWinStaObj->spwndClipViewer));
            // For 32-bit applications this message is sent as a notification
            co_IntSendMessageNoWait(UserHMGetHandle(pWinStaObj->spwndClipViewer), WM_DRAWCLIPBOARD, 0, 0);
        }
    }
 
    ObDereferenceObject(pWinStaObj);
}

Referenced by IntSendDestroyMsg().

UserCloseClipboard()

BOOL NTAPI UserCloseClipboard

(

VOID

)

Definition at line 545 of file clipboard.c.

{
    BOOL bRet = FALSE;
    PWINSTATION_OBJECT pWinStaObj;
 
    pWinStaObj = IntGetWinStaForCbAccess();
    if (!pWinStaObj)
        goto cleanup;
 
    /* Check if the clipboard has been opened */
    if (!IntIsClipboardOpenByMe(pWinStaObj))
    {
        EngSetLastError(ERROR_CLIPBOARD_NOT_OPEN);
        goto cleanup;
    }
 
    /* Clipboard is no longer open */
    pWinStaObj->spwndClipOpen = NULL;
    pWinStaObj->ptiClipLock = NULL;
    bRet = TRUE;
 
    if (pWinStaObj->fClipboardChanged)
    {
        /* Add synthesized formats - they are rendered later */
        IntAddSynthesizedFormats(pWinStaObj);
 
        /* Notify viewer windows in chain */
        pWinStaObj->fClipboardChanged = FALSE;
        if (pWinStaObj->spwndClipViewer)
        {
            TRACE("Clipboard: sending WM_DRAWCLIPBOARD to %p\n", UserHMGetHandle(pWinStaObj->spwndClipViewer));
            // For 32-bit applications this message is sent as a notification
            co_IntSendMessageNoWait(UserHMGetHandle(pWinStaObj->spwndClipViewer), WM_DRAWCLIPBOARD, 0, 0);
        }
    }
 
cleanup:
    if (pWinStaObj)
        ObDereferenceObject(pWinStaObj);
 
    return bRet;
}

Referenced by DefWndScreenshot(), ExitThreadCallback(), NtUserCloseClipboard(), and SnapWindow().

UserEmptyClipboard()

BOOL NTAPI UserEmptyClipboard

(

VOID

)

Definition at line 680 of file clipboard.c.

{
    BOOL bRet = FALSE;
    PWINSTATION_OBJECT pWinStaObj;
 
    pWinStaObj = IntGetWinStaForCbAccess();
    if (!pWinStaObj)
        return FALSE;
 
    /* Check if the clipboard has been opened */
    if (!IntIsClipboardOpenByMe(pWinStaObj))
    {
        EngSetLastError(ERROR_CLIPBOARD_NOT_OPEN);
        goto cleanup;
    }
 
    UserEmptyClipboardData(pWinStaObj);
 
    if (pWinStaObj->spwndClipOwner)
    {
        TRACE("Clipboard: WM_DESTROYCLIPBOARD to %p\n", UserHMGetHandle(pWinStaObj->spwndClipOwner));
        // For 32-bit applications this message is sent as a notification
        co_IntSendMessage(UserHMGetHandle(pWinStaObj->spwndClipOwner), WM_DESTROYCLIPBOARD, 0, 0);
    }
 
    pWinStaObj->spwndClipOwner = pWinStaObj->spwndClipOpen;
 
    pWinStaObj->iClipSerialNumber++;
    pWinStaObj->iClipSequenceNumber++;
    pWinStaObj->fClipboardChanged = TRUE;
    pWinStaObj->fInDelayedRendering = FALSE;
 
    bRet = TRUE;
 
cleanup:
    if (pWinStaObj)
        ObDereferenceObject(pWinStaObj);
 
    return bRet;
}

Referenced by DefWndScreenshot(), NtUserEmptyClipboard(), and SnapWindow().

UserEmptyClipboardData()

VOID NTAPI UserEmptyClipboardData

(

struct _WINSTATION_OBJECT *

pWinSta

)

UserEnumClipboardFormats()

UINT APIENTRY UserEnumClipboardFormats

(

UINT

uFormat

)

Definition at line 443 of file clipboard.c.

{
    UINT Ret = 0;
    PCLIP pElement;
    PWINSTATION_OBJECT pWinStaObj;
 
    pWinStaObj = IntGetWinStaForCbAccess();
    if (!pWinStaObj)
        goto cleanup;
 
    /* Check if the clipboard has been opened */
    if (!IntIsClipboardOpenByMe(pWinStaObj))
    {
        EngSetLastError(ERROR_CLIPBOARD_NOT_OPEN);
        goto cleanup;
    }
 
    if (fmt == 0)
    {
        /* Return first format */
        if (pWinStaObj->pClipBase)
            Ret = pWinStaObj->pClipBase[0].fmt;
    }
    else
    {
        /* Return next format */
        pElement = IntGetFormatElement(pWinStaObj, fmt);
        if (pElement != NULL)
        {
            ++pElement;
            if (pElement < &pWinStaObj->pClipBase[pWinStaObj->cNumClipFormats])
            {
                Ret = pElement->fmt;
            }
        }
    }
 
cleanup:
    if (pWinStaObj)
        ObDereferenceObject(pWinStaObj);
 
    return Ret;
}

Referenced by NtUserCallOneParam().

UserOpenClipboard()

BOOL NTAPI UserOpenClipboard

(

HWND

hWnd

)

Definition at line 488 of file clipboard.c.

{
    PWND pWindow = NULL;
    BOOL bRet = FALSE;
    PWINSTATION_OBJECT pWinStaObj = NULL;
 
    if (hWnd)
    {
        pWindow = UserGetWindowObject(hWnd);
        if (!pWindow)
            goto cleanup;
    }
 
    pWinStaObj = IntGetWinStaForCbAccess();
    if (!pWinStaObj)
        goto cleanup;
 
    /* Check if we already opened the clipboard */
    if ((pWindow == pWinStaObj->spwndClipOpen) && IntIsClipboardOpenByMe(pWinStaObj))
    {
        bRet = TRUE;
        goto cleanup;
    }
 
    /* If the clipboard was already opened by somebody else, bail out */
    if ((pWindow != pWinStaObj->spwndClipOpen) && pWinStaObj->ptiClipLock)
    {
        ERR("Access denied!\n");
        EngSetLastError(ERROR_ACCESS_DENIED);
        goto cleanup;
    }
 
    /* Open the clipboard */
    pWinStaObj->spwndClipOpen = pWindow;
    pWinStaObj->ptiClipLock = PsGetCurrentThreadWin32Thread();
    bRet = TRUE;
 
cleanup:
    if (pWinStaObj)
        ObDereferenceObject(pWinStaObj);
 
    return bRet;
}

Referenced by DefWndScreenshot(), NtUserOpenClipboard(), and SnapWindow().

UserSetClipboardData()

HANDLE NTAPI UserSetClipboardData	(	UINT	fmt,
		HANDLE	hData,
		PSETCLIPBDATA	scd
	)

Definition at line 1023 of file clipboard.c.

{
    HANDLE hRet = NULL;
    PWINSTATION_OBJECT pWinStaObj;
 
    pWinStaObj = IntGetWinStaForCbAccess();
    if (!pWinStaObj)
        goto cleanup;
 
    if (!fmt || !pWinStaObj->ptiClipLock)
    {
        ERR("Access denied!\n");
        EngSetLastError(ERROR_CLIPBOARD_NOT_OPEN);
        goto cleanup;
    }
 
    if (scd->fIncSerialNumber)
        pWinStaObj->iClipSerialNumber++;
 
    /* Is it a delayed rendering? */
    if (hData)
    {
        /* Is it a bitmap? */
        if (fmt == CF_BITMAP)
        {
            /* Make bitmap public */
            GreSetObjectOwner(hData, GDI_OBJ_HMGR_PUBLIC);
        }
 
        /* Save data in the clipboard */
        IntAddFormatedData(pWinStaObj, fmt, hData, scd->fGlobalHandle, FALSE);
        TRACE("hData stored\n");
 
        /* If the serial number was increased, increase also the sequence number */
        if (scd->fIncSerialNumber)
            pWinStaObj->iClipSequenceNumber++;
 
        pWinStaObj->fClipboardChanged = TRUE;
 
        /* Note: Synthesized formats are added in NtUserCloseClipboard */
    }
    else
    {
        /* This is a delayed rendering */
        IntAddFormatedData(pWinStaObj, fmt, DATA_DELAYED, FALSE, FALSE);
        TRACE("SetClipboardData delayed format: %u\n", fmt);
    }
 
    /* Return hData on success */
    hRet = hData;
 
cleanup:
    TRACE("NtUserSetClipboardData returns: %p\n", hRet);
 
    if (pWinStaObj)
        ObDereferenceObject(pWinStaObj);
 
    return hRet;
}

Referenced by DefWndScreenshot(), NtUserSetClipboardData(), and SnapWindow().