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
|
/*++
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:
ipkarch.h
Abstract:
Definition of the interface supported by the PK archive handling module.
--*/
#pragma once
#include "ipkfile.h"
//
// {5A0F4115-D4D3-401e-8071-A440D6D07092}
//
DEFINE_GUID(CLSID_PKArchiveHandler, 0x5a0f4115, 0xd4d3, 0x401e, 0x80, 0x71, 0xa4, 0x40, 0xd6, 0xd0, 0x70, 0x92);
//
// {BDBBDF56-C742-4efd-8075-AF2C7B247F38}
//
DEFINE_GUID(IID_IPKArchive, 0xbdbbdf56, 0xc742, 0x4efd, 0x80, 0x75, 0xaf, 0x2c, 0x7b, 0x24, 0x7f, 0x38);
typedef map<CStringXDA, CONST IPKFile*> NameIndex;
class IPKArchive : public IUnknown
{
public:
/*++
Routine Name:
SetReadStream
Routine Description:
This routine sets the read stream for the PK archive handler
Arguments:
pReadStream - Pointer to the print read stream interface
Return Value:
HRESULT
S_OK - On success
E_* - On error
--*/
HRESULT
virtual SetReadStream(
_In_ IPrintReadStream* pReadStream
) = 0;
/*++
Routine Name:
SetWriteStream
Routine Description:
This routine sets the write stream for the PK archive handler
Arguments:
pWriteStream - Pointer to the print write stream interface
Return Value:
HRESULT
S_OK - On success
E_* - On error
--*/
HRESULT
virtual SetWriteStream(
_In_ IPrintWriteStream* pWriteStream
) = 0;
/*++
Routine Name:
ProcessReadStream
Routine Description:
This method instructs the PK archive handler to process the PK archive for all records
Arguments:
None
Return Value:
HRESULT
S_OK - On success
E_* - On error
--*/
HRESULT
virtual ProcessReadStream(
VOID
) = 0;
/*++
Routine Name:
GetNameIndex
Routine Description:
This routine retrieves the archives indexed by name
Arguments:
ppNameIdx - Pointer to a NameIndex pointer that recieves the archive index
Return Value:
HRESULT
S_OK - On success
E_* - On error
--*/
HRESULT
virtual GetNameIndex(
_Outptr_ NameIndex** ppNameIdx
) = 0;
/*++
Routine Name:
SendFile
Routine Description:
This routine sends the PK file to the write stream
Arguments:
pFile - Pointer to the IPKFile to be sent to the write stream
Return Value:
HRESULT
S_OK - On success
E_* - On error
--*/
HRESULT
virtual SendFile(
_In_ CONST IPKFile* pFile
) = 0;
/*++
Routine Name:
SendFile
Routine Description:
This routine compresses and sends a buffer as a PK archive to the write stream
Arguments:
szFileName - The name of the archive to be created
pBuffer - The buffer containing the uncompressed archive data
cbBuffer - The size of the uncompressed archive data
compressionType - The type of compression to be used (only CompNone and CompDeflated are supported)
Return Value:
HRESULT
S_OK - On success
E_* - On error
--*/
HRESULT
virtual SendFile(
_In_z_ PCSTR szFileName,
_In_reads_bytes_(cbBuffer) PVOID pBuffer,
ULONG cbBuffer,
ECompressionType eCompType
) = 0;
/*++
Routine Name:
Close
Routine Description:
This routine closes and finalises the PK archive
Arguments:
None
Return Value:
HRESULT
S_OK - On success
E_* - On error
--*/
HRESULT
virtual Close(
VOID
) = 0;
};
|
