Sets the StatusValue expression.
Description
Syntax
| Visual Basic |
|---|
Public Sub SetStatusValueExpression( _ ByVal StatusType As MFStatusType, _ Optional ByVal DataFunctionCall As DataFunctionCall = 0 _ ) |
Parameters
- StatusType
The status type identifies the evaluated feature of an object's status. Status type flags cannot be combined. Use only one single value at a time.Value Description MFStatusTypeCheckedOut The object's checked-out state. MFStatusTypeCheckedOutAt The date when the object was checked out. MFStatusTypeCheckedOutTo The user who has checked out the object. MFStatusTypeDeleted The deletion state of the object. MFStatusTypeExtID External ID. MFStatusTypeIsLatestCheckedInVersion The version must be the latest checked-in version. MFStatusTypeLatestOrSpecific The latest version / specific version indicator. For the latest version, the indicator yields 'Latest' and 'Specific'. For others, the indicator yields only 'Specific'. MFStatusTypeObjectFlags The object flags of the object. Does not include the deleted flag. MFStatusTypeObjectID The ID of the object. MFStatusTypeObjectTypeAndID The type and ID of the object. MFStatusTypeObjectTypeID The ID of the object type. MFStatusTypeObjectVersionID The ID of the object version. MFStatusTypeOriginalObjectID The ID of the object in the vault in which the object was originally created. MFStatusTypeOriginalObjectIDSegment The ID segment of the object in the vault in which the object was originally created. Segment size is always 1000. MFStatusTypeOriginalObjectType The type of the object in the vault in which the object was originally created. MFStatusTypeOriginalVaultGUID The GUID of the vault in which the object was originally created. - DataFunctionCall
Defines an optional data function for modifying the expression result. The data function availability depends on the evaluated data type.
In scripting languages, a specific null value (e.g., Nothing in VBScript) should be used to indicate the default value.
Remarks
Status value expression is used to evaluate the status of the vault object. The evaluated status data is identified by status type parameter.
The target value (the right-hand operand) is placed to the TypedValue object encapsulated in the parent SearchCondition object. The type of this value depends on the status type.
Right-hand operand types for status types:
|
Permission expression type |
Expected typed value data type | Remarks |
|---|---|---|
|
MFStatusTypeCheckedOut |
MFDatatypeBoolean | |
|
MFStatusTypeCheckedOutTo |
MFDatatypeLookup | Reference to built-in vault users value list. See UserAccount class for resolving the user id for the lookup reference. |
|
MFStatusTypeCheckedOutAt |
MFDatatypeTimestamp | |
|
MFStatusTypeObjectID |
MFDatatypeInteger | |
|
MFStatusTypeObjectVersionID |
MFDatatypeInteger | |
|
MFStatusTypeDeleted |
MFDatatypeBoolean | |
|
MFStatusTypeObjectTypeID |
MFDatatypeLookup | Object type id is passed as lookup target id. Version part is not used. |
|
MFStatusTypeIsLatestCheckedInVersion |
MFDatatypeBoolean | |
|
MFStatusTypeExtID |
MFDatatypeText | |
|
MFStatusTypeLatestOrSpecific |
MFDatatypeLookup or MFDatatypeMultiSelectLookup | Not used in searches. |
Status-based conditions and expressions as seen in M-Files Desktop.
See Also