GetPreviewBitmapBytes Method (IApplication)

GetPreviewBitmapBytes 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)

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

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

# Syntax

Visual Basic |
--- | ---
    Function GetPreviewBitmapBytes( _
       ByVal DocumentPath As System.String, _
       ByVal Format As dsBitmapFormat_e, _
       ByRef Width As System.Integer, _
       ByRef Height As System.Integer, _
       ByRef 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 : String,
       Format : String
    ) : {
       Width : Number,
       Height : Number,
       BitmapByteArray : Array,
       RetVal : Boolean
    }

COM native C++ |
--- | ---
    HRESULT GetPreviewBitmapBytes(
       BSTR DocumentPath,
       dsBitmapFormat_e Format,
       LONG* Width,
       LONG* Height,
       VARIANT* BitmapByteArray,
       VARIANT_BOOL* RetVal
    )

C++ |
--- | ---
    DSRESULT GetPreviewBitmapBytes(
       const dsString& DocumentPath,
       dsBitmapFormat_e Format,
       long* Width,
       long* Height,
       dsByteArray* 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
RetVal[out] or Return Value
  True if successful, false if not

# See Also

####

IApplication Interface
IApplication Members
IApplication::GetPreviewBitmap Method
IApplication::GetPreviewBitmapFile Method
IApplication::GetPreviewOfEntities Method

# Availability

DraftSight V1R3.0