Sample Code

Windows Driver Samples/ XPSDrv Driver and Filter Sample/ C++/ src/ ui/ xdsmplui.cpp/

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
/*++
 
Copyright (c) 2005 Microsoft Corporation
 
All rights reserved.
 
THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF
ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE.
 
File Name:
 
   xdsmplui.cpp
 
Abstract:
 
   Implementation of the UI plugin. This is responsible for initialising and maintaining
   the property pages used in the XPSDrv feature sample UI.
 
--*/
 
#include "precomp.h"
#include "debug.h"
#include "globals.h"
#include "xdexcept.h"
#include "xdstring.h"
#include "xdsmplui.h"
#include "colppg.h"
#include "wmppg.h"
#include "ftrppg.h"
#include "UIProperties.h"
 
/*++
 
Routine Name:
 
    CXDSmplUI::CXDSmplUI
 
Routine Description:
 
    CXDSmplUI class constructor.
    Creates a handler class object for every property page added in Unidrv UI Plug-in.
    Each of these handlers is stored in a collection.
 
 
Arguments:
 
    None
 
Return Value:
 
    None
 
--*/
CXDSmplUI::CXDSmplUI() :
    CUnknown<IPrintOemUI>(IID_IPrintOemUI),
    m_pDriverUIHelp(NULL),
    m_pOemCUIPParam(NULL),
    m_pUIProperties(NULL)
{
}
 
/*++
 
Routine Name:
 
    CXDSmplUI::~CXDSmplUI
 
Routine Description:
 
    CXDSmplUI class destructor.
 
Arguments:
 
    None
 
Return Value:
 
    None.
 
--*/
CXDSmplUI::~CXDSmplUI()
{
    DestroyPropPages();
}
 
/*++
 
Routine Name:
 
    CXDSmplUI::PublishDriverInterface
 
Routine Description:
 
    The PublishDriverInterface method allows a user interface plug-in to obtain
    the Unidrv driver's IPrintOemDriverUI interface.
 
Arguments:
 
    pIUnknown - Caller-supplied pointer to the IUnknown interface of the driver's
                IPrintOemDriverUI COM Interface.
 
Return Value:
 
    HRESULT
    S_OK - On success
    E_*  - On error
 
--*/
HRESULT
CXDSmplUI::PublishDriverInterface(
    _In_ IUnknown* pIUnknown
    )
{
    HRESULT hr = E_FAIL;
    PVOID   pInterface = NULL;
 
    if (m_pDriverUIHelp == NULL &&
        SUCCEEDED(hr = pIUnknown->QueryInterface(IID_IPrintOemDriverUI, &pInterface)))
    {
        m_pDriverUIHelp = reinterpret_cast<IPrintOemDriverUI*>(pInterface);
        hr = S_OK;
    }
 
    return hr;
}
 
/*++
 
Routine Name:
 
    CXDSmplUI::GetInfo
 
Routine Description:
 
    Unidrv will call this routine to obtain identification information.
 
Arguments:
 
    dwMode - Supported modes are OEMGI_GETSIGNATURE and OEMGI_GETVERSION.
    pBuffer - Caller-supplied pointer to memory allocated to receive the information specified by dwMode.
    cbSize - Caller-supplied size of the buffer pointed to by pBuffer.
    pcbNeeded - Caller-supplied pointer to a location to receive the number of bytes written into the buffer pointed to by pBuffer.
 
Return Value:
 
    HRESULT
    S_OK - On success
    E_*  - On error
 
--*/
HRESULT
CXDSmplUI::GetInfo(
    _In_  DWORD  dwMode,
    _Out_writes_bytes_(cbSize) PVOID  pBuffer,
    _In_  DWORD  cbSize,
    _Out_ PDWORD pcbNeeded
    )
{
    HRESULT hr = S_OK;
 
    if ((NULL == pcbNeeded) ||
        ((OEMGI_GETSIGNATURE != dwMode) &&
         (OEMGI_GETVERSION != dwMode) &&
         (OEMGI_GETREQUESTEDHELPERINTERFACES != dwMode)))
    {
        SetLastError(ERROR_INVALID_PARAMETER);
        hr = E_INVALIDARG;
    }
    else
    {
        *pcbNeeded = sizeof(DWORD);
 
        if ((cbSize < *pcbNeeded) ||
            (NULL == pBuffer))
        {
            SetLastError(ERROR_INSUFFICIENT_BUFFER);
            hr = HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER);
        }
        else
        {
            switch (dwMode)
            {
                case OEMGI_GETSIGNATURE:
                {
                    *reinterpret_cast<PDWORD>(pBuffer) = OEM_SIGNATURE;
                }
                break;
 
                case OEMGI_GETVERSION:
                {
                    *reinterpret_cast<PDWORD>(pBuffer) = OEM_VERSION;
                }
                break;
 
                default:
                {
                    *pcbNeeded = 0;
                    hr = E_NOTIMPL;
                }
                break;
            }
        }
    }
 
    ERR_ON_HR_EXC(hr, E_NOTIMPL);
    return hr;
}
 
/*++
 
Routine Name:
 
    CXDSmplUI::DevMode
 
Routine Description:
 
    Performs operation on UI Plugins Private DevMode Members.
    Called via IPrintOemUI::DevMode
 
Arguments:
 
    dwMode - Supported modes are OEMDM_SIZE, OEMDM_DEFAULT, OEMDM_CONVERT and OEMDM_MERGE.
    pOemDMParam - Caller-supplied pointer to an OEMDMPARAM structure.
                  Dependent on which dwMode is set.
 
Return Value:
 
    HRESULT
    S_OK - On success
    E_*  - On error
 
--*/
HRESULT
CXDSmplUI::DevMode(
    _In_ DWORD       dwMode,
    _In_ POEMDMPARAM pOemDMParam
    )
{
    HRESULT hr = S_OK;
 
    if (SUCCEEDED(hr = CHECK_POINTER(pOemDMParam, E_POINTER)))
    {
        if ((OEMDM_SIZE != dwMode) &&
            (OEMDM_DEFAULT != dwMode) &&
            (OEMDM_CONVERT != dwMode)&&
            (OEMDM_MERGE != dwMode))
        {
            hr = E_INVALIDARG;
        }
    }
 
    if (SUCCEEDED(hr))
    {
        switch (dwMode)
        {
            //
            // The method should return the size of the memory allocation needed to store the UI plugin Private DEVMODE.
            //
            case OEMDM_SIZE:
            {
                pOemDMParam->cbBufSize = sizeof(OEMDEV);
            }
            break;
 
            //
            // Should fill the Private DEVMODE with the default values.
            //
            case OEMDM_DEFAULT:
            {
                try
                {
                    if (SUCCEEDED(hr = CHECK_POINTER(pOemDMParam->pOEMDMOut, E_POINTER)))
                    {
                        CUIProperties oemDevOut = CUIProperties(reinterpret_cast<POEMDEV>(pOemDMParam->pOEMDMOut));
 
                        hr = oemDevOut.SetDefaults();
                    }
                }
                catch (CXDException &e)
                {
                    hr = e;
                }
                catch (...)
                {
                    hr = E_FAIL;
                }
            }
            break;
 
            //
            // The method should convert private DEVMODE members to the current version, if necessary.
            //
            case OEMDM_CONVERT:
            {
                try
                {
                    if (SUCCEEDED(hr = CHECK_POINTER(pOemDMParam->pOEMDMOut, E_POINTER)) &&
                        SUCCEEDED(hr = CHECK_POINTER(pOemDMParam->pOEMDMIn, E_POINTER)))
                    {
                        CUIProperties oemDevIn  = CUIProperties(reinterpret_cast<POEMDEV>(pOemDMParam->pOEMDMIn));
                        CUIProperties oemDevOut = CUIProperties(reinterpret_cast<POEMDEV>(pOemDMParam->pOEMDMOut));
 
                        hr = oemDevOut.Convert(&oemDevIn);
                    }
                }
                catch (CXDException &e)
                {
                    hr = e;
                }
                catch (...)
                {
                    hr = E_FAIL;
                }
            }
            break;
 
            //
            //The method should validate the information contained in private DEVMODE members and merge validated values into a private DEVMODE structure containing default values
            //
            case OEMDM_MERGE:
            {
                try
                {
                    if (SUCCEEDED(hr = CHECK_POINTER(pOemDMParam->pOEMDMOut, E_POINTER)) &&
                        SUCCEEDED(hr = CHECK_POINTER(pOemDMParam->pOEMDMIn, E_POINTER)))
                    {
                        CUIProperties oemDevIn  = CUIProperties(reinterpret_cast<POEMDEV>(pOemDMParam->pOEMDMIn));
                        CUIProperties oemDevOut = CUIProperties(reinterpret_cast<POEMDEV>(pOemDMParam->pOEMDMOut));
 
                        if (SUCCEEDED(hr = oemDevOut.Convert(&oemDevIn)))
                        {
                            hr = oemDevOut.Validate();
                        }
                    }
                }
                catch (CXDException &e)
                {
                    hr = e;
                }
                catch (...)
                {
                    hr = E_FAIL;
                }
            }
            break;
        }
    }
 
    ERR_ON_HR(hr);
    return hr;
}
 
/*++
 
Routine Name:
 
    CXDSmplUI::CommonUIProp
 
Routine Description:
 
    This method allows a user interface plug-in to modify an existing printer property sheet page.
 
Arguments:
 
    dwMode - Supported modes are OEMCUIP_DOCPROP and OEMCUIP_PRNPROP.
    pOemCUIPParam - Caller-supplied pointer to an OEMCUIPPARAM structure.
 
Return Value:
 
    HRESULT
    S_OK - On success
    E_*  - On error
 
--*/
HRESULT
CXDSmplUI::CommonUIProp(
    _In_ DWORD dwMode,
    _In_ POEMCUIPPARAM pOemCUIPParam
    )
{
    HRESULT hr = S_OK;
 
    if (dwMode == OEMCUIP_PRNPROP)
    {
        //
        // We do not implement any printer property sheets
        //
        hr = E_NOTIMPL;
    }
    else if (dwMode != OEMCUIP_DOCPROP)
    {
        //
        // Unknown mode encountered
        //
        hr = E_INVALIDARG;
    }
 
    if (SUCCEEDED(hr) &&
        SUCCEEDED(hr = CHECK_POINTER(pOemCUIPParam, E_POINTER)))
    {
        //
        // Store the OEMCUIPPARAM pointer so we can modify data and OPTITEMS.
        //
        m_pOemCUIPParam = pOemCUIPParam;
 
        //
        // The pDrvOptItems member is NULL on the first call through to CommonUIProp().
        //
        if (pOemCUIPParam->pDrvOptItems != NULL)
        {
            try
            {
                CUIProperties uiProperties;
                hr = uiProperties.HideOptItems(pOemCUIPParam);
            }
            catch (CXDException& e)
            {
                hr = e;
            }
            catch (...)
            {
                hr = E_FAIL;
            }
        }
    }
 
    ERR_ON_HR_EXC(hr, E_NOTIMPL);
    return hr;
}
 
/*++
 
Routine Name:
 
    CXDSmplUI::DocumentPropertySheets
 
Routine Description:
 
    This method allows a user interface plug-in to append a new page to a printer device's
    document property sheet.
 
Arguments:
 
    pPSUIInfo - Caller-supplied pointer to a PROPSHEETUI_INFO structure.
    lParam - Caller-supplied value that depends on the reason value in pPSUIInfo->Reason.
 
Return Value:
 
    HRESULT
    S_OK - On success
    E_*  - On error
 
--*/
HRESULT
CXDSmplUI::DocumentPropertySheets(
    _In_ PPROPSHEETUI_INFO pPSUIInfo,
    _In_ LPARAM            lParam
    )
{
    HRESULT hr = S_OK;
 
    if (pPSUIInfo == NULL ||
        pPSUIInfo->Version != PROPSHEETUI_INFO_VERSION)
    {
        SetLastError(ERROR_INVALID_PARAMETER);
        hr = E_INVALIDARG;
    }
    else
    {
        switch (pPSUIInfo->Reason)
        {
            case PROPSHEETUI_REASON_INIT:
            {
                //
                // We need to report the OEMCUIPPARAM structure to the prop sheet
                // so ASSERT it is valid. We will let the prop sheet decide if it
                // is critical to have a valid pointer or not
                //
                ASSERTMSG(m_pOemCUIPParam != NULL, "NULL pointer to OEMCUIPPARAM structure.\n");
 
                try
                {
                    //
                    // Create the UI properties object
                    //
                    m_pUIProperties = new(std::nothrow) CUIProperties(reinterpret_cast<POEMDEV>(m_pOemCUIPParam->pOEMDM));
 
                    //
                    // Create the property pages for the document property sheet
                    //
                    if (SUCCEEDED(hr = CHECK_POINTER(m_pUIProperties, E_OUTOFMEMORY)) &&
                        SUCCEEDED(hr = CreatePropertyPages()))
                    {
                        DocPropertyPageMap::iterator iterPropSheets = m_vectPropPages.begin();
 
                        //
                        // Make sure the helper interfaces and the OEMCUIPPARAM structure
                        // are published to the page first. This allows the prop sheet to
                        // propogate these interfaces to the UI control objects when initializing
                        //
                        while (iterPropSheets != m_vectPropPages.end() &&
                               SUCCEEDED(hr = CHECK_POINTER(*iterPropSheets, E_FAIL)) &&
                               SUCCEEDED(hr = (*iterPropSheets)->SetPrintOemDriverUI(m_pDriverUIHelp)) &&
                               SUCCEEDED(hr = (*iterPropSheets)->SetOemCUIPParam(m_pOemCUIPParam))&&
                               SUCCEEDED(hr = (*iterPropSheets)->SetUIProperties(m_pUIProperties))&&
                               SUCCEEDED(hr = (*iterPropSheets)->PropPageInit(pPSUIInfo)))
                        {
                            iterPropSheets++;
                        }
                    }
                }
                catch (CXDException &e)
                {
                    hr = e;
                }
                catch (exception& DBG_ONLY(e))
                {
                    ERR(e.what());
                    hr = E_FAIL;
                }
            }
            break;
 
            case PROPSHEETUI_REASON_GET_INFO_HEADER:
            {
                if (SUCCEEDED(hr = CHECK_POINTER(pPSUIInfo, E_POINTER)))
                {
                    pPSUIInfo->Result = TRUE;
                }
            }
            break;
 
            case PROPSHEETUI_REASON_DESTROY:
            {
                if (SUCCEEDED(hr = CHECK_POINTER(pPSUIInfo, E_POINTER)))
                {
                    pPSUIInfo->Result = TRUE;
                }
            }
            break;
 
            case PROPSHEETUI_REASON_SET_RESULT:
            {
                if (SUCCEEDED(hr = CHECK_POINTER(pPSUIInfo, E_POINTER)))
                {
                    pPSUIInfo->Result = reinterpret_cast<PSETRESULT_INFO>(lParam)->Result;
                }
            }
            break;
 
            case PROPSHEETUI_REASON_GET_ICON:
            {
                if (SUCCEEDED(hr = CHECK_POINTER(pPSUIInfo, E_POINTER)))
                {
                    //
                    // No icon
                    //
                    pPSUIInfo->Result = FALSE;
                }
            }
            break;
 
            default:
            {
                hr = E_FAIL;
            }
            break;
        }
    }
 
    ERR_ON_HR(hr);
    return hr;
}
 
/*++
 
Routine Name:
 
    CXDSmplUI::DevicePropertySheets
 
Routine Description:
 
    This method allows a user interface plug-in to append a new page to a printer device's
    printer property sheet.
 
Arguments:
 
    None referenced.
 
Return Value:
 
    HRESULT
    E_NOTIMPL - Method not implemented
 
--*/
HRESULT
CXDSmplUI::DevicePropertySheets(
     _In_ PPROPSHEETUI_INFO,
     _In_ LPARAM
     )
{
    return E_NOTIMPL;
}
 
/*++
 
Routine Name:
 
    CXDSmplUI::DevQueryPrintEx
 
Routine Description:
 
    This method allows a user interface plug-in to help determine if a print job is printable.
 
Arguments:
 
    None referenced.
 
Return Value:
 
    HRESULT
    E_NOTIMPL - Method not implemented
 
--*/
HRESULT
CXDSmplUI::DevQueryPrintEx(
    _In_ POEMUIOBJ,
    _In_ PDEVQUERYPRINT_INFO,
    _In_ PDEVMODE,
    _In_ PVOID
    )
{
    return E_NOTIMPL;
}
 
/*++
 
Routine Name:
 
    CXDSmplUI::DeviceCapabilities
 
Routine Description:
 
    This method enables a user interface plug-in to specify customized device capabilities.
 
Arguments:
 
    None referenced.
 
Return Value:
 
    HRESULT
    E_NOTIMPL - Method not implemented
 
--*/
HRESULT
CXDSmplUI::DeviceCapabilities(
    _In_   POEMUIOBJ,
    _In_   HANDLE,
    _In_z_ PWSTR,
    _In_   WORD,
    _In_   PVOID,
    _In_   PDEVMODE,
    _In_   PVOID,
    _In_   DWORD,
    _In_   DWORD*
    )
{
    return E_NOTIMPL;
}
 
/*++
 
Routine Name:
 
    CXDSmplUI::UpgradePrinter
 
Routine Description:
 
    This method allows a user interface plug-in to upgrade device option values
    that are stored in the registry.
 
Arguments:
 
    None referenced.
 
Return Value:
 
    HRESULT
    E_NOTIMPL - Method not implemented
 
--*/
HRESULT
CXDSmplUI::UpgradePrinter(
    _In_ DWORD,
    _In_ PBYTE
    )
{
    return E_NOTIMPL;
}
 
/*++
 
Routine Name:
 
    CXDSmplUI::PrinterEvent
 
Routine Description:
 
    This method allows a user interface plug-in to process printer events.
 
Arguments:
 
    None referenced.
 
Return Value:
 
    HRESULT
    E_NOTIMPL - Method not implemented
 
--*/
HRESULT
CXDSmplUI::PrinterEvent(
    _In_ PWSTR ,
    _In_ INT ,
    _In_ DWORD ,
    _In_ LPARAM
    )
{
    return E_NOTIMPL;
}
 
/*++
 
Routine Name:
 
    CXDSmplUI::DriverEvent
 
Routine Description:
 
    The printer driver's DrvDriverEvent function calls a user interface plug-in's
    IPrintOemUI::DriverEvent method for additional processing of printer driver events.
 
Arguments:
 
    None referenced.
 
Return Value:
 
    HRESULT
    E_NOTIMPL - Method not implemented
 
--*/
HRESULT
CXDSmplUI::DriverEvent(
    _In_ DWORD ,
    _In_ DWORD ,
    _In_reads_(_Inexpressible_("varies")) PBYTE ,
    _In_ LPARAM
    )
{
    return E_NOTIMPL;
}
 
/*++
 
Routine Name:
 
    CXDSmplUI::QueryColorProfile
 
Routine Description:
 
    This method allows a user interface plug-in to specify an ICC profile to use for color management.
 
Arguments:
 
    None referenced.
 
Return Value:
 
    HRESULT
    E_NOTIMPL - Method not implemented
 
--*/
HRESULT
CXDSmplUI::QueryColorProfile(
    _In_ HANDLE ,
    _In_ POEMUIOBJ ,
    _In_ PDEVMODE ,
    _In_ PVOID ,
    _In_ ULONG ,
    _Out_writes_(*pcbProfileData) VOID* ,
    _Inout_ ULONG* pcbProfileData,
    _Out_ FLONG*
    )
{
    UNREFERENCED_PARAMETER(pcbProfileData);
    return E_NOTIMPL;
}
 
/*++
 
Routine Name:
 
    CXDSmplUI::FontInstallerDlgProc
 
Routine Description:
 
    A user interface plug-in's IPrintOemUI::FontInstallerDlgProc method replaces
    the Unidrv font installer's user interface.
 
Arguments:
 
    None referenced.
 
Return Value:
 
    HRESULT
    E_NOTIMPL - Method not implemented
 
--*/
HRESULT
CXDSmplUI::FontInstallerDlgProc(
    _In_ HWND ,
    _In_ UINT ,
    _In_ WPARAM ,
    _In_ LPARAM
    )
{
    return E_NOTIMPL;
}
 
/*++
 
Routine Name:
 
    CXDSmplUI::UpdateExternalFonts
 
Routine Description:
 
    This allows a user interface plug-in to update a printer's Unidrv Font Format Files (.uff file).
 
Arguments:
 
    None referenced.
 
Return Value:
 
    HRESULT
    E_NOTIMPL - Method not implemented
 
--*/
HRESULT
CXDSmplUI::UpdateExternalFonts(
    _In_   HANDLE,
    _In_   HANDLE,
    _In_z_ PWSTR
    )
{
    return E_NOTIMPL;
}
 
/*++
 
Routine Name:
 
    CXDSmplUI::CreatePropertyPages
 
Routine Description:
 
    Creates all property page handler objects.
 
Arguments:
 
    None
 
Return Value:
 
    HRESULT
    S_OK - On success
    E_*  - On error
 
--*/
HRESULT
CXDSmplUI::CreatePropertyPages(
    VOID
    )
{
    HRESULT hr = S_OK;
    CDocPropPage* pPropPage = NULL;
 
//
// This Prefast warning indicates that memory could be leaked
// in the event of an exception. We suppress this false positive because we
// know that the local try/catch block will clean up a single
// CDocPropPage, and the destructor will clean up any that are
// successfully added to the vector.
//
#pragma prefast(push)
#pragma prefast(disable:__WARNING_ALIASED_MEMORY_LEAK_EXCEPTION)
 
    try
    {
        //
        // Populate the property page vector
        //
        pPropPage = new(std::nothrow) CColorPropPage();
 
        hr = AddPropPage(pPropPage);
 
        if (SUCCEEDED(hr))
        {
            pPropPage = new(std::nothrow) CWatermarkPropPage();
            hr = AddPropPage(pPropPage);
        }
 
        if (SUCCEEDED(hr))
        {
            pPropPage = new(std::nothrow) CFeaturePropPage();
            hr = AddPropPage(pPropPage);
        }
    }
    catch (CXDException &e)
    {
        hr = e;
    }
    catch (exception& DBG_ONLY(e))
    {
        ERR(e.what());
        hr = E_FAIL;
    }
 
    if (FAILED(hr))
    {
        //
        // If we successfully created a property page but failed to push it onto
        // the vector we need to free the allocated property page
        //
        if (pPropPage != NULL)
        {
            delete pPropPage;
            pPropPage = NULL;
        }
    }
 
#pragma prefast(pop)
 
    return hr;
}
 
/*++
 
Routine Name:
 
    CXDSmplUI::DestroyPropPages
 
Routine Description:
 
    Destroy all property page handler classes that have been added into the collection.
 
Arguments:
 
    None
 
Return Value:
 
    HRESULT
    S_OK - On success
    E_*  - On error
 
--*/
inline VOID
CXDSmplUI::DestroyPropPages(
    VOID
    )
{
    while (!m_vectPropPages.empty())
    {
        if (m_vectPropPages.back() != NULL)
        {
            delete m_vectPropPages.back();
            m_vectPropPages.back() = NULL;
        }
 
        m_vectPropPages.pop_back();
    }
 
    if (m_pUIProperties != NULL)
    {
        delete m_pUIProperties;
        m_pUIProperties = NULL;
    }
}
 
//
// Use __drv_aliasesMem annotation to avoid PREfast warning 28197: Possibly leaking memory,
//
HRESULT
// Prefast warning 28194: The function was declared as aliasing the value in variable and exited without doing so.
// We suppress this false positive because STL vector does not have annotation, and we know the pointer has been saved
// to STL vector, which is released in DestroyPropPages().
#pragma warning(suppress: 28194)
CXDSmplUI::AddPropPage(
    _In_opt_ __drv_aliasesMem CDocPropPage* pPropPage
    )
{
    HRESULT hr = CHECK_POINTER(pPropPage, E_OUTOFMEMORY);
 
    if (SUCCEEDED(hr))
    {
        m_vectPropPages.push_back(pPropPage);
    }
 
    return hr;
}

Our Services

  • What our customers say about us?

© 2011-2025 All Rights Reserved. Joya Systems. 4425 South Mopac Building II Suite 101 Austin, TX 78735 Tel: 800-DEV-KERNEL

Privacy Policy. Terms of use. Valid XHTML & CSS