Deletes a file tag.
ANSI (Cross Platform) int DeleteFileTag(const char* lpszFileName, int iTagId, const char* lpszTagName); Unicode (Windows) INT DeleteFileTag(LPCWSTR lpszFileName, INT iTagId, LPCWSTR lpszTagName);
- (void)deleteFileTag:(NSString*)fileName :(int)tagId :(NSString*)tagName;
#define MID_CBVAULT_DELETEFILETAG 14 CBFSVAULT_EXTERNAL int CBFSVAULT_CALL CBFSVault_CBVault_Do(void *lpObj, int methid, int cparam, void *param, int cbparam, int64 *lpllVal);
This method deletes the file tag identified by TagId or TagName from the file, directory, or alternate stream specified by FileName.
The value passed for FileName must be a vault-local absolute path.
To delete a raw file tag, pass its Id for TagId and pass empty string for TagName. To delete a typed file tag, pass its name for TagName and pass 0 for TagId. If values are provided for both TagId and TagName, this method fails with an error.
Please refer to the File Tags topic for more information.
Note: This method can only be called when Active is true, and cannot be called within events.
Error Handling (C++)
This method returns a 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. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)