[This is preliminary documentation and is subject to change.]

Called to set the value of a specific field for a given file, e.g. to change the date field of a file.

Namespace: Tools.TotalCommanderT
Assembly: Tools.TotalCommander (in Tools.TotalCommander.dll) Version: 1.5.3.38916 (1.5.3.38916)

Syntax

C#
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
[CLSCompliantAttribute(false)]
public int ContentSetValue(
	sbyte* FileName,
	int FieldIndex,
	int UnitIndex,
	int FieldType,
	void* FieldValue,
	int flags
)
Visual Basic
<EditorBrowsableAttribute(EditorBrowsableState.Never)> _
<CLSCompliantAttribute(False)> _
Public Function ContentSetValue ( _
	FileName As SByte*, _
	FieldIndex As Integer, _
	UnitIndex As Integer, _
	FieldType As Integer, _
	FieldValue As Void*, _
	flags As Integer _
) As Integer
Visual C++
[EditorBrowsableAttribute(EditorBrowsableState::Never)]
[CLSCompliantAttribute(false)]
public:
int ContentSetValue(
	signed char* FileName, 
	int FieldIndex, 
	int UnitIndex, 
	int FieldType, 
	void* FieldValue, 
	int flags
)
F#
[<EditorBrowsableAttribute(EditorBrowsableState.Never)>]
[<CLSCompliantAttribute(false)>]
member ContentSetValue : 
        FileName:nativeptr<sbyte> * 
        FieldIndex:int * 
        UnitIndex:int * 
        FieldType:int * 
        FieldValue:nativeptr<unit> * 
        flags:int -> int
JScript
JScript does not support APIs that consume or return unsafe types.

Parameters

FileName
Type: System..::..SByte*
The name of the file (for File System plugins in plugin namespace) for which the plugin needs to change the field data.

This is set to NULL to indicate the end of change attributes.

FieldIndex
Type: System..::..Int32
The index of the field for which the content has to be returned. This is the same index as the FieldIndex value in ContentGetSupportedField(Int32, SByte*, SByte*, Int32). This is set to -1 to signal the end of change attributes.
UnitIndex
Type: System..::..Int32
The index of the unit used. If no unit string was returned by ContentGetSupportedField(Int32, SByte*, SByte*, Int32), UnitIndex is 0.
FieldType
Type: System..::..Int32
The type of data passed to the plugin in FieldValue - one of the ContentFieldType values. This is the same type as returned by the plugin via ContentGetSupportedField(Int32, SByte*, SByte*, Int32). If the plugin returned a different type via ContentGetValue(SByte*, Int32, Int32, Void*, Int32, Int32), the the FieldTypemay be of that type too.
FieldValue
Type: System..::..Void*
Here the plugin receives the data to be changed. The data format depends on the field type.
flags
Type: System..::..Int32

[Missing <param name="flags"/> documentation for "M:Tools.TotalCommanderT.ContentPluginBase.ContentSetValue(System.SByte!System.Runtime.CompilerServices.IsSignUnspecifiedByte*,System.Int32,System.Int32,System.Int32,System.Void*,System.Int32)"]

Return Value

NoSuchField()()()(), FileError()()()() or ContentSetValueSuccess.

Remarks

Note
About caching the data: Total Commander will not call a mix ContentSetValue(SByte*, Int32, Int32, Int32, Void*, Int32) for different files, it will only call it for the next file when the previous file can be closed. Therefore a single cache per running Total Commander should be sufficient.
Note
About the flags: If the flagsFirst and Last are both set, then this is the only attribute of this plugin which is changed for this file.

FileName is set to NULL and FieldIndex to -1 to signal to the plugin that the change attributes operation has ended. This can be used to flush unsaved data to disk, e.g. when setting comments for multiple files.

This function is called by Total Commander and is not intended for direct use.

See Also

Collapse/expand Version History

1.5.3

  • This function is new in version 1.5.3