Copyright © 2011-2018 MultiMedia Soft

TagsEditor.APE_UserFieldSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Sets contents of a specific user-defined frame of the APE tag. Current contents can be retrieved through the TagsEditor.APE_UserFieldGet method.

The modification only happens in memory and not directly into the original sound file: in order to store modifications inside the file you need to call the TagsEditor.APE_SaveChanges method.

 

For further details about methods related to tags editing refer to the TagsEditorMan class.

For details about the editing of tags see the How to edit tag info in sound files tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function APE_UserFieldSet (

strFrameId as string,

strText as string

) as enumErrorCodes


 

[C#]

public enumErrorCodes APE_UserFieldSet (

string strFrameId,

string strText

);


 

[C++]

public: enumErrorCodes APE_UserFieldSet (

string strFrameId,

string strText

);


 

Parameter

Description

 

 

strFrameId

String containing the identifier of the specific user-defined frame to set.

You can know which frames are available inside the APE tag by using the combination of the TagsEditor.APE_UniqueFramesCountGet and TagsEditor.APE_UniqueFramesIdGet methods.

If a frame with the same identifier is already available, its content is replaced. If there is no frame with the given identifier, a new one is added.

strText

String of text to enter inside the given frame.

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.ERR_NOERROR (0)

The method call was successful.