<< Click to Display Table of Contents >> Navigation:  Management Functions > VpeGetOpenFileName

[Windows platform only]

Returns the file name, which was set by VpeSetOpenFileName() or the Open File Dialog.

After the Open File Dialog has been confirmed with OK, this property holds the path and file name selected by the user.

void VpeGetOpenFileName(

VpeHandle hDoc,

LPTSTR file_name,

UINT *size,

)

VpeHandle hDoc

Document Handle

LPTSTR file_name

Pointer to a buffer that receives the file name string. This parameter can be NULL, if the data is not required, in such case no data is copied.

UINT *size

Pointer to a variable that specifies the size, in bytes, of the buffer pointed to by the file_name parameter. When the function returns, this variable contains the number of bytes copied to file_name - including the size of the terminating null character.

If file_name is NULL, and size is non-NULL, the function returns TRUE and stores the size of the required buffer, in bytes, in the variable pointed to by size. This lets an application determine the best way to allocate a buffer for the file_name 's data.

Returns: