Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

USourceControlHelpers::AnnotateFile

Helper function to annotate a file using a label

Windows

MacOS

Linux

References

Module	SourceControl
Header	/Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h
Include	#include "SourceControlHelpers.h"
Source	/Engine/Source/Developer/SourceControl/Private/SourceControlHelpers.cpp

Syntax

static bool AnnotateFile
(
    ISourceControlProvider & InProvider,
    const FString & InLabel,
    const FString & InFile,
    TArray< FAnnotationLine > & OutLines
)

Remarks

Helper function to annotate a file using a label

Returns

true if successful

Parameters

Parameter	Description
InProvider	The provider to use
InLabel	The label to use to retrieve the file
InFile	The file to annotate
OutLines	Output array of annotated lines

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss