An interface supported by those objects that can provide a thumbnail representation.
More...
List of all members.
Public Member Functions |
HRESULT | GetThumbnailSize ([out]long *nWidth,[out]long *nHeight) |
| Retrieves the size of the thumbnail.
|
HRESULT | GetThumbnail ([in]long nWidth,[in]long nHeight,[out, size_is(nWidth *nHeight)]BYTE pBytes[*]) |
| Retrieves the thumbnail image.
|
HRESULT | SaveThumbnail ([in] BSTR bstrFilePath) |
| Saves the thumbnail to a file, if there is one.
|
Detailed Description
An interface supported by those objects that can provide a thumbnail representation.
Member Function Documentation
HRESULT ISkpThumbnailProvider::GetThumbnail |
( |
[in] long |
nWidth, |
|
|
[in] long |
nHeight, |
|
|
[out, size_is(nWidth *nHeight)] BYTE |
pBytes[*] | |
|
) |
| | |
Retrieves the thumbnail image.
The given parameters are used to resize the image. They should be less than or equal to the actual size of the thumbnail.
- Parameters:
-
| nWidth | The width of the thumbnail. |
| nHeight | The height of the thumbnail. |
| pBytes | User allocated space for the thumbnail image. |
- Returns:
- S_OK if all went well
- S_FALSE if there was no thumbnail available
HRESULT ISkpThumbnailProvider::GetThumbnailSize |
( |
[out] long * |
nWidth, |
|
|
[out] long * |
nHeight | |
|
) |
| | |
Retrieves the size of the thumbnail.
- Parameters:
-
| nWidth | Space for the width of the thumbnail. |
| nHeight | Space for the height of the thumbnail. |
- Returns:
- S_OK if all went well
- S_FALSE if there was no thumbnail available
HRESULT ISkpThumbnailProvider::SaveThumbnail |
( |
[in] BSTR |
bstrFilePath |
) |
|
Saves the thumbnail to a file, if there is one.
- Parameters:
-
| bstrFilePath | The name of the file to save to. |
- Returns:
- S_OK if all went well
- S_FALSE if there was no thumbnail available