CAM API
  • CAM API
v20.0.1
Search Results for

    Show / Hide Table of Contents

    Interface IResponseJsonParser

    Response from IPC server

    Namespace: CAMIPC.IpcInteraction
    Assembly: CAMIPC.IpcInteraction.dll
    Syntax
    [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
    [Guid("619BC02D-AFDD-4566-AD9B-F746FBA751A8")]
    public interface IResponseJsonParser

    Properties

    Id

    Value provided in node ID. -1 equals null value

    Declaration
    int Id { get; }
    Property Value
    Type Description
    int

    ValueError

    Value provided as error

    Declaration
    string ValueError { get; }
    Property Value
    Type Description
    string

    ValueResult

    Value provided as success result

    Declaration
    string ValueResult { get; }
    Property Value
    Type Description
    string

    error

    Declaration
    string error { get; }
    Property Value
    Type Description
    string

    result

    Declaration
    string result { get; }
    Property Value
    Type Description
    string

    Methods

    Clear()

    Clear all saved values

    Declaration
    void Clear()

    GetString(out TResultStatus)

    Declaration
    string GetString(out TResultStatus ResultStatus)
    Parameters
    Type Name Description
    TResultStatus ResultStatus
    Returns
    Type Description
    string

    HasError()

    Check response is error

    Declaration
    bool HasError()
    Returns
    Type Description
    bool

    ReadString(string)

    Parse input string and fill self values

    Declaration
    TResultStatus ReadString(string inputString)
    Parameters
    Type Name Description
    string inputString
    Returns
    Type Description
    TResultStatus

    SetError(string)

    Value provided in node error. Error message raised while request was error

    Declaration
    void SetError(string error)
    Parameters
    Type Name Description
    string error

    SetId(int)

    Declaration
    void SetId(int Id)
    Parameters
    Type Name Description
    int Id

    SetResult(string)

    Value provided in node ID. Unique identifier to accord with request

    Declaration
    void SetResult(string result)
    Parameters
    Type Name Description
    string result
    In this article