Class SzFlags

Namespace

Senzing.Sdk

Assembly

Senzing.Sdk.dll

Provides aggregate SzFlag constants as well as extension methods and utility methods pertaining to SzFlag and SzFlagUsageGroup.

public static class SzFlags

Inheritance

object

SzFlags

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

SzEntityAllFlags

The SzFlag value that aggregates all SzFlag constants belonging to the SzEntityFlags usage group.

public const SzFlag SzEntityAllFlags = SzEntityIncludePossiblySameRelations | SzEntityIncludePossiblyRelatedRelations | SzEntityIncludeNameOnlyRelations | SzEntityIncludeDisclosedRelations | SzEntityIncludeAllFeatures | SzEntityIncludeRepresentativeFeatures | SzEntityIncludeEntityName | SzEntityIncludeRecordSummary | SzEntityIncludeRecordData | SzEntityIncludeRecordMatchingInfo | SzEntityIncludeRecordJsonData | SzEntityIncludeRecordFeatures | SzEntityIncludeRelatedEntityName | SzEntityIncludeRelatedMatchingInfo | SzEntityIncludeRelatedRecordSummary | SzEntityIncludeRelatedRecordData | SzEntityIncludeInternalFeatures | SzEntityIncludeFeatureStats | SzEntityIncludeRecordTypes | SzEntityIncludeRelatedRecordTypes | SzEntityIncludeRecordUnmappedData | SzIncludeMatchKeyDetails | SzEntityIncludeRecordFeatureDetails | SzEntityIncludeRecordFeatureStats

Field Value

SzFlag

See Also

SzEntityFlags

SzEntityBriefDefaultFlags

The aggregate SzFlag to produce the default level of detail when retrieving entities.

public const SzFlag SzEntityBriefDefaultFlags = SzEntityIncludePossiblySameRelations | SzEntityIncludePossiblyRelatedRelations | SzEntityIncludeNameOnlyRelations | SzEntityIncludeDisclosedRelations | SzEntityIncludeRecordMatchingInfo | SzEntityIncludeRelatedMatchingInfo

Field Value

SzFlag

Remarks

The included SzFlag values are:

All the flags in this constant belong to the SzEntityFlags usage group, and by extension belong to the following usage groups which are super sets:

See Also

https://docs.senzing.com/flags/index.html

SzEntityCoreFlags

The aggregate SzFlag to produce basic entity output without any related entity data.

public const SzFlag SzEntityCoreFlags = SzEntityIncludeRepresentativeFeatures | SzEntityIncludeEntityName | SzEntityIncludeRecordSummary | SzEntityIncludeRecordData | SzEntityIncludeRecordMatchingInfo

Field Value

SzFlag

Remarks

This constant may be used directly but is primarily used as a basis for other aggregate constants.

The included SzFlag values are:

All the flags in this constant belong to the SzEntityFlags usage group, and by extension belong to the following usage groups which are super sets:

See Also

https://docs.senzing.com/flags/index.html

SzEntityDefaultFlags

The aggregate SzFlag to produce the default level of detail when retrieving entities.

public const SzFlag SzEntityDefaultFlags = SzEntityIncludePossiblySameRelations | SzEntityIncludePossiblyRelatedRelations | SzEntityIncludeNameOnlyRelations | SzEntityIncludeDisclosedRelations | SzEntityIncludeRepresentativeFeatures | SzEntityIncludeEntityName | SzEntityIncludeRecordSummary | SzEntityIncludeRecordData | SzEntityIncludeRecordMatchingInfo | SzEntityIncludeRelatedEntityName | SzEntityIncludeRelatedMatchingInfo | SzEntityIncludeRelatedRecordSummary

Field Value

SzFlag

Remarks

The included SzFlag values are:

All the flags in this constant belong to the SzEntityFlags usage group, and by extension belong to the following usage groups which are super sets:

See Also

https://docs.senzing.com/flags/index.html

SzEntityIncludeAllRelations

The aggregate SzFlag for including all relations for entities.

public const SzFlag SzEntityIncludeAllRelations = SzEntityIncludePossiblySameRelations | SzEntityIncludePossiblyRelatedRelations | SzEntityIncludeNameOnlyRelations | SzEntityIncludeDisclosedRelations

Field Value

SzFlag

Remarks

The included SzFlag values are:

All the flags in this constant belong to the SzEntityFlags usage group, and by extension belong to the following usage groups which are super sets:

See Also

https://docs.senzing.com/flags/index.html

SzExportAllFlags

The SzFlag value that aggregates all SzFlag constants belonging to the SzExportFlags usage group.

public const SzFlag SzExportAllFlags = SzExportIncludeMultiRecordEntities | SzExportIncludePossiblySame | SzExportIncludePossiblyRelated | SzExportIncludeNameOnly | SzExportIncludeDisclosed | SzExportIncludeSingleRecordEntities | SzEntityIncludePossiblySameRelations | SzEntityIncludePossiblyRelatedRelations | SzEntityIncludeNameOnlyRelations | SzEntityIncludeDisclosedRelations | SzEntityIncludeAllFeatures | SzEntityIncludeRepresentativeFeatures | SzEntityIncludeEntityName | SzEntityIncludeRecordSummary | SzEntityIncludeRecordData | SzEntityIncludeRecordMatchingInfo | SzEntityIncludeRecordJsonData | SzEntityIncludeRecordFeatures | SzEntityIncludeRelatedEntityName | SzEntityIncludeRelatedMatchingInfo | SzEntityIncludeRelatedRecordSummary | SzEntityIncludeRelatedRecordData | SzEntityIncludeInternalFeatures | SzEntityIncludeFeatureStats | SzEntityIncludeRecordTypes | SzEntityIncludeRelatedRecordTypes | SzEntityIncludeRecordUnmappedData | SzIncludeMatchKeyDetails | SzEntityIncludeRecordFeatureDetails | SzEntityIncludeRecordFeatureStats

Field Value

SzFlag

See Also

SzExportFlags

SzExportDefaultFlags

The aggregate SzFlag representing the default settings for exporting entities.

public const SzFlag SzExportDefaultFlags = SzExportIncludeMultiRecordEntities | SzExportIncludeSingleRecordEntities | SzEntityIncludePossiblySameRelations | SzEntityIncludePossiblyRelatedRelations | SzEntityIncludeNameOnlyRelations | SzEntityIncludeDisclosedRelations | SzEntityIncludeRepresentativeFeatures | SzEntityIncludeEntityName | SzEntityIncludeRecordSummary | SzEntityIncludeRecordData | SzEntityIncludeRecordMatchingInfo | SzEntityIncludeRelatedEntityName | SzEntityIncludeRelatedMatchingInfo | SzEntityIncludeRelatedRecordSummary

Field Value

SzFlag

Remarks

The included SzFlag values are:

All the flags in this constant belong to the following usage groups:

See Also

https://docs.senzing.com/flags/index.html

SzExportIncludeAllEntities

The aggregate SzFlag for export functionality to indicate that all entities should be included in an export.

public const SzFlag SzExportIncludeAllEntities = SzExportIncludeMultiRecordEntities | SzExportIncludeSingleRecordEntities

Field Value

SzFlag

Remarks

The included SzFlag values are:

All the flags in this constant belong to the following usage groups:

See Also

https://docs.senzing.com/flags/index.html

SzExportIncludeAllHavingRelationships

The aggregate SzFlag for export functionality to indicate that entities having relationships of any kind should be included in an export.

public const SzFlag SzExportIncludeAllHavingRelationships = SzExportIncludePossiblySame | SzExportIncludePossiblyRelated | SzExportIncludeNameOnly | SzExportIncludeDisclosed

Field Value

SzFlag

Remarks

The included SzFlag values are:

All the flags in this constant belong to the following usage groups:

See Also

https://docs.senzing.com/flags/index.html

SzFindNetworkAllFlags

The SzFlag value that aggregates all SzFlag constants belonging to the SzFindNetworkFlags usage group.

public const SzFlag SzFindNetworkAllFlags = SzEntityIncludePossiblySameRelations | SzEntityIncludePossiblyRelatedRelations | SzEntityIncludeNameOnlyRelations | SzEntityIncludeDisclosedRelations | SzEntityIncludeAllFeatures | SzEntityIncludeRepresentativeFeatures | SzEntityIncludeEntityName | SzEntityIncludeRecordSummary | SzEntityIncludeRecordData | SzEntityIncludeRecordMatchingInfo | SzEntityIncludeRecordJsonData | SzEntityIncludeRecordFeatures | SzEntityIncludeRelatedEntityName | SzEntityIncludeRelatedMatchingInfo | SzEntityIncludeRelatedRecordSummary | SzEntityIncludeRelatedRecordData | SzEntityIncludeInternalFeatures | SzEntityIncludeFeatureStats | SzEntityIncludeRecordTypes | SzEntityIncludeRelatedRecordTypes | SzEntityIncludeRecordUnmappedData | SzFindNetworkIncludeMatchingInfo | SzIncludeMatchKeyDetails | SzEntityIncludeRecordFeatureDetails | SzEntityIncludeRecordFeatureStats

Field Value

SzFlag

See Also

SzFindNetworkFlags

SzFindNetworkDefaultFlags

The aggregate SzFlag representing the default settings for finding entity networks.

public const SzFlag SzFindNetworkDefaultFlags = SzEntityIncludeEntityName | SzEntityIncludeRecordSummary | SzFindNetworkIncludeMatchingInfo

Field Value

SzFlag

Remarks

The included SzFlag values are:

All the flags in this constant belong to the following usage groups:

See Also

https://docs.senzing.com/flags/index.html

SzFindPathAllFlags

The SzFlag value that aggregates all SzFlag constants belonging to the SzFindPathFlags usage group.

public const SzFlag SzFindPathAllFlags = SzEntityIncludePossiblySameRelations | SzEntityIncludePossiblyRelatedRelations | SzEntityIncludeNameOnlyRelations | SzEntityIncludeDisclosedRelations | SzEntityIncludeAllFeatures | SzEntityIncludeRepresentativeFeatures | SzEntityIncludeEntityName | SzEntityIncludeRecordSummary | SzEntityIncludeRecordData | SzEntityIncludeRecordMatchingInfo | SzEntityIncludeRecordJsonData | SzEntityIncludeRecordFeatures | SzEntityIncludeRelatedEntityName | SzEntityIncludeRelatedMatchingInfo | SzEntityIncludeRelatedRecordSummary | SzEntityIncludeRelatedRecordData | SzEntityIncludeInternalFeatures | SzEntityIncludeFeatureStats | SzFindPathStrictAvoid | SzEntityIncludeRecordTypes | SzEntityIncludeRelatedRecordTypes | SzFindPathIncludeMatchingInfo | SzEntityIncludeRecordUnmappedData | SzIncludeMatchKeyDetails | SzEntityIncludeRecordFeatureDetails | SzEntityIncludeRecordFeatureStats

Field Value

SzFlag

See Also

SzFindPathFlags

SzFindPathDefaultFlags

The aggregate SzFlag representing the default settings for finding entity paths.

public const SzFlag SzFindPathDefaultFlags = SzEntityIncludeEntityName | SzEntityIncludeRecordSummary | SzFindPathIncludeMatchingInfo

Field Value

SzFlag

Remarks

The included SzFlag values are:

All the flags in this constant belong to the following usage groups:

See Also

https://docs.senzing.com/flags/index.html

SzHowAllFlags

The SzFlag value that aggregates all SzFlag constants belonging to the SzHowFlags usage group.

public const SzFlag SzHowAllFlags = SzIncludeFeatureScores | SzIncludeMatchKeyDetails

Field Value

SzFlag

See Also

SzHowFlags

SzHowEntityDefaultFlags

The aggregate SzFlag representing the default settings for "how entity" operations.

public const SzFlag SzHowEntityDefaultFlags = SzIncludeFeatureScores

Field Value

SzFlag

Remarks

The included SzFlag values are:

All the flags in this constant belong to the following usage groups:

See Also

https://docs.senzing.com/flags/index.html

SzModifyAllFlags

The SzFlag value that aggregates all SzFlag constants belonging to the SzModifyFlags usage group.

public const SzFlag SzModifyAllFlags = SzWithInfo

Field Value

SzFlag

See Also

SzModifyFlags

SzNoFlagUsageGroups

The value representing no SzFlagUsageGroup values (i.e.: zero typed as the enum).

public const SzFlagUsageGroup SzNoFlagUsageGroups = (SzFlagUsageGroup)0

Field Value

SzFlagUsageGroup

SzNoFlags

The value representing no flags are being passed.

public const SzFlag SzNoFlags = (SzFlag)0

Field Value

SzFlag

Remarks

Alternatively, a null value will indicate no flags as well.

SzRecordAllFlags

The SzFlag value that aggregates all SzFlag constants belonging to the SzRecordFlags usage group.

public const SzFlag SzRecordAllFlags = SzEntityIncludeRecordMatchingInfo | SzEntityIncludeRecordJsonData | SzEntityIncludeInternalFeatures | SzEntityIncludeRecordTypes | SzEntityIncludeRecordUnmappedData | SzEntityIncludeRecordFeatureDetails | SzEntityIncludeRecordFeatureStats

Field Value

SzFlag

See Also

SzRecordFlags

SzRecordDefaultFlags

The aggregate SzFlag to produce the default level of detail when retrieving records.

public const SzFlag SzRecordDefaultFlags = SzEntityIncludeRecordJsonData

Field Value

SzFlag

Remarks

The included SzFlag values are:

All the flags in this constant belong to the SzRecordFlags usage group, and by extension belong to the following usage groups which are super sets:

See Also

https://docs.senzing.com/flags/index.html

SzSearchAllFlags

The SzFlag value that aggregates all SzFlag constants belonging to the SzSearchFlags usage group.

public const SzFlag SzSearchAllFlags = SzExportIncludeMultiRecordEntities | SzExportIncludePossiblySame | SzExportIncludePossiblyRelated | SzExportIncludeNameOnly | SzEntityIncludePossiblySameRelations | SzEntityIncludePossiblyRelatedRelations | SzEntityIncludeNameOnlyRelations | SzEntityIncludeDisclosedRelations | SzEntityIncludeAllFeatures | SzEntityIncludeRepresentativeFeatures | SzEntityIncludeEntityName | SzEntityIncludeRecordSummary | SzEntityIncludeRecordData | SzEntityIncludeRecordMatchingInfo | SzEntityIncludeRecordJsonData | SzEntityIncludeRecordFeatures | SzEntityIncludeRelatedEntityName | SzEntityIncludeRelatedMatchingInfo | SzEntityIncludeRelatedRecordSummary | SzEntityIncludeRelatedRecordData | SzEntityIncludeInternalFeatures | SzEntityIncludeFeatureStats | SzSearchIncludeStats | SzEntityIncludeRecordTypes | SzEntityIncludeRelatedRecordTypes | SzEntityIncludeRecordUnmappedData | SzSearchIncludeAllCandidates | SzIncludeMatchKeyDetails | SzEntityIncludeRecordFeatureDetails | SzEntityIncludeRecordFeatureStats | SzSearchIncludeRequest | SzSearchIncludeRequestDetails

Field Value

SzFlag

See Also

SzSearchFlags

SzSearchByAttributesAll

The aggregate SzFlag indicating that search results should include all matching entities regardless of match level.

public const SzFlag SzSearchByAttributesAll = SzExportIncludeMultiRecordEntities | SzExportIncludePossiblySame | SzExportIncludePossiblyRelated | SzExportIncludeNameOnly | SzEntityIncludeRepresentativeFeatures | SzEntityIncludeEntityName | SzEntityIncludeRecordSummary | SzIncludeFeatureScores

Field Value

SzFlag

Remarks

The included SzFlag values are:

All the flags in this constant belong to the following usage groups:

See Also

https://docs.senzing.com/flags/index.html

SzSearchByAttributesDefaultFlags

The aggregate SzFlag representing the default flags for "search by attribute" operations.

public const SzFlag SzSearchByAttributesDefaultFlags = SzExportIncludeMultiRecordEntities | SzExportIncludePossiblySame | SzExportIncludePossiblyRelated | SzExportIncludeNameOnly | SzEntityIncludeRepresentativeFeatures | SzEntityIncludeEntityName | SzEntityIncludeRecordSummary | SzIncludeFeatureScores

Field Value

SzFlag

Remarks

The included SzFlag values are:

All the flags in this constant belong to the following usage groups:

See Also

https://docs.senzing.com/flags/index.html

SzSearchByAttributesMinimalAll

The aggregate SzFlag indicating that search results should include all matching entities regardless of match level while returning minimal data for those entities.

public const SzFlag SzSearchByAttributesMinimalAll = SzExportIncludeMultiRecordEntities | SzExportIncludePossiblySame | SzExportIncludePossiblyRelated | SzExportIncludeNameOnly

Field Value

SzFlag

Remarks

The included SzFlag values are:

All the flags in this constant belong to the following usage groups:

See Also

https://docs.senzing.com/flags/index.html

SzSearchByAttributesMinimalStrong

The aggregate SzFlag indicating that search results should only include strongly matching entities while returning miniaml data for those matching entities.

public const SzFlag SzSearchByAttributesMinimalStrong = SzExportIncludeMultiRecordEntities | SzExportIncludePossiblySame

Field Value

SzFlag

Remarks

The included SzFlag values are:

All the flags in this constant belong to the following usage groups:

See Also

https://docs.senzing.com/flags/index.html

SzSearchByAttributesStrong

The aggregate SzFlag indicating that search results should only include strongly matching entities.

public const SzFlag SzSearchByAttributesStrong = SzExportIncludeMultiRecordEntities | SzExportIncludePossiblySame | SzEntityIncludeRepresentativeFeatures | SzEntityIncludeEntityName | SzEntityIncludeRecordSummary | SzIncludeFeatureScores

Field Value

SzFlag

Remarks

The included SzFlag values are:

All the flags in this constant belong to the following usage groups:

See Also

https://docs.senzing.com/flags/index.html

SzSearchIncludeAllEntities

The aggregate SzFlag for search functionality to indicate that search results should include entities that are related to the search attributes at any match level.

public const SzFlag SzSearchIncludeAllEntities = SzExportIncludeMultiRecordEntities | SzExportIncludePossiblySame | SzExportIncludePossiblyRelated | SzExportIncludeNameOnly

Field Value

SzFlag

Remarks

The included SzFlag values are:

All the flags in this constant belong to the following usage groups:

See Also

https://docs.senzing.com/flags/index.html

SzVirtualEntityAllFlags

The SzFlag value that aggregates all SzFlag constants belonging to the SzVirtualEntityFlags usage group.

public const SzFlag SzVirtualEntityAllFlags = SzEntityIncludeAllFeatures | SzEntityIncludeRepresentativeFeatures | SzEntityIncludeEntityName | SzEntityIncludeRecordSummary | SzEntityIncludeRecordData | SzEntityIncludeRecordMatchingInfo | SzEntityIncludeRecordJsonData | SzEntityIncludeRecordFeatures | SzEntityIncludeInternalFeatures | SzEntityIncludeFeatureStats | SzEntityIncludeRecordTypes | SzEntityIncludeRecordUnmappedData | SzEntityIncludeRecordFeatureDetails | SzEntityIncludeRecordFeatureStats

Field Value

SzFlag

See Also

SzVirtualEntityFlags

SzVirtualEntityDefaultFlags

The aggregate SzFlag representing the default settings when retrieving virtual entities.

public const SzFlag SzVirtualEntityDefaultFlags = SzEntityIncludeRepresentativeFeatures | SzEntityIncludeEntityName | SzEntityIncludeRecordSummary | SzEntityIncludeRecordData | SzEntityIncludeRecordMatchingInfo

Field Value

SzFlag

Remarks

The included SzFlag values are:

All the flags in this constant belong to the following usage groups:

See Also

https://docs.senzing.com/flags/index.html

SzWhyAllFlags

The SzFlag value that aggregates all SzFlag constants belonging to the SzWhyFlags usage group.

public const SzFlag SzWhyAllFlags = SzEntityIncludePossiblySameRelations | SzEntityIncludePossiblyRelatedRelations | SzEntityIncludeNameOnlyRelations | SzEntityIncludeDisclosedRelations | SzEntityIncludeAllFeatures | SzEntityIncludeRepresentativeFeatures | SzEntityIncludeEntityName | SzEntityIncludeRecordSummary | SzEntityIncludeRecordData | SzEntityIncludeRecordMatchingInfo | SzEntityIncludeRecordJsonData | SzEntityIncludeRecordFeatures | SzEntityIncludeRelatedEntityName | SzEntityIncludeRelatedMatchingInfo | SzEntityIncludeRelatedRecordSummary | SzEntityIncludeRelatedRecordData | SzEntityIncludeInternalFeatures | SzEntityIncludeFeatureStats | SzIncludeFeatureScores | SzEntityIncludeRecordTypes | SzEntityIncludeRelatedRecordTypes | SzEntityIncludeRecordUnmappedData | SzIncludeMatchKeyDetails | SzEntityIncludeRecordFeatureDetails | SzEntityIncludeRecordFeatureStats

Field Value

SzFlag

See Also

SzWhyFlags

SzWhyEntitiesDefaultFlags

The aggregate SzFlag representing the default settings for "why entity" operations.

public const SzFlag SzWhyEntitiesDefaultFlags = SzEntityIncludePossiblySameRelations | SzEntityIncludePossiblyRelatedRelations | SzEntityIncludeNameOnlyRelations | SzEntityIncludeDisclosedRelations | SzEntityIncludeRepresentativeFeatures | SzEntityIncludeEntityName | SzEntityIncludeRecordSummary | SzEntityIncludeRecordData | SzEntityIncludeRecordMatchingInfo | SzEntityIncludeRelatedEntityName | SzEntityIncludeRelatedMatchingInfo | SzEntityIncludeRelatedRecordSummary | SzEntityIncludeInternalFeatures | SzEntityIncludeFeatureStats | SzIncludeFeatureScores

Field Value

SzFlag

Remarks

The included SzFlag values are:

All the flags in this constant belong to the following usage groups:

See Also

https://docs.senzing.com/flags/index.html

SzWhyRecordInEntityDefaultFlags

The aggregate SzFlag representing the default settings for "why record in entity" operations.

public const SzFlag SzWhyRecordInEntityDefaultFlags = SzEntityIncludePossiblySameRelations | SzEntityIncludePossiblyRelatedRelations | SzEntityIncludeNameOnlyRelations | SzEntityIncludeDisclosedRelations | SzEntityIncludeRepresentativeFeatures | SzEntityIncludeEntityName | SzEntityIncludeRecordSummary | SzEntityIncludeRecordData | SzEntityIncludeRecordMatchingInfo | SzEntityIncludeRelatedEntityName | SzEntityIncludeRelatedMatchingInfo | SzEntityIncludeRelatedRecordSummary | SzEntityIncludeInternalFeatures | SzEntityIncludeFeatureStats | SzIncludeFeatureScores

Field Value

SzFlag

Remarks

The included SzFlag values are:

All the flags in this constant belong to the following usage groups:

See Also

https://docs.senzing.com/flags/index.html

SzWhyRecordsDefaultFlags

The aggregate SzFlag representing the default settings for "why records" operations.

public const SzFlag SzWhyRecordsDefaultFlags = SzEntityIncludePossiblySameRelations | SzEntityIncludePossiblyRelatedRelations | SzEntityIncludeNameOnlyRelations | SzEntityIncludeDisclosedRelations | SzEntityIncludeRepresentativeFeatures | SzEntityIncludeEntityName | SzEntityIncludeRecordSummary | SzEntityIncludeRecordData | SzEntityIncludeRecordMatchingInfo | SzEntityIncludeRelatedEntityName | SzEntityIncludeRelatedMatchingInfo | SzEntityIncludeRelatedRecordSummary | SzEntityIncludeInternalFeatures | SzEntityIncludeFeatureStats | SzIncludeFeatureScores

Field Value

SzFlag

Remarks

The included SzFlag values are:

All the flags in this constant belong to the following usage groups:

See Also

https://docs.senzing.com/flags/index.html

Methods

FlagsToLong(SzFlag?)

Converts a nullable SzFlag to a non-null long value representation of the flag with all the appropriate bits set.

public static long FlagsToLong(SzFlag? flags)

Parameters

flags SzFlag?

Returns

long

FlagsToString(SzFlag)

Returns the string representation describing the respective SzFlag value.

public static string FlagsToString(this SzFlag flag)

Parameters

flag SzFlag

The SzFlag on which to operate.

Returns

string

The string representation describing the respective SzFlag which may be an aggregate value.

FlagsToString(SzFlagUsageGroup, SzFlag?)

Formats a string representation of the specified SzFlag according to the SzFlag instances associated with the respective SzFlagUsageGroup.

public static string FlagsToString(this SzFlagUsageGroup group, SzFlag? flag)

Parameters

group SzFlagUsageGroup

The SzFlagUsageGroup on which to operate.

flag SzFlag?

The SzFlag value (which may be an aggregate value) to format as a string.

Returns

string

The string describing the specified flags.

Remarks

NOTE: This method is useful in logging which flags were past to a particular method using the SzFlagUsageGroup for the flags that are accepted by that method.

Some SzFlag values have the same underlying bitwise flag value which can lead to ambiguity with the default ToString() implementation for enums. However, none of the SzFlag instances for a single SzFlagUsageGroup should overlap in bitwise values and this method will prefer the SzFlag symbol belonging to the respective SzFlagUsageGroup for formatting the string.

If the respective SzFlagUsageGroup is an aggregate group value representing multiple groups (or no groups) then this method simply defaults to formatting the set bit values using numeric representation, foregoing the use of symbolic flag names altogether.

FlagsToString(SzFlag?)

Returns the string representation describing the specified SzFlag value.

public static string FlagsToString(SzFlag? flag)

Parameters

flag SzFlag?

The SzFlag to format as a string.

Returns

string

The string representation describing the specified SzFlag which may be an aggregate value.

GetFlags(SzFlagUsageGroup)

Obtains the flags belonging to an individualSzFlagUsageGroup as an aggregate SzFlag value for all flags associated with the specfied group.

public static SzFlag GetFlags(SzFlagUsageGroup group)

Parameters

group SzFlagUsageGroup

The individualSzFlagUsageGroup for which to obtain the list of flags with their names.

Returns

SzFlag

The aggregate SzFlag value with the bits set for all flags belonging to specified individualSzFlagUsageGroup.

Exceptions

ArgumentException

If the specfied SzFlagUsageGroup is itself an aggregate value of multiple groups or equal to SzNoFlagUsageGroups (i.e.: zero).

GetFlagsByName()

Obtains all individually declared flag constants from SzFlag as a read-only dictionary of individual SzFlag symbolic name keys mapped to SzFlag values.

public static ReadOnlyDictionary<string, SzFlag> GetFlagsByName()

Returns

ReadOnlyDictionary<string, SzFlag>

The read-only dictionary of individual SzFlag symbolic name keys mapped to SzFlag values for all individual flag constants from the SzFlag enum.

Remarks

NOTE: The is provided for disambiguation of different flags that otherwise have the same value (e.g.: SzSearchIncludePossiblySame and SzExportIncludePossiblySame).

GetFlagsByName(SzFlagUsageGroup)

Obtains the flags belonging to an individualSzFlagUsageGroup as a read-only dictionary of individual SzFlag symbolic name keys mapped to SzFlag values.

public static ReadOnlyDictionary<string, SzFlag> GetFlagsByName(SzFlagUsageGroup group)

Parameters

group SzFlagUsageGroup

The individualSzFlagUsageGroup for which to obtain the list of flags with their names.

Returns

ReadOnlyDictionary<string, SzFlag>

A read-only dictionary of individual SzFlag symbolic name keys mapped to SzFlag values for those flags belonging to specified individualSzFlagUsageGroup.

Remarks

NOTE: The is provided as an alternative to GetFlags(SzFlagUsageGroup) for disambiguation of different flags that otherwise have the same value (e.g.: SzSearchIncludePossiblySame and SzExportIncludePossiblySame).

Exceptions

ArgumentException

If the specfied SzFlagUsageGroup is itself an aggregate value of multiple groups or equal to SzNoFlagUsageGroups (i.e.: zero).

GetGroups(string)

Gets the aggregate SzFlagUsageGroup value representing the one or more usage groups associated with the specified symbolic SzFlag name.

public static SzFlagUsageGroup GetGroups(string symbolicFlagName)

Parameters

symbolicFlagName string

The symbolic flag name from the SzFlagenum.

Returns

SzFlagUsageGroup

The SzFlagUsageGroup value that aggregates all the groups associated with the specified SzFlag symbolic name.

Remarks

If the specified name is not recognized as a symbolic name from the SzFlagenum then an ArgumentException is thrown.

Exceptions

ArgumentException

If the specified symbolic flag name is not recognized as an enum symbol from the SzFlagenum.

GetNamesByFlag(SzFlagUsageGroup)

Obtains the flags belonging to an individualSzFlagUsageGroup as a read-only dictionary of individual SzFlag keys mapped to SzFlag symbolic name values.

public static ReadOnlyDictionary<SzFlag, string> GetNamesByFlag(SzFlagUsageGroup group)

Parameters

group SzFlagUsageGroup

The individualSzFlagUsageGroup for which to obtain the list of flags with their names.

Returns

ReadOnlyDictionary<SzFlag, string>

A read-only dictionary of individual SzFlag keys mapped to SzFlag symbolic name values for those flags belonging to specified individualSzFlagUsageGroup.

Remarks

NOTE: The is provided as an alternative to GetFlags(SzFlagUsageGroup) for disambiguation of different flags that otherwise have the same value (e.g.: SzSearchIncludePossiblySame and SzExportIncludePossiblySame) so the actual flag name can be obtained with respect to a specific SzFlagUsageGroup since there is no ambiguiuty within a group.

Exceptions

ArgumentException

If the specfied SzFlagUsageGroup is itself an aggregate value of multiple groups or equal to SzNoFlagUsageGroups (i.e.: zero).