ObjectsDeleteAll

Elimina todos los objetos del tipo especificado del gráfico especificado (subventana del gráfico especificada).

int  ObjectsDeleteAll(
   long  chart_id,           // identificador del gráfico
   int   sub_window=-1,      // índice de ventana
   int   type=-1             // tipo del objeto a eliminar
   );

Elimina todos los objetos del tipo especificado en la subventana del gráfico según el prefijo del nombre.

int  ObjectsDeleteAll(
   long           chart_id,  // identificador del gráfico
   const string     prefix,  // prefijo del nombre del objeto
   int       sub_window=-1,  // índice de la ventana
   int      object_type=-1   // tipo del objeto a eliminar
   );

Parámetros

chart_id

[in]  Identificador del gráfico. 0 significa el gráfico actual.

prefix

[in]  Prefijo para eliminar todos los objetos cuyos nombres empiezan con este conjunto de caracteres. Se puede indicar el perfijo como 'name' o 'name*' — ambas opciones funcionan igualmente. Si se indica la línea vacía como prefijo, se eliminarán los objetos con cualquier nombre.

sub_window=-1

[in]  Número de subventana del gráfico. 0 significa la ventana principal, -1 significa todas las subventanas del gráfico, incluyendo la ventana principal.

type=-1

[in]  Tipo del objeto. Su valor puede ser uno de los valores de la enumeración ENUM_OBJECT. -1 significa todos los tipos.

Valor devuelto

Devuelve el número de objetos eliminados. Para la información más detallada sobre el error hay que llamar a la función GetLastError().

Nota

La función usa una llamada sincrónica, esto significa que la función espera a la ejecución de todos los comandos que han sido ubicados en la cola del gráfico antes de su llamada, y por eso puede consumir un tiempo considerable. Hay que tener esta circunstancia en cuenta al trabajar con multitud de objetos en el gráfico.