USourceControlHelpers::AnnotateFile

Helper function to annotate a file using a changelist/checkin identifier

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,
    int32 InCheckInIdentifier,
    const FString & InFile,
    TArray< FAnnotationLine > & OutLines
)

Remarks

Helper function to annotate a file using a changelist/checkin identifier

Returns

true if successful

Parameters

Parameter

Description

InProvider

The provider to use

InCheckInIdentifier

The changelist/checkin identifier 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