ImageFileName Property

Filename and location to save the image content of a transaction or statement.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
char* GetImageFileName();
int SetImageFileName(const char* lpszImageFileName);

Unicode (Windows)
LPWSTR GetImageFileName();
INT SetImageFileName(LPCWSTR lpszImageFileName);

@property (nonatomic,readwrite,assign,getter=imageFileName,setter=setImageFileName:) NSString* imageFileName;
- (NSString*)imageFileName;
- (void)setImageFileName:(NSString*)newImageFileName;

#define PID_LOANSTATEMENT_IMAGEFILENAME 29

IPWORKSOFX_EXTERNAL void* IPWORKSOFX_CALL IPWorksOFX_LoanStatement_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSOFX_EXTERNAL int IPWORKSOFX_CALL IPWorksOFX_LoanStatement_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

""

Remarks

When calling the GetImage method, the image content is returned by that method. If you want the image content to be written to disk, you can set the ImageFileName to a desired file name without specifying the type. The file type will be set automatically depending on the image type supported by the server. Possible image types are: jpeg, tiff, png, pdf.

If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True).

Note: Image download is available only for OFX version 2.1.1. When this method is called, the OFXVersion is automatically set to '211'.

Data Type

String