| ISubsegmentTranslationMemoryLanguageDirectionSearchSegmentsMasked Method |
Performs a segment-level search, and optionally a subsegment search, for an array of segments, specifying a mask which specifies which segments should actually be
searched (only those for which the corresponding mask bit is
true are searched). If the mask is
null, the method
behaves identically to
SearchSegments(SearchSettings, SubsegmentSearchSettings, SubsegmentSearchCondition, Segment). Passing a mask only makes sense in document search contexts (
IsDocumentSearch
set to
true).
Namespace: Sdl.LanguagePlatform.TranslationMemoryApiAssembly: Sdl.LanguagePlatform.TranslationMemoryApi (in Sdl.LanguagePlatform.TranslationMemoryApi.dll) Version: 1.6.0.0 (1.14.4157.0)
SyntaxSegmentAndSubsegmentSearchResults[] SearchSegmentsMasked(
SearchSettings settings,
SubsegmentSearchSettings subsegmentSettings,
SubsegmentSearchCondition condition,
Segment[] segments,
bool[] mask
)
Function SearchSegmentsMasked (
settings As SearchSettings,
subsegmentSettings As SubsegmentSearchSettings,
condition As SubsegmentSearchCondition,
segments As Segment(),
mask As Boolean()
) As SegmentAndSubsegmentSearchResults()
array<SegmentAndSubsegmentSearchResults^>^ SearchSegmentsMasked(
SearchSettings^ settings,
SubsegmentSearchSettings^ subsegmentSettings,
SubsegmentSearchCondition condition,
array<Segment^>^ segments,
array<bool>^ mask
)
abstract SearchSegmentsMasked :
settings : SearchSettings *
subsegmentSettings : SubsegmentSearchSettings *
condition : SubsegmentSearchCondition *
segments : Segment[] *
mask : bool[] -> SegmentAndSubsegmentSearchResults[]
Parameters
- settings
- Type: SearchSettings
The settings that define the segment-level search parameters. - subsegmentSettings
- Type: SubsegmentSearchSettings
The settings that define the subsegment search parameters, or null if a subsegment search should not be performed. - condition
- Type: SubsegmentSearchCondition
If subsegmentSettings is not null, specifies the conditions under which a subsegment search will be performed. - segments
- Type: Segment
The array containing the segments to search for. - mask
- Type: SystemBoolean
The array containing the segments to search for.
Return Value
Type:
SegmentAndSubsegmentSearchResultsAn array of
SearchResults objects, which mirrors the segments array. It has the exact same size and contains the
search results for each segment with the same index within the segments array.
See Also
Comments