RFApplication.GetMDLFileProperty

Description

Retrieves the properties stored in the specified MDL file.

Syntax

Function RFApplication.GetMDLFileProperty(fileName As String, pTitle As String, pSubject As String, pAuthor As String, pKeyword As String, pComment As String, pImageColorValues As Byte) As RFErrorCode

The GetMDLFileProperty syntax has these parts:

Part	Description
fileName	[IN] String Required. The full path name of the MDL file.
pTitle	[OUT] String Required. Title of the MDL file.
pSubject	[OUT] String Required. Subject of the MDL file.
pAuthor	[OUT] String Required. Author of the MDL file.
pKeyword	[OUT] String Required. Keyword of the MDL file.
pComment	[OUT] String Required. Comment of the MDL file.
pImageColorValues	[OUT] Byte Required. The first element of the Byte array storing the color value of each pixel of the thumbnail image.

Remarks

Memory storage space of pImageColorValues array needs to be allocated prior to calling this method. The required array size is (image width in pixel) X (image height in pixcel) X 3 to store red, green and blue values of each pixel, where the image size can be obtained by RFApplication.GetMDLFilePreviewImageSize method.
This method is not available in local server program. In case of that, use RFApplication.GetMDLFileProperty2 method.

Sample


    ' Retrieve the width and height of the thumbnail image.
    Dim w As Long
    Dim h As Long
    RapidForm.GetMDLFilePreviewImageSize w, h
    
    Dim rfErr As RFErrorCode
    Dim titleStr As String
    Dim subStr As String
    Dim authStr As String
    Dim keywrdStr As String
    Dim cmtStr As String
    Dim thumbImg() As Byte
    
    ' Allocate the Byte array as the amount of width X height X 3 of the image.
    ReDim thumbImg(w * h * 3)
    
    ' Retrieve all the MDL file properties.
    rfErr = RapidForm.GetMDLFileProperty("C:\Temp\abc.mdl", titleStr, subStr, authStr, keywrdStr, cmtStr, thumbImg(0))

Return to Rapidform Index

Your Ad Here