Differences
This shows you the differences between the selected revisions of the page.
| library_wildcard 2013-05-06 | library_wildcard 2023-01-11 (current) | ||
| Line 1: | Line 1: | ||
| - | ====== File File Mask/Wildcard ====== | + | ====== File Mask/Wildcard ====== |
| Some ''[[library_session|Session]]'' class methods manipulating files accept a [[file_mask|file mask/wildcard]] rather than filename in the path argument. The methods include: | Some ''[[library_session|Session]]'' class methods manipulating files accept a [[file_mask|file mask/wildcard]] rather than filename in the path argument. The methods include: | ||
| * ''[[library_session_getfiles|Session.GetFiles]]''; | * ''[[library_session_getfiles|Session.GetFiles]]''; | ||
| - | * ''[[library_session_putfiles|Session.PutFiles]]''; | ||
| * ''[[library_session_removefiles|Session.RemoveFiles]]''. | * ''[[library_session_removefiles|Session.RemoveFiles]]''. | ||
| - | To avoid the methods to interpret the special characters in the path as a mask, use the ''[[library_session_escapefilemask|Session.EscapeFileMask]]'' method to escape the special characters. This is particularly important, when you use variable paths. | + | To avoid the methods to interpret the special characters in the path as a mask, use the ''[[library_remotepath_escapefilemask|RemotePath.EscapeFileMask]]'' method to escape the special characters. This is particularly important, when you use variable paths. |
| - | For example, if your file is named ''filewithstar*.txt'', passing such name directly to ''[[library_session_getfiles|Session.GetFiles]]'' would download all files with name starting ''filewithstar'' and ''.txt'' extension, not only ''filewithstar*.txt''. The ''Session.EscapeFileMask'' converts the name to unambiguous mask ''filewithstar[*].txt'', that matches only the ''filewithstar*.txt''. | + | For example, if your file is named ''filewithstar*.txt'', passing such name directly to ''[[library_session_getfiles|Session.GetFiles]]'' would download all files with name starting ''filewithstar'' and ''.txt'' extension, not only ''filewithstar*.txt''. The ''RemotePath.EscapeFileMask'' converts the name to unambiguous mask ''filewithstar[*].txt'', that matches only the ''filewithstar*.txt''. |
| It is an error, when you use path to a file that does not exist with above methods. Though, it is not an error when you use a mask that does not match any file (the directory used with the mask still needs to exist). | It is an error, when you use path to a file that does not exist with above methods. Though, it is not an error when you use a mask that does not match any file (the directory used with the mask still needs to exist). | ||