2.2.3.15.1 InvocationInfo-specific Extended Properties

Error records (section 2.2.3.15) and informational records (section 2.2.3.16) can optionally include extended properties that the higher layer provides in order to describe the higher-layer invocation that caused the error. PSRP implementations MUST NOT interpret this data. Note that these properties can describe a higher-layer command whose name was directly mentioned in a Command data type (section 2.2.3.12), but these properties can also describe an internal higher-layer command that was invoked by an implementation of another higher layer command.

The following is a complete list of InvocationInfo-specific extended properties:

• The command name used to invoke this command; if invoked through an alias, then this is the alias name.

  • Property name: InvocationInfo_InvocationName

  • Property type: String (section 2.2.5.1.1)

• The command line parameters.

  • Property name: InvocationInfo_BoundParameters

  • Property type: Dictionary (section 2.2.5.2.6.4) where keys (representing parameter names) are Strings (section 2.2.5.1.1) and values (representing parameter values) are any Primitive Type Object (section 2.2.5.1) or Complex Object (section 2.2.5.2).

• The unbound command line parameters.

  • Property name: InvocationInfo_UnboundArguments

  • Property type: List (section 2.2.5.2.6.3), where elements (representing parameter values) are any Primitive Type Object (section 2.2.5.1) or Complex Object (section 2.2.5.2).

• The command origin.

  • Property name: InvocationInfo_CommandOrigin

  • Property type: CommandOrigin (section 2.2.3.30)

• Flag indicating whether or not the command was expecting pipeline input.

  • Property name: InvocationInfo_ExpectingInput

  • Property type: Boolean (section 2.2.5.1.3)

• The text of the line that contained this command invocation.

  • Property name: InvocationInfo_Line

  • Property type: String (section 2.2.5.1.1)

• The offset of the first character in InvocationInfo_Line that is associated with this command.

  • Property name: InvocationInfo_OffsetInLine

  • Property type: Signed Int (section 2.2.5.1.11)

• A human-readable message indicating where the command appeared in the command line.

  • Property name: InvocationInfo_PositionMessage

  • Property type: String (section 2.2.5.1.1)

• The name of the script (if executing a script) that invoked this command.

  • Property name: InvocationInfo_ScriptName

  • Property type: String (section 2.2.5.1.1)

• The line number (if executing a script) of the line that invoked this command.

  • Property name: InvocationInfo_ScriptLineNumber

  • Property type: Signed Int (section 2.2.5.1.11)

• A number provided by the higher layer. PSRP does not interpret this data.

  • Property name: InvocationInfo_HistoryId

  • Property type: Signed Long (section 2.2.5.1.13)

• The number of commands in the pipeline.

  • Property name: InvocationInfo_PipelineLength

  • Property type: Signed Int (section 2.2.5.1.11)

• The position of the current command in the pipeline.

  • Property name: InvocationInfo_PipelinePosition

  • Property type: Signed Int (section 2.2.5.1.11)

• The status of the pipeline when this record was created provided by the higher-layer. This SHOULD be set to the same value as PipelineIterationInfo.

  • Property name: InvocationInfo_PipelineIterationInfo

  • Property type: A List (section 2.2.5.2.6.3)) of Signed Int (section 2.2.5.1.11) structures.