Skip to content

ExportImageFile.md

Latest commit

 

History

History
45 lines (36 loc) · 981 Bytes

ExportImageFile.md

File metadata and controls

45 lines (36 loc) · 981 Bytes
Raw

ExportImageFile

Description

Export the specified Image object in Vectorworks as an image file.

FUNCTION ExportImageFile(
				hHmage   : HANDLE;
				filePath : DYNARRAY[] of CHAR): BOOLEAN;
def vs.ExportImageFile(hHmage, filePath):
    return BOOLEAN

Parameters

Name Type Description
hHmage HANDLE The handle of the image object to be exported.
filePath DYNARRAY[] of CHAR Full path to the output image file.

Examples

resultOK := ExportImageFile(hHmage, filePath);
import vs

# Export the specified Image object in Vectorworks as an image file.
hHmage = vs.FSActLayer()  # handle to the first selected object on the active layer
filePath = 'C:/Temp'

ok = vs.ExportImageFile(hHmage, filePath)
if ok:
    vs.Message('ExportImageFile succeeded')
else:
    vs.Message('ExportImageFile failed')

Version

Availability: from Vectorworks 2015

Category