Share via

WORKFLOW_PARAMETER_TYPE Class

  • Article

The WORKFLOW_PARAMETER_TYPE class lists the possible values for workflow parameter type. Please note that although the APIs may accept any value, these are the valid values. For more information about the use of this class, see Parameters in the Workflow Reference.

This class does not need instantiation or initialization because the fields represent constant integer values. These values are intended to be used when constructing XML string parameters used in the Microsoft CRM APIs.

System.Object
   WORKFLOW_PARAMETER_TYPE

[Visual Basic .NET]
Public Class WORKFLOW_PARAMETER_TYPE
   Inherits System.Object
[C#]
public class WORKFLOW_PARAMETER_TYPE: System.Object
[C++]
public __gc class WORKFLOW_PARAMETER_TYPE: public System.Object

The WORKFLOW_PARAMETER_TYPE class exposes the following integer fields.

Field Value Description
WFPM_ABS 405 Specifies an absolute value function: abs (parameter 1). See Parameter - Function.
WFPM_ACTION 3 Specifies that the parameter represents an action's result. See Parameter - Action.

WFPM_ACTION will evaluate the following attributes of an action log:  status, createdon, objectid, objectype.
WFPM_ADD 400 Specifies a function to add the parameters: parameter 1 + ... + parameter n. See Parameter - Function.
WFPM_ALL_ACTIVITIES 601 Specifies to check whether all activities created so far by the workflow process have been closed, including previous steps. Returns true if they are all closed and false if any are not yet closed. See Parameter - Function.
WFPM_AND 301 Specifies parameter 1 && ... && parameter n. See Parameter - Function.
WFPM_ANY_ACTION 602 Specifies to check to see whether any action in current step has failed. See Parameter - Function.
WFPM_BEGIN_WITH 200 Specifies that parameter 1 begins with parameter 2. See Parameter - Function.
WFPM_BETWEEN 106 Specifies that parameter 2 < parameter 1 < parameter 3. See Parameter - Function.
WFPM_CASE 307 Specifies to return the first non-null parameter. See Parameter - Function.
WFPM_CONTAIN 202 Specifies that parameter 1 contains parameter 2. See Parameter - Function.
WFPM_DATE 501 Specifies the current date time. See Parameter - Function.
WFPM_DATEADD 508 Specifies the date add function: parameter 1 + parameter 2 (year) + parameter 3 (month) + parameter 4 (day) + parameter 5 (hour) + parameter 6 (minute). See Parameter - Function.
WFPM_DAY 504 Specifies the day of the month of parameter 1. See Parameter - Function.
WFPM_DIVISION 403 Specifies a divide function: parameter 1/parameter 2. See Parameter - Function.
WFPM_END_WITH 201 Specifies that parameter 1 ends with parameter 2. See Parameter - Function.
WFPM_EQ 104 Specifies that parameter 1 == parameter 2. See Parameter - Function.

To check whether a value is or is not NULL use WFPM_ISNULL, parented by WFPM_NOT. WFPM_EQ will cause an error if one of its parameters is NULL.
WFPM_EXIST 150 Specifies that parameter 1 exists and is not an empty string. See Parameter - Function.
WFPM_FALSE 305 Specifies to always fail. See Parameter - Function.
WFPM_GEQ 101 Specifies that parameter 1 >= parameter 2. See Parameter - Function.
WFPM_GT 100 Specifies that the parameter 1 > parameter 2. See Parameter - Function.
WFPM_HOUR 503 Specifies the hour of parameter 1. See Parameter - Function.
WFPM_IFF 306 Specifies that if parameter 1 is true, return parameter 2, otherwise return parameter 3. See Parameter - Function.
WFPM_IN 107 Specifies that parameter 1 is one of parameter 2, parameter 3, and so on. See Parameter - Function.
WFPM_INCIDENT_QUEUE 605 Specifies to return the incident queue. See Parameter - Function.
WFPM_ISNULL 151 Specifies that parameter 1 is null. See Parameter - Function.
WFPM_LEQ 103 Specifies that parameter 1 <= parameter 2. See Parameter - Function.
WFPM_LT 102 Specifies that parameter 1 < parameter 2. See Parameter - Function.
WFPM_MATCH_SUBJECTS 603 Specifies to check whether parameter 2 is a high-level subject of parameter 1. See Parameter - Function.
WFPM_MINUTE 502 Specifies the minute of parameter 1. See Parameter - Function.
WFPM_MODULUS 404 Specifies a modulus function: parameter 1 % parameter 2. See Parameter - Function.
WFPM_MONTH 506 Specifies the month of the year of parameter 1. See Parameter - Function.
WFPM_MULTIPLICATION 402 Specifies a multiply function: parameter 1*...*parameter n. See Parameter - Function.
WFPM_NEQ 105 Specifies that parameter 1 <> parameter 2. See Parameter - Function.
WFPM_NONE 0 Specifies no parameter type.
WFPM_NOT 303 Specifies not parameter 1. See Parameter - Function.
WFPM_NULL 152 Specifies that a null value is always returned. See Parameter - Function.
WFPM_OR 302 Specifies parameter 1 || ... || parameter n. See Parameter - Function.
WFPM_PROCESS 4 Specifies that the parameter represents a current process instance attribute. See Parameter - Process.

WFPM_PROCESS evaluates the attributes of the current process instance:  lastactivityon, objectid, objecttype, processinstancestatecode, startedon, currentstepid.
WFPM_PROPERTY 2 Specifies that the parameter represents a property in evaluation context. See Parameter - Property.
WFPM_SELECT 9 Specifies that the parameter represents a select function. See Parameter - Select.

Only the first result will be returned from WFPM_SELECT, even when datatype is WFDT_XML.
WFPM_STRLEN 203 Specifies a string length of parameter 1. See Parameter - Function.
WFPM_SUBSTR 204 Specifies a substring of parameter 1, starting from parameter 2 with length parameter 3. The position is zero-based.

P2 counts from 0. If P2 is larger than the length of the string, then "" is returned.

See Parameter - Function.
WFPM_SUBTRACTION 401 Specifies a subtract function: parameter 1 - parameter 2. See Parameter - Function.
WFPM_TRUE 304 Specifies always success. See Parameter - Function.
WFPM_USER_QUEUE 604 Specifies to get the user queue. See Parameter - Function.
WFPM_VALUE 1 Specifies that the parameter represents an immediate value. See Parameter - ImmediateValue.
WFPM_WEEKDAY 505 Specifies the weekday of parameter 1. See Parameter - Function.
WFPM_YEAR 507 Specifies the year of parameter 1. See Parameter - Function.

Requirements

Namespace: Microsoft.Crm.Platform.Types

Assembly: Microsoft.Crm.Platform.Types.dll

See Also

© 2005 Microsoft Corporation. All rights reserved.