wodSFTP API library - ListItem Property
 ListItem function
      
 

Description

Holds the value of the last ListItems and Attributes event


Return type

A Long value. If successful, 0 is returned, otherwise error as specified here. 


Syntax

long Sftp_GetListItem(void *Sftp, char *Buffer, int *Bufsize);

The ListItem function syntax has these parts:

Part Description
void *Sftp Handle of the created Sftp instance.
char *Buffer Buffer that will hold the returned string.
int *Bufsize Size of the buffer.

Remarks

When working in scripting environments, such as ASP, you are unable to retrieve information returned from callbacks such as Listitems. In such cases, you can read the result from the ListItem property. It is valid when the Done callback is called or in blocking mode after your method finishes.

Also, this property will hold the results from the RealPath, GetAttributes,  and GetData methods.

The Bufsize variable should contain the maximum data length that can be stored in the Buffer variable. If you set Bufsize = 0, then the function will return with error ERROR_INSUFFICIENT_BUFFER and Bufsize will contain the required buffer size.