Navigation
API > API/Developer > API/Developer/SourceControl > API/Developer/SourceControl/ISourceControlProvider
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FSourceControlStatePtr GetState
(
const FString& InFile, |
Helper overload for state retrieval, see GetState(). | ISourceControlProvider.h | |
virtual FSourceControlStatePtr GetState
(
const UPackage* InPackage, |
Helper overload for state retrieval, see GetState(). | ISourceControlProvider.h | |
virtual FSourceControlChangelistStatePtr GetState
(
const FSourceControlChangelistRef& InChangelist, |
Helper overload for state retrieval, see GetState(). | ISourceControlProvider.h | |
ECommandResult::Type GetState
(
const TArray< FString >& InFiles, |
Get the state of each of the passed-in files. | ISourceControlProvider.h | |
virtual ECommandResult::Type GetState
(
const TArray< UPackage* >& InPackages, |
Helper overload for state retrieval, see GetState(). | ISourceControlProvider.h | |
ECommandResult::Type GetState
(
const TArray< FSourceControlChangelistRef >& InChangelists, |
Get the state of each of the passed-in changelists. | ISourceControlProvider.h |
GetState(const FString &, EStateCacheUsage::Type)
Description
Helper overload for state retrieval, see GetState().
| Name | GetState |
| Type | function |
| Header File | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h |
| Include Path | #include "ISourceControlProvider.h" |
| Source | /Engine/Source/Developer/SourceControl/Private/ISourceControlProvider.cpp |
virtual FSourceControlStatePtr GetState
(
const FString & InFile,
EStateCacheUsage::Type InStateCacheUsage
)
GetState(const UPackage *, EStateCacheUsage::Type)
Description
Helper overload for state retrieval, see GetState().
| Name | GetState |
| Type | function |
| Header File | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h |
| Include Path | #include "ISourceControlProvider.h" |
| Source | /Engine/Source/Developer/SourceControl/Private/ISourceControlProvider.cpp |
virtual FSourceControlStatePtr GetState
(
const UPackage * InPackage,
EStateCacheUsage::Type InStateCacheUsage
)
GetState(const FSourceControlChangelistRef &, EStateCacheUsage::Type)
Description
Helper overload for state retrieval, see GetState().
| Name | GetState |
| Type | function |
| Header File | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h |
| Include Path | #include "ISourceControlProvider.h" |
| Source | /Engine/Source/Developer/SourceControl/Private/ISourceControlProvider.cpp |
virtual FSourceControlChangelistStatePtr GetState
(
const FSourceControlChangelistRef & InChangelist,
EStateCacheUsage::Type InStateCacheUsage
)
GetState(const TArray< FString > &, TArray< FSourceControlStateRef > &, EStateCacheUsage::Type)
Description
Get the state of each of the passed-in files. State may be cached for faster queries. Note states can be NULL!
| Name | GetState |
| Type | function |
| Header File | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h |
| Include Path | #include "ISourceControlProvider.h" |
ECommandResult::Type GetState
(
const TArray < FString > & InFiles,
TArray < FSourceControlStateRef > & OutState,
EStateCacheUsage::Type InStateCacheUsage
)
the result of the operation.
Parameters
| Name | Remarks |
|---|---|
| InFiles | The files to retrieve state for. |
| OutState | The states of the files. This will be empty if the operation fails. Note states can be NULL! |
| InStateCacheUsage | Whether to use the state cache or to force a (synchronous) state retrieval. |
GetState(const TArray< UPackage * > &, TArray< FSourceControlStateRef > &, EStateCacheUsage::Type)
Description
Helper overload for state retrieval, see GetState().
| Name | GetState |
| Type | function |
| Header File | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h |
| Include Path | #include "ISourceControlProvider.h" |
| Source | /Engine/Source/Developer/SourceControl/Private/ISourceControlProvider.cpp |
virtual ECommandResult::Type GetState
(
const TArray < UPackage * > & InPackages,
TArray < FSourceControlStateRef > & OutState,
EStateCacheUsage::Type InStateCacheUsage
)
GetState(const TArray< FSourceControlChangelistRef > &, TArray< FSourceControlChangelistStateRef > &, EStateCacheUsage::Type)
Description
Get the state of each of the passed-in changelists. State may be cached for faster queries. Note states can be NULL!
| Name | GetState |
| Type | function |
| Header File | /Engine/Source/Developer/SourceControl/Public/ISourceControlProvider.h |
| Include Path | #include "ISourceControlProvider.h" |
ECommandResult::Type GetState
(
const TArray < FSourceControlChangelistRef > & InChangelists,
TArray < FSourceControlChangelistStateRef > & OutState,
EStateCacheUsage::Type InStateCacheUsage
)
the result of the operation.
Parameters
| Name | Remarks |
|---|---|
| InChangelists | The changelists to retrieve state for. |
| OutState | The states of the changelists. This will be empty if the operation fails. Note states can be NULL! |
| InStateCacheUsage | Whether to use the state cache or to force a (synchronous) state retrieval. |