SetFileTagAsString Method

Attaches a String-typed file tag to the specified vault item.

Syntax

ANSI (Cross Platform)
int SetFileTagAsString(const char* lpszFileName, const char* lpszTagName, const char* lpszValue);

Unicode (Windows)
INT SetFileTagAsString(LPCWSTR lpszFileName, LPCWSTR lpszTagName, LPCWSTR lpszValue);
- (void)setFileTagAsString:(NSString*)fileName :(NSString*)tagName :(NSString*)value;
#define MID_CBVAULT_SETFILETAGASSTRING 66

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

Remarks

This method attaches a String-typed file tag to the vault item (file, directory, or alternate stream) specified by FileTag using the specified TagName. If a typed file tag with the specified TagName is already attached to the specified vault item, it is replaced.

The value passed for FileName must be a vault-local absolute path. The value passed for TagName may be up to 4095 characters in length (not including the null terminator).

The Value parameter specifies the UTF-16LE String value to store in the file tag; it may be up to 65529 - (name_length * 2) bytes in length (where name_length is measured in characters), including null terminators for both the String value and the name.

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.)

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