You Dirty Rat

  • Article

[This is now documented here: https://msdn.microsoft.com/en-us/library/gg262878.aspx ]

Another in the series of APIs Development asked me to document. This time, it’s a property you can request via IDispatch to ask if an item is dirty or not. Same as last time, I didn’t test this code, so I’d appreciate feedback.

dispidFDirty

This property is used to tell if an Outlook item (such as a MailItem or ContactItem) is in the Dirty state. An item is considered Dirty when it has unsaved changes.

Syntax

Given an item pointer, use QueryInterface to obtain an IDispatch interface pointer. Then call IDispatch::Invoke with dispidFDirty and the flags DISPATCH_METHOD | DISPATCH_PROPERTYGET.

Sample Code

 #define dispidFDirty 0xF024

bool FIsItemDirty(IDispatch *pdisp)

{

    DISPPARAMS dispparams;

    UINT uArgErr;

    HRESULT hr = S_OK;

    CComVariant varDirty;

    dispparams.rgvarg = 0;

    dispparams.cArgs = 0;

    dispparams.cNamedArgs = 0;

    dispparams.rgdispidNamedArgs = NULL;

    hr = pdisp->Invoke(dispidFDirty,

        IID_NULL,

        LOCALE_SYSTEM_DEFAULT,

        DISPATCH_METHOD | DISPATCH_PROPERTYGET,

        &dispparams,

        &varDirty,

        NULL,

        &uArgErr);

    return SUCCEEDED(hr) && varDirty.bVal;

}