Navigation
API > API/Developer > API/Developer/SourceControl > API/Developer/SourceControl/USourceControlHelpers
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool AnnotateFile
(
ISourceControlProvider& InProvider, |
Helper function to annotate a file using a label | SourceControlHelpers.h | |
static bool AnnotateFile
(
ISourceControlProvider& InProvider, |
Helper function to annotate a file using a changelist/checkin identifier | SourceControlHelpers.h |
AnnotateFile(ISourceControlProvider &, const FString &, const FString &, TArray< FAnnotationLine > &)
Description
Helper function to annotate a file using a label
| Name | AnnotateFile |
| Type | function |
| Header File | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h |
| Include Path | #include "SourceControlHelpers.h" |
| Source | /Engine/Source/Developer/SourceControl/Private/SourceControlHelpers.cpp |
static bool AnnotateFile
(
ISourceControlProvider & InProvider,
const FString & InLabel,
const FString & InFile,
TArray < FAnnotationLine > & OutLines
)
true if successful
Parameters
| Name | Remarks |
|---|---|
| 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 |
AnnotateFile(ISourceControlProvider &, int32, const FString &, TArray< FAnnotationLine > &)
Description
Helper function to annotate a file using a changelist/checkin identifier
| Name | AnnotateFile |
| Type | function |
| Header File | /Engine/Source/Developer/SourceControl/Public/SourceControlHelpers.h |
| Include Path | #include "SourceControlHelpers.h" |
| Source | /Engine/Source/Developer/SourceControl/Private/SourceControlHelpers.cpp |
static bool AnnotateFile
(
ISourceControlProvider & InProvider,
int32 InCheckInIdentifier,
const FString & InFile,
TArray < FAnnotationLine > & OutLines
)
true if successful
Parameters
| Name | Remarks |
|---|---|
| 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 |