.. highlightlang:: us

.. _aop_setpar:

aop_setpar
==========

.. index:: aop_setpar

.. us.tag  aop_setpar NOTREADYENGLISH New500 asam3

:ref:`aop_setpar` sets properties.

.. function::  retState = aop_setpar(envId, nvSeq, cl)

.. us.return

**Return Value**

*retState*.

.. us.params

**Parameters**

.. uparam:: envId

   *envId* is the environment Id, returned by :ref:`aop_openenv`.

.. uparam:: nvSeq

   *nvSeq* is a sequence (array) of name-valMap pairs.
   The following names are defined:

.. list-table::
   :header-rows: 1

   * - Parameter
     - Used for
   * - "USER"
     - Sets Username and Password
   * - "WILDCARD_ONE"
     - wildcard-character for one characer (e. g. "?")
   * - "WILDCARD_ALL"
     - wildcard-chararcer for one or more characters (e. g. "\*")
   * - "WILDCARD_ESC"
     - Escape character (e. g. "\\")

.. uparam:: cl

   *cl* is the client pointer, returned by :ref:`rpc_clnt_create`.

.. us.example

**Example**

::

   valMap = [. dtyp=ODS_DT_STRING, val=["<username>", "<password>"] ];
   nvSeq = [. n = 1];
   nvSeq[1] = [. name = "USER", valMap = valMap];
   retState = aop_setpar(envId, nvSeq, cl);
   if (type(retState) == "error") {
       MessageBoxError(retState.message);
   }

.. us.history

**History**

.. list-table::
   :header-rows: 1

   * - Version
     - Description
   * - 5.0.0
     - New

.. seealso::
   :ref:`overview-asam-ods`

:sub:`id-1541830`