CAM API
  • CAM API
v20.0.1
Search Results for

    Show / Hide Table of Contents

    Interface ICamApiUserParametersList

    Editable list of the user-defined parameters of a tech operation. Obtained from ICamApiTechOperation.GetUserParameters. The list is live: changes are written straight into the operation and saved with the project.

    Namespace: CAMAPI.TechOperation
    Assembly: CAMAPI.TechOperation.dll
    Syntax
    [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
    [Guid("58552FE9-2A1E-44EF-AB4B-E90FA21D7317")]
    public interface ICamApiUserParametersList

    Properties

    Count

    Number of user parameters.

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

    Methods

    Add(string, string, string, out TResultStatus)

    Declaration
    ICamApiUserParameter Add(string Name, string Value, string Comment, out TResultStatus ResultStatus)
    Parameters
    Type Name Description
    string Name
    string Value
    string Comment
    TResultStatus ResultStatus
    Returns
    Type Description
    ICamApiUserParameter

    Delete(string)

    Delete the parameter with the given name. Returns false if there was no such parameter.

    Declaration
    bool Delete(string Name)
    Parameters
    Type Name Description
    string Name
    Returns
    Type Description
    bool

    FindByName(string)

    Parameter with the given name, or nil if there is no such parameter.

    Declaration
    ICamApiUserParameter FindByName(string Name)
    Parameters
    Type Name Description
    string Name
    Returns
    Type Description
    ICamApiUserParameter

    GetItem(int, out TResultStatus)

    Declaration
    ICamApiUserParameter GetItem(int Index, out TResultStatus ResultStatus)
    Parameters
    Type Name Description
    int Index
    TResultStatus ResultStatus
    Returns
    Type Description
    ICamApiUserParameter

    IndexOf(string)

    Index of the parameter with the given name, or -1 if there is no such parameter.

    Declaration
    int IndexOf(string Name)
    Parameters
    Type Name Description
    string Name
    Returns
    Type Description
    int
    In this article