SolFSStorage.GetFileTag method
Filter:
Pascal DLL C++ (DLL/Lib) C++ (VCL) C++ (.NET) C# VB.NETOverview
Returns file/stream tag (custom metadata).
Declaration
[Pascal]
function GetFileTag(
const FileName: WideString;
TagID: word;
TagData: Pointer;
TagDataSize: LongWord) : LongWord;
[DLL]
long _stdcall StorageGetFileTag(
unsigned long Storage,
const wchar_t* FileName,
unsigned short TagID,
void* TagData,
unsigned long *TagDataSize);
[C++ (DLL/Lib)]
unsigned long GetFileTag(
unsigned short *fileName,
unsigned short TagID,
void* TagData,
unsigned long TagDataSize);
[C++ (VCL)]
unsigned long __fastcall GetFileTag(
const WideString FileName,
unsigned short TagID,
void* TagData,
unsigned long TagDataSize
);
[C++ (.NET)]
long GetFileTag(
String *fileName,
int TagID,
byte TagData __gc[],
long TagDataSize
);
[C#]
int GetFileTag(
String fileName,
int TagID,
byte[] TagData,
long TagDataSize
);
[VB.NET]
Function GetFileTag(ByVal fileName As String,
TagID As Integer,
TagData as Byte(),
TagDataSize as Integer
) As Integer
Parameters
- FileName - the full file name in the SolFSStorage.
- TagID - tag unique ID, must be in range of [0x8000..0xCFFF].
- TagData - a buffer for tag data, which is to be retrieved.
- TagDataSize - on entry contains the size of the buffer. [DLL]On exit contains tag data real size
Return value
Tag data real size.
[DLL] 0 if the function succeeded or one of Error codes if the function failed.
Description
Use GeFileTag to retrieve file metadata (custom tag). Each file can have up to 20480 tags. Each tag data can be as large as (PageSize - 96) bytes.