GetFileTagSize Method

Retrieves the size of a raw file tag attached to the specified vault item.

Syntax

ANSI (Cross Platform)
int GetFileTagSize(const char* lpszFileName, int iTagId);

Unicode (Windows)
INT GetFileTagSize(LPCWSTR lpszFileName, INT iTagId);
- (int)getFileTagSize:(NSString*)fileName :(int)tagId;
#define MID_CBVAULT_GETFILETAGSIZE 36

CBFSVAULT_EXTERNAL int CBFSVAULT_CALL CBFSVault_CBVault_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method retrieves the size of the binary data held by a raw file tag, identified by TagId, attached to the vault item (file, directory, or alternate stream) specified by FileName. If there isn't a raw file tag with the specified TagId attached to the specified vault item, this method returns 0 as the tag size.

The value passed for FileName must be a vault-local absolute path. The value passed for TagId must be in the range 0x0001 to 0xCFFF (inclusive).

Please refer to the File Tags topic for more information.

Note: This method can only be called when Active is true.

Error Handling (C++)

This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Copyright (c) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Vault 2020 C++ Edition - Version 20.0 [Build 7986]