Hide Table of Contents
GetPreviewBitmapBytes Method (IApplication)
RetVal[out]
True if successful, false if not

Gets a byte array of the preview bitmap for the specified document.

.NET Syntax

Visual Basic (Declaration) 
Function GetPreviewBitmapBytes( _
   BSTR DocumentPath As System.String, _
   dsBitmapFormat_e Format As dsBitmapFormat_e, _
   LONG* Width As System.Integer, _
   LONG* Height As System.Integer, _
   VARIANT* BitmapByteArray As System.Object _
) As System.Boolean
C# 
System.bool GetPreviewBitmapBytes( 
   System.string DocumentPath,
   dsBitmapFormat_e Format,
   out System.int Width,
   out System.int Height,
   out System.object BitmapByteArray
)
JavaScript 
GetPreviewBitmapBytes( 
   DocumentPath : System.String,
   Format : String,
   BitmapByteArray : System.Object
) : {
   Width : Number,
   Height : Number,
   RetVal : Boolean
}
COM native C++ 
HRESULT GetPreviewBitmapBytes( 
   const dsString& DocumentPath,
,
   dsBitmapFormat_e Format,
   long* Width,
,
   long* Height,
,
   VARIANT* BitmapByteArray
,
   VARIANT_BOOL* RetVal
)
C++ 
DSRESULT GetPreviewBitmapBytes( 
   BSTR DocumentPath,
,
   dsBitmapFormat_e Format,
   LONG* Width,
,
   LONG* Height,
,
   VARIANT* BitmapByteArray
,
   bool* RetVal
)

Parameters

DocumentPath
Path and file name of the document's preview bitmap (.bmp)
Format
Format of the preview bitmap as defined in dsBitmapFormat_e
Width[out]
Width of the preview bitmap
Height[out]
Height of the preview bitmap
BitmapByteArray[out]
Byte array of the preview bitmap

Parameters

RetVal[out] or Return Value
True if successful, false if not
 

See Also

Availability

DraftSight V1R3.0


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   GetPreviewBitmapBytes Method (IApplication)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2025 SP2

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.

0.20.46