GetPreviewBitmap Method (IApplication)

GetPreviewBitmap Method (IApplication) | Send Feedback
See Also

RetVal[out]
  True if successful, false if not

DocumentPath
  Path and file name of the document's preview bitmap (.bmp)

BitmapByteArray[out]
  Byte array of the preview bitmap

Gets the preview bitmap of the specified document.

# Syntax

Visual Basic |
--- | ---
    Function GetPreviewBitmap( _
       ByVal DocumentPath As System.String, _
       ByRef BitmapByteArray As System.Object _
    ) As System.Boolean

C# |
--- | ---
    System.bool GetPreviewBitmap(
       System.string DocumentPath,
       out System.object BitmapByteArray
    )

JavaScript |
--- | ---
    GetPreviewBitmap(
       DocumentPath : String
    ) : {
       BitmapByteArray : Array,
       RetVal : Boolean
    }

COM native C++ |
--- | ---
    HRESULT GetPreviewBitmap(
       BSTR DocumentPath,
       VARIANT* BitmapByteArray,
       VARIANT_BOOL* RetVal
    )

C++ |
--- | ---
    DSRESULT GetPreviewBitmap(
       const dsString& DocumentPath,
       dsByteArray* BitmapByteArray,
       bool* RetVal
    )

#### Parameters

DocumentPath
  Path and file name of the document's preview bitmap (.bmp)
BitmapByteArray[out]
  Byte array of the preview bitmap
RetVal[out] or Return Value
  True if successful, false if not

# Remarks

Binary data is organized into variable-length chunks. The maximum length of each chunk is 127 bytes.

# See Also

####

IApplication Interface
IApplication Members
IApplication::GetPreviewBitmapFile Method
IApplication::GetPreviewBitmapBytes Method
IApplication::GetPreviewOfEntities Method
IDocumentExporter::ExportToBmp Method

# Availability

DraftSight V1R3.0