|
TagsEditor.ID3V2_CommercialFramePictureBitmapGet method |
  
|
|
TagsEditor.ID3V2_CommercialFramePictureBitmapGet method |
|
Remarks
Obtains the memory bitmap (HBITMAP) representation of the picture stored inside an ID3V2 commercial frame (COMR).
For further details about methods related to tags editing refer to the TagsEditorMan class.
For details about the editing of tags see the How to edit tag info in sound files tutorial.
Syntax
[Visual Basic] Public Function ID3V2_CommercialFramePictureBitmapGet ( nIndex as Int32, hBitmap as IntPtr, ByRef nOriginalWidth as Int32, ByRef nOriginalHeight as Int32, nResizeWidth as Int32, nResizeHeight as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes ID3V2_CommercialFramePictureBitmapGet ( Int32 nIndex, IntPtr hBitmap, ref Int32 nOriginalWidth, ref Int32 nOriginalHeight, Int32 nResizeWidth, Int32 nResizeHeight ); |
[C++] public: enumErrorCodes ID3V2_CommercialFramePictureBitmapGet ( Int32 nIndex, IntPtr hBitmap, Int32 __gc *nOriginalWidth, Int32 __gc *nOriginalHeight, Int32 nResizeWidth, Int32 nResizeHeight ); |
Parameter |
Description |
|
|
nIndex |
Zero-based index of the commercial frame. The total number of commercial frames available inside the ID3V2 tag can be obtained through a call to the TagsEditor.ID3V2_FrameCountGet method with the strFrameId parameter set to "COMR". |
hBitmap |
Reference that, on return from the method call, will contain the HBITMAP of the picture. |
nOriginalWidth |
Reference that, on return from the method call, will contain the original width, expressed in pixels, of the picture. |
nOriginalHeight |
Reference that, on return from the method call, will contain the original height, expressed in pixels, of the picture. |
nResizeWidth |
Value containing the width, expressed in pixels, for horizontally resizing the picture before returning the HBITMAP; this parameter is ignored if set to 0 in which case the picture represented by the HBITMAP handle will have the same width returned inside the nOriginalWidth parameter. |
nResizeHeight |
Value containing the height, expressed in pixels, for vertically resizing the picture before returning the HBITMAP; this parameter is ignored if set to 0 in which case the picture represented by the HBITMAP handle will have the same height returned inside the nOriginalHeight parameter. |
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred (see the LastError property for further error details) |
enumErrorCodes.ERR_NOERROR (0) |
The method call was successful. |
