Documentos de Académico
Documentos de Profesional
Documentos de Cultura
WinCC
WinCC Professional V13 SP2 -
Referencia para programación
Manual de sistema
03/2017
Expresión de la ayuda en pantalla
Notas jurídicas
Filosofía en la señalización de advertencias y peligros
Este manual contiene las informaciones necesarias para la seguridad personal así como para la prevención de
daños materiales. Las informaciones para su seguridad personal están resaltadas con un triángulo de advertencia;
las informaciones para evitar únicamente daños materiales no llevan dicho triángulo. De acuerdo al grado de peligro
las consignas se representan, de mayor a menor peligro, como sigue.
PELIGRO
Significa que, si no se adoptan las medidas preventivas adecuadas se producirá la muerte, o bien lesiones
corporales graves.
ADVERTENCIA
Significa que, si no se adoptan las medidas preventivas adecuadas puede producirse la muerte o bien lesiones
corporales graves.
PRECAUCIÓN
Significa que si no se adoptan las medidas preventivas adecuadas, pueden producirse lesiones corporales.
ATENCIÓN
Significa que si no se adoptan las medidas preventivas adecuadas, pueden producirse daños materiales.
Si se dan varios niveles de peligro se usa siempre la consigna de seguridad más estricta en cada caso. Si en una
consigna de seguridad con triángulo de advertencia de alarma de posibles daños personales, la misma consigna
puede contener también una advertencia sobre posibles daños materiales.
Personal cualificado
El producto/sistema tratado en esta documentación sólo deberá ser manejado o manipulado por personal
cualificado para la tarea encomendada y observando lo indicado en la documentación correspondiente a la misma,
particularmente las consignas de seguridad y advertencias en ella incluidas. Debido a su formación y experiencia,
el personal cualificado está en condiciones de reconocer riesgos resultantes del manejo o manipulación de dichos
productos/sistemas y de evitar posibles peligros.
Uso previsto de los productos de Siemens
Considere lo siguiente:
ADVERTENCIA
Los productos de Siemens sólo deberán usarse para los casos de aplicación previstos en el catálogo y la
documentación técnica asociada. De usarse productos y componentes de terceros, éstos deberán haber sido
recomendados u homologados por Siemens. El funcionamiento correcto y seguro de los productos exige que su
transporte, almacenamiento, instalación, montaje, manejo y mantenimiento hayan sido realizados de forma
correcta. Es preciso respetar las condiciones ambientales permitidas. También deberán seguirse las indicaciones
y advertencias que figuran en la documentación asociada.
Marcas registradas
Todos los nombres marcados con ® son marcas registradas de Siemens AG. Los restantes nombres y
designaciones contenidos en el presente documento pueden ser marcas registradas cuya utilización por terceros
para sus propios fines puede violar los derechos de sus titulares.
Exención de responsabilidad
Hemos comprobado la concordancia del contenido de esta publicación con el hardware y el software descritos. Sin
embargo, como es imposible excluir desviaciones, no podemos hacernos responsable de la plena concordancia.
El contenido de esta publicación se revisa periódicamente; si es necesario, las posibles correcciones se incluyen
en la siguiente edición.
Siemens AG Referencia del documento: Expresión de la ayuda en pantalla Copyright © Siemens AG 2017.
Division Digital Factory Ⓟ 05/2017 Sujeto a cambios sin previo aviso Reservados todos los derechos
Postfach 48 48
90026 NÜRNBERG
ALEMANIA
Índice
Descripción
WinCC guarda los nombres de las imágenes que abrió el usuario durante el tiempo de
ejecución, así como el orden en el que se abrieron.
Utilizable sólo en C-Scripting.
El tamaño del búfer de imágenes se determina en el editor "Configuración de runtime >
Imágenes > Búfer de imágenes".
La función de sistema ActivateNextScreen abre la imagen que se abrió antes de la última
llamada de ActivatePreviousScreen.
Sintaxis
BOOL ActivateNextScreen();
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
FALSE
se ha producido un error.
Ejemplo
El siguiente código de programa activa la imagen siguiente con la función ActivateNextScreen
y guarda el valor de retorno en la variable b_error.
{
BOOL b_error;
if(b_error)
{
// User defined code if
// function succeeds without error
...
}
else
{
// User defined code in case of error
...
}
...
}
Descripción
WinCC guarda los nombres de las imágenes que abrió el usuario durante el tiempo de
ejecución, así como el orden en el que se abrieron.
La función de sistema sólo puede utilizarse en C-Scripting.
El tamaño del búfer de imágenes se determina en el editor "Configuración de runtime >
Imágenes > Búfer de imágenes".
La función de sistema ActivatePreviousScreen abre la imagen que estaba abierta antes de la
imagen que se encuentra abierta en estos momentos.
Sintaxis
BOOL ActivatePreviousScreen();
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa activa la imagen anterior con la función
ActivatePreviousScreen y guarda el valor de retorno en la variable b_error.
El valor de retorno guardado puede procesarse en el código subsiguiente.
{
BOOL b_error;
if(b_error)
{
// User defined code if
// function succeeds without error
...
}
else
{
// User defined code in case of error
...
}
...
}
Descripción
Efectúa un cambio de imagen para visualizar la imagen indicada.
Para conmutar entre la imagen raíz y la ventana permanente, y viceversa, utilice la función
de sistema "ActivarImagenConNúmero".
Parámetros
Nombre de imagen
Nombre de la imagen a la que se cambia.
Ejemplo
El siguiente código de programa activa la imagen "Screen_2" con la función ActivateScreen
al pulsar cualquier tecla.
Descripción
Efectúa un cambio de imagen en la ventana indicada para visualizar la imagen indicada.
Parámetros
Nombre de imagen
Nombre de la imagen que se muestra en la ventana de imagen.
Ventana de imagen
Nombre de la ventana de imagen en la que se muestra la nueva imagen.
Ejemplo
El siguiente código de programa activa la imagen "Screen_2" con la función
ActivateScreenInScreenWindow al pulsar cualquier tecla.
{
// User defined code
// i.e. when pressing a button
ActivateScreenInScreenWindow (GetParentScreen(screenName),
GetParentScreenWindow(screenName), "Screen_2");
...
}
Descripción
Abre la imagen inicial configurada.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL ActivateStartScreen();
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa activa la imagen inicial configurada con la función
ActivateStartScreen y guarda el valor de retorno en la variable b_error.
El valor de retorno guardado puede procesarse en el código subsiguiente.
{
BOOL b_error;
if(b_error)
{
// User defined code if
// function succeeds without error
...
}
else
{
// User defined code in case of error
...
}
...
}
Descripción
Abre la imagen que se ha guardado con la función de sistema StoreScreen.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL ActivateStoredScreen();
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa activa la imagen guardada con la función
ActivateStoredScreen y guarda el valor de retorno en la variable b_error.
El valor de retorno guardado puede procesarse en el código subsiguiente.
{
BOOL b_error;
if(b_error)
{
// User defined code if
// function succeeds without error
...
}
else
{
// User defined code in case of error
...
}
...
}
Consulte también
StoreScreen (Página 127)
Descripción
Resta el valor indicado del valor de la variable.
X=X-a
Nota
La función de sistema utiliza la misma variable como valor de entrada y como valor de salida.
Si utiliza esta función de sistema para convertir un valor, deberá utilizar una variable auxiliar.
A la variable auxiliar se le puede asignar un valor con la función de sistema "DefinirVariable".
Parámetros
Variable
Variable de la que se debe restar el valor indicado.
Valor
Valor que se va a restar.
Ejemplo
El siguiente código de programa reduce el valor de la variable varX la cantidad que indica la
variable value. El valor introducido se guarda en la variable old_value y se muestra junto con
el nuevo valor varX.
{
BYTE varX;
BYTE value;
//user input
...
BYTE old_value = varX;
//Decrease tag
DecreaseTag(varX, value);
Descripción
Proporciona un puntero hacia el nombre de la imagen.
Utilizable sólo en C-Scripting.
Sintaxis
char* GetLocalScreen(char* Screen name);
Parámetros
Screen name
Puntero hacia el nombre de la imagen.
Valor de retorno
Puntero hacia el nombre de la imagen.
Nota
El parámetro de llamada transferido "Screen name" debe tener la misma estructura que le da
el sistema gráfico para las rutas de imagen:
<nombre de imagen>.<nombre de ventana de imagen>:<nombre de imagen>.<nombre de
ventana de imagen>:<nombre de imagen>...
Principio
En una imagen "Imagen_A" hay una ventana de imagen "Ventana de imagen_B". En la
ventana de imagen se vuelve a activar una imagen y se representa como imagen reducida,
etc.
Ejemplo
El siguiente código de programa guarda el valor de retorno de la función GetLocalScreen en
la variable pszScrName. Si el valor de retorno es válido (diferente de CERO), se guardará con
un máximo de _MAX_PATH caracteres en la variable szScrName.
{
char* pszScrName = NULL;
char szScrName[_MAX_PATH+1];
Descripción
Devuelve el nombre de la variable que está enlazada con la propiedad de objeto indicada.
Utilizable sólo en C-Scripting.
Sintaxis
char* GetLinkedTag(char* Screen Name, char* Object, char* Name of Property);
Parámetros
Screen Name
Puntero hacia el nombre de la imagen.
Object
Puntero hacia el nombre del objeto.
Name of Property
Puntero hacia el nombre de la propiedad del objeto.
Valor de retorno
Puntero hacia el nombre de la variable que está enlazada con una propiedad de objeto
indicada.
Ejemplo
El siguiente código de programa lee una conexión de variable y llena la estructura transferida
linkinfo con la información de la conexión de variable.
{
LINKINFO linkinfo;
Descripción
Determina el idioma actual de runtime.
Utilizable sólo en C-Scripting.
Sintaxis
DWORD GetLanguageByLocaleID ();
Valor de retorno
Código de idioma.
Rigen las asignaciones siguientes (código de idioma hexadecimal):
Ejemplo
El siguiente código de programa lee el idioma de runtime actual y guarda el valor de retorno
en la variable rt_language.
El valor de retorno guardado puede procesarse en el código subsiguiente (aquí, impresión
con printf).
{
DWORD rt_language;
Descripción
Proporciona un puntero hacia el nombre de la imagen.
Utilizable sólo en C-Scripting.
Sintaxis
char* GetParentScreen(char* Screen name);
Parámetros
Screen name
Puntero hacia el nombre de la imagen.
Valor de retorno
Nombre de la imagen actual cuando se llama la función de sistema en una imagen.
Ruta del nombre de la imagen superior cuando se llama la función de sistema en una ventana
de imagen.
Nota
El parámetro de llamada transferido Screen name debe tener la misma estructura que le da
el sistema gráfico para las rutas de imagen:
<nombre de imagen>.<nombre de ventana de imagen>:<nombre de imagen>.<nombre de
ventana de imagen>:<nombre de imagen>...
Los caracteres ":" y "." se utilizan exclusivamente para la sintaxis. Por tanto, para los nombres
se deben utilizar exclusivamente los separadores "-" y "_".
Ejemplo
El siguiente código de programa guarda el valor de retorno de la función GetParentScreen en
la variable pszScrName. Si el valor de retorno es válido (diferente de CERO), se guardará con
un máximo de _MAX_PATH caracteres en la variable szScrName.
{
char* pszScrName = NULL;
char szScrName[_MAX_PATH+1];
Descripción
Proporciona un puntero hacia el nombre de la ventana de imagen.
Utilizable sólo en C-Scripting.
Sintaxis
char* GetParentScreenWindow(char* Screen name);
Parámetros
Screen name
Puntero hacia el nombre de la imagen.
Valor de retorno
Puntero hacia el nombre de la ventana de imagen cuando la función de sistema se llama en
una imagen que se muestra en una ventana de una imagen de nivel superior.
El parámetro de llamada invariable "Screen name" cuando se llama la función de sistema en
una imagen.
Nota
El parámetro de llamada transferido "Screen name" debe tener la misma estructura que le da
el sistema gráfico para las rutas de imagen:
<nombre de imagen>.<nombre de ventana de imagen>:<nombre de imagen>.<nombre de
ventana de imagen>:<nombre de imagen>...
Los caracteres ":" y "." se utilizan exclusivamente para la sintaxis. Por tanto, para los nombres
se deben utilizar exclusivamente los separadores "-" y "_".
Principio
En una imagen "Imagen_1" hay una ventana de imagen "Ventana de imagen_1". En la ventana
de imagen se vuelve a activar una imagen y se representa como imagen reducida, etc.
Ejemplo
El siguiente código de programa guarda el valor de retorno de la función
GetParentScreenWindow en la variable pszScrName. Si el valor de retorno es válido (diferente
de CERO), se guardará con un máximo de _MAX_PATH caracteres en la variable szScrName.
{
char* pszScrName = NULL;
char szScrName[_MAX_PATH+1];
Descripción
Devuelve el valor de una propiedad del tipo de datos "BOOL".
Utilizable sólo en C-Scripting.
Sintaxis
BOOL GetPropBOOL(LPCTSTR Screen name, LPCTSTR Object, LPCTSTR Name of the
property)
Parámetros
Screen name
Nombre de la imagen.
Object
Nombre del objeto. Si la llamada de la función hace referencia a una propiedad del objeto de
imagen, deberá activarse el parámetro Object = NULL.
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa lee si el objeto es visible o no. El valor se guarda en la variable
b_error.
{
BOOL b_error;
if(b_error)
{
// User defined code if the
// object is visible
...
}
else
{
// User defined code if the
// object is not visible
...
}
}
Descripción
Devuelve el valor de una propiedad del tipo de datos "Char".
Utilizable sólo en C-Scripting.
Sintaxis
Char* GetPropChar(LPCTSTR Screen name, LPCTSTR Object, LPCTSTR Name of the
property)
Parámetros
Screen name
Nombre de la imagen.
Object
Nombre del objeto. Si la llamada de la función hace referencia a una propiedad del objeto de
imagen, deberá activarse el parámetro Object = NULL.
Valor de retorno
Valor de la propiedad en el tipo de datos "Char".
Ejemplo
El siguiente código de programa lee el Tooltiptext del objeto con la función GetPropChar y lo
procesa del siguiente modo:
1. Guarda el valor de retorno en la variable pszProp
2. Comprobación de la validez del valor de retorno: Si el valor es válido (diferente de CERO),
sigue el paso 3.
3. Los primeros 13 caracteres de la secuencia de caracteres se guardan en la variable szProp.
{
char* pszProp = NULL;
char szProp[14];
if(pszProp != NULL)
{
//Copy the string and trim
strncpy(szProp,pszProp,13);
// print trimmed string
printf ("Short description of tooltip: %s\r\n", szProp);
}
...
}
Descripción
Devuelve el valor de una propiedad del tipo de datos "Double".
Utilizable sólo en C-Scripting.
Sintaxis
double GetPropDouble(LPCTSTR Screen name, LPCTSTR Object, LPCTSTR Name of the
property)
Parámetros
Screen name
Nombre de la imagen.
Object
Nombre del objeto. Si la llamada de la función hace referencia a una propiedad del objeto de
imagen, deberá activarse el parámetro Object = NULL.
Valor de retorno
Valor de la propiedad en el tipo de datos "Double".
Ejemplo
El siguiente código de programa lee la propiedad "BackColor" (color de fondo del objeto
"Button_1") con la función GetPropDouble y procesa el valor de retorno del siguiente modo:
1. Guarda el valor de retorno en la variable szprop
2. Comprobación de la validez del valor de retorno: Si el valor es válido (diferente de CERO),
sigue el paso 3.
3. Impresión del color de fondo
{
double szProp = NULL;
if(szProp != NULL)
{
// print output value
printf ("Background color: %s\r\n", szProp);}
}
...
}
Descripción
Devuelve el valor de una propiedad del tipo de datos "long".
Utilizable sólo en C-Scripting.
Sintaxis
long GetPropLong(LPCTSTR Screen name, LPCTSTR Object, LPCTSTR Name of the
property)
Parámetros
Screen name
Nombre de la imagen.
Object
Nombre del objeto. Si la llamada de la función hace referencia a una propiedad del objeto de
imagen, deberá activarse el parámetro Object = NULL.
Valor de retorno
Valor de la propiedad en el tipo de datos "long".
Ejemplo
El siguiente código de programa lee la propiedad "CaptionBackColor" (color de fondo del título)
del objeto "TemperatureField" con la función GetPropLong y procesa el valor del siguiente
modo:
1. Guarda el valor de retorno en la variable szProp
2. Comprobación de la validez del valor de retorno: Si el valor es válido (diferente de CERO),
sigue el paso 3.
3. Impresión
{
long szProp = NULL;
if(szProp != NULL)
{
// print caption
printf ("Caption of window: %d\r\n", szProp);
}
...
}
Descripción
Para poder acceder a variables del servidor correspondiente desde un cliente WinCC en un
sistema distribuido, los nombres de variables se complementan con el prefijo del servidor.
Nota
Esta función de sistema no se soporta actualmente.
Sólo se devuelve un puntero del tipo "char" en el prefijo del servidor, el prefijo Tag y el prefijo
Window.
La memoria no puede ser modificada (tampoco un strcat) ni liberada por el usuario.
Utilizable sólo en C-Scripting.
Sintaxis
void GetServerTagPrefix (char** ppszServerPrefix, char** ppszTagPrefix, char**
ppszWindowPrefix);
Valor de retorno
ppszServerPrefix
Puntero hacia un puntero que hace referencia al prefijo del servidor
ppszTagPrefix
Puntero hacia un puntero que hace referencia al prefijo Tag
ppszWindowPrefix
Puntero hacia un puntero que hace referencia al prefijo Window
Ejemplo
El siguiente código de programa lee el prefijo de servidor, el prefijo Tag y el prefijo Windows
y comprueba su validez. En caso de error se emite un texto y se abandona la función. Si no
hay error, se crea y se devuelve un nombre de variable. El procesamiento es como sigue:
1. Declaración de los punteros pszServerPrefix, pszTagPrefix y pszWindowPrefix para los
tres prefijos
2. Inicialización de las variables nServerPrefixLen, nTagPrefixLen y nTagLen
Se utilizan como caché para la longitud de string de los prefijos que deben leerse.
3. Inicialización de la variable myTagName
4. Leer prefijo de servidor, prefijo de variable y prefijo de Windows
5. Diferenciación de casos: Prefijo de servidor
– No se devuelve prefijo de servidor: se emite un texto y se abandona la función.
– Se devuelve prefijo de servidor: se determina su longitud y se guarda en la variable
nServerPrefixLen.
6. Si se ha devuelto un prefijo de variable, se determina su longitud y se guarda en la variable
nTagPrefixLen.
7. Determinar la longitud del nombre de la variable y guardar en la variable nTagLen.
8. Diferenciación de casos: Longitud permitida para el nombre de la variable
– Longitud permitida sobrepasada: se emite un texto y se abandona la función.
– Longitud permitida no sobrepasada: se compone el nombre de la variable que se
necesita para un entorno de cliente.
{
char* pszServerPrefix;
char* pszTagPrefix;
char* pszWindowPrefix;
int nServerPrefixLen = 0;
int nTagPrefixLen = 0;
int nTagLen = 0;
char myTagName[MAX_DM_VAR_NAME+1];
Descripción
La función GetTagXXX determina el valor de una variable del tipo de datos especificado.
Utilizable sólo en C-Scripting:
La siguiente tabla muestra las diferentes funciones GetTag para leer el valor de la variable:
Sintaxis
<Tipo><Nombre de función><(Parámetro)>;
Ejemplo: BYTE GetTagByte (Tag Tag_Name);
Parámetros
Tag_Name
Nombre de la variable
pValue
Puntero hacia un campo de bytes que contiene el valor de las variables de datos sin formato
size
Tamaño del campo de bytes en bytes
Valor de retorno
Valor de la variable en el tipo indicado.
La función de sistema "GetTagChar" devuelve un puntero hacia la cadena de caracteres que
contiene el valor de la variable.
La función de sistema "GetTagRaw" devuelve TRUE o FALSE:
TRUE: la función de sistema se ha ejecutado sin errores.
FALSE: ha ocurrido un error.
Ejemplo
El siguiente código de programa lee con la función GetTagByte el valor de las variables
gs_tag_byte y lo guarda en la variable bvalue.
{
BYTE bvalue;
// print value
printf ("Value of gs_tag_byte: %d\r\n", bvalue);
...
}
Función
Determina el valor de una variable del tipo de datos "Fecha/hora".
Sintaxis
SYSTEMTIME GetTagDateTime(Tag Tag_Name);
Parámetro
Tag_Name
Nombre de la variable
Valor de retorno
Valor de la variable en el tipo de datos "Fecha/hora".
Descripción
Se determinan los valores, estados y Quality Codes de varias variables y se guardan en el
formato indicado en las correspondientes direcciones. Los valores se leen explícitamente del
PLC.
Se transfieren dos matrices DWORD en cuyo miembro se encuentren los estados y los Quality
Codes de las variables individuales después de llamar la función de sistema. El tamaño de
las matrices debe ser lo suficientemente grande como para que haya suficiente espacio de
memoria para los estados y los Quality Codes.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL GetTagMultiStateQCWait (DWORD* pdwState, DWORD* pdwQualityCode, const
char* pFormat, ...);
Parámetros
pdwState
Campo en el que se guarda el estado de las variables individuales después de ejecutar la
función de sistema.
pdwQualityCode
Campo en el que se guarda el Quality Code de las variables individuales después de ejecutar
la función de sistema.
pFormat
Descripción de formato (tipo) para todas las variables solicitadas, posteriormente para cada
variable, nombre y dirección del valor.
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa lee con la función GetTagMultiStateQCWait el valor de las
variables "gs_tag_XXX" y guarda estos valores en las variables Ivalue1, Ivalue2 ... etc.
1. Definición de preprocesador para "DATA_SIZE" (aquí para 5 variables)
2. Crear los campos DWord
– dwState campo para el estado de la variable
– dwQc campo para Quality Codes
3. Definición de las variables para guardar en caché
4. Ejecución de la función GetTagMultiStateQCWait
En las direcciones de las variables se escribe el valor leído.
{
#define DATA_SIZE 5
DWORD dwState[DATA_SIZE];
DWORD dwQC[DATA_SIZE];
Descripción
Se determinan los valores y estados de varias variables y se guardan en el formato indicado
en las correspondientes direcciones. Los valores se leen explícitamente del PLC.
Debe transferirse a la función de sistema una matriz DWORD en cuyo miembro se encuentren
los estados de las variables individuales después de llamar la función de sistema. El tamaño
de la matriz debe ser lo suficientemente grande como para que haya suficiente espacio de
memoria para los estados.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL GetTagMultiStateWait(DWORD* pdwState, const char* pFormat);
Parámetros
pdwState
Campo en el que se guardan los estados de variables
pFormat
Descripción de formato (tipo) para todas las variables solicitadas, y para cada variable, nombre
y dirección del valor.
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa lee con la función GetTagMultiStateWait el valor de la variable
"gs_tag_XXX" y guarda estos valores en las variables Ivalue1, Ivalue2, etc.
1. Definición de preprocesador para "DATA_SIZE" (aquí para 5 variables)
2. Crear el campo DWord dwState para el estado de la variable
3. Definición de las variables para guardar en caché
4. Ejecución de la función GetTagMultiStateWait
En las direcciones de las variables se escribe el valor leído.
{
#define DATA_SIZE 5
DWORD dwState[DATA_SIZE];
Descripción
Se determinan los valores de varias variables y se guardan en las correspondientes
direcciones con el formato indicado. El valor se lee explícitamente del PLC. La memoria para
el valor de variable se crea por medio de la función de sistema con SysMalloc.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL GetTagMultiWait(const char* pFormat,...);
Parámetros
pFormat
Descripción de formato para todas las variables solicitadas y nombre y dirección del valor para
cada variable.
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa lee diversas variables de tipos distintos con la función
GetTagMultiWait.
1. Declaración de tres variables como memoria para tres tipos de variable distintos
2. Declaración de las variables booleanas ok para guardar en caché el valor de retorno (TRUE/
FALSE)
3. Lectura de las tres variables y almacenamiento de los valores en las direcciones
correspondientes.
El valor de retorno de la función se guarda en la variable ok.
4. Impresión de las tres variables con el tipo de variable antepuesto
DWORD dwVar1Value;
char* szVar2Value;
//memory for values allocated via SysMalloc
double dbVar3Value;
BOOL ok;
Descripción
La función GetTagStateXXX determina el valor de una variable del tipo de datos especificado.
Además se devuelve el estado de las variables.
Utilizable sólo en C-Scripting.
La tabla siguiente muestra las diferentes funciones GetTagStateXXX para leer el valor de la
variable:
Sintaxis
<Tipo><Nombre de la función><(Parámetro)>;
Ejemplo: BOOL GetTagBitState (Tag Tag_Name, PDWORD lp_dwstate);
Parámetros
Tag_Name
Nombre de la variable
lp_dwstate
Puntero hacia un DWORD en el que se guarda el estado de la variable después de ejecutar
la función de sistema.
pValue
Puntero hacia un campo de bytes que contiene el valor de las variables de datos sin formato
size
Tamaño del campo de bytes en bytes
Valor de retorno
Valor de la variable en el tipo indicado.
La función de sistema "GetTagCharState" devuelve un puntero hacia el valor de la variable
del tipo de datos "char".
La función de sistema "GetTagRawState" devuelve TRUE o FALSE:
TRUE: la función de sistema se ha ejecutado sin errores.
FALSE: ha ocurrido un error.
Ejemplo
El siguiente código de programa lee con la función GetTagBitState el valor de la variable
gs_tag_bit y lo guarda en la variable bValue.
El estado se guarda en la dirección de la variable dwState .
En función del valor de retorno en bValue (TRUE/FALSE) se ejecuta un código específico.
{
DWORD dwState;
BOOL bValue;
dwState = 0xFFFFFFFF;
Consulte también
Constantes (Página 202)
Descripción
La función GetTagStateQC determina el valor de una variable del tipo de datos especificado.
Se devuelve también el estado y el Quality Code de las variables.
Utilizable sólo en C-Scripting.
La tabla siguiente muestra las diferentes funciones GetTagStateQC para leer el valor de la
variable:
Sintaxis
<Tipo><Nombre de la función><(Parámetro)>;
Ejemplo: BOOL GetTagBitStateQC (Tag Tag_Name, PDWORD lp_dwstate, PDWORD
pdwQualityCode);
Parámetros
Tag_Name
Nombre de la variable
lp_dwstate
Puntero hacia un DWORD en el que se guarda el estado de la variable después de ejecutar
la función de sistema.
pdwQualityCode
Puntero hacia un DWORD en el que se guarda el Quality Code de la variable después de
ejecutar la función de sistema.
pValue
Puntero hacia un campo de bytes que contiene el valor de las variables de datos sin formato
size
Tamaño del campo de bytes en bytes
Valor de retorno
Valor de la variable en el tipo indicado.
La función de sistema "GetTagCharStateQC" devuelve un puntero hacia el valor de la variable
del tipo de datos "char".
La función de sistema "GetTagRawStateQC" devuelve TRUE o FALSE:
TRUE: la función de sistema se ha ejecutado sin errores.
FALSE: ha ocurrido un error.
Ejemplo
El siguiente código de programa lee con la función GetTagBitStateQC el valor de la variable
gs_tag_bit y lo guarda en la variable ok.
El estado y el Quality Code se guardan en las direcciones dwState y dwQC de la variable.
En función del valor de retorno en la variable ok. (TRUE/FALSE) se ejecuta un código
específico.
{
DWORD dwState;
DWORD dwQC;
BOOL ok;
dwState = 0xFFFFFFFF;
Descripción
La función GetTagStateQCWait determina el valor de una variable del tipo de datos
especificado. El valor se lee explícitamente del PLC. Se devuelve también el estado y el Quality
Code de las variables.
Utilizable sólo en C-Scripting.
La tabla siguiente muestra las diferentes funciones GetTagStateQCWait para leer el valor de
la variable:
Sintaxis
<Tipo><Nombre de función><(Parámetro)>;
Ejemplo: BOOL GetTagBitStateQC (Tag Tag_Name, PDWORD lp_dwstate, PDWORD
pdwQualityCode);
Parámetros
Tag_Name
Nombre de la variable
lp_dwstate
Puntero hacia un DWORD en el que se guarda el estado de la variable después de ejecutar
la función de sistema.
pdwQualityCode
Puntero hacia un DWORD en el que se guarda el Quality Code de la variable después de
ejecutar la función de sistema.
pValue
Puntero hacia un campo de bytes que contiene el valor de las variables de datos sin formato
size
Tamaño del campo de bytes en bytes
Valor de retorno
Valor de la variable en el tipo indicado.
La función de sistema "GetTagCharStateQCWait" devuelve un puntero hacia el valor de la
variable del tipo de datos "char".
La función de sistema "GetTagRawStateQCWait" devuelve TRUE o FALSE:
TRUE: la función de sistema se ha ejecutado sin errores.
FALSE: ha ocurrido un error.
Ejemplo
El siguiente código de programa lee con la función GetTagBitStateQCWait el valor de la
variable gs_tag_bit y lo guarda en la variable bValue.
El estado y el Quality Code se guardan en las direcciones de dwState y dwQC .
{
DWORD dwState;
DWORD dwQC;
BOOL bValue;
dwState = 0xFFFFFFFF;
Descripción
La función GetTagStateWait determina el valor de una variable del tipo de datos especificado.
El valor se lee explícitamente del PLC. Además se devuelve el estado de las variables.
Utilizable sólo en C-Scripting.
La tabla siguiente muestra las diferentes funciones GetTagStateWait para leer el valor de la
variable:
Sintaxis
<Tipo><Nombre de la función><(Parámetro)>
Ejemplo: BOOL GetTagBitStateWait (Tag Tag_Name, PDWORD lp_dwstate)
Parámetros
Tag_Name
Nombre de la variable
lp_dwstate
Puntero hacia un DWORD en el que se guarda el estado de la variable después de ejecutar
la función de sistema.
pValue
Puntero hacia un campo de bytes que contiene el valor de las variables de datos sin formato
size
Tamaño del campo de bytes en bytes
Valor de retorno
Valor de la variable en el tipo indicado.
La función de sistema "GetTagCharStateWait" devuelve un puntero hacia el valor de la
variable del tipo de datos "char".
La función de sistema "GetTagRawState" devuelve TRUE o FALSE.
TRUE: la función de sistema se ha ejecutado sin errores.
FALSE: ha ocurrido un error.
Ejemplo
El siguiente código de programa lee con la función GetTagBitStateWait el valor de la variable
gs_tag_bit y lo guarda en la variable bValue.
El estado se guarda en la dirección de la variable dwState .
En función del valor de retorno en bValue (TRUE/FALSE) se ejecuta un código específico.
{
DWORD dwState;
BOOL bValue;
dwState = 0xFFFFFFFF;
Descripción
Permite la transferencia de un valor en forma de Variant. Determina el puntero hacia la
estructura de resultados que contiene el valor.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL GetTagValue(LPDM_VARKEY lpdmVarKey, LPDM_VAR_UPDATE_STRUCT
lpdmresult, LPCMN_ERROR lpdmError);
Parámetros
lpdmVarKey
Puntero hacia una estructura del tipo de datos "DM_VARKEY"
lpdmresult
Puntero hacia el valor del tipo de datos "DM_VAR_UPDATE_STRUCT"
lpdmError
Puntero hacia la estructura que contiene la descripción del error
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa determina el valor de varKey con la función GetTagValue.
En función del valor de retorno en keyFound (TRUE/FALSE) se ejecuta un código específico.
{
DM_VARKEY varKey;
DM_VAR_UPDATE_STRUCT result;
CMN_ERROR error:
BOOL keyFound;
if (keyFound)
{
// print tag value
printf ("Value of varKey: %d\r\n", &varKey);
...
}
else
{
// failed
printf ( "Error - function failed." );
...
}
}
Descripción
Permite la transferencia de un valor en forma de Variant. Determina el puntero hacia la
estructura de resultados que contiene el valor. Se devuelve también el estado y el Quality
Code de las variables.
La función de sistema sólo puede utilizarse en C-Scripting.
Sintaxis
BOOL GetTagValueStateQC (LPDM_VARKEY lpdmVarKey,
LPDM_VAR_UPDATE_STRUCTEX lpdmresult, LPCMN_ERROR lpdmError);
Parámetros
lpdmVarKey
Puntero hacia una estructura del tipo de datos "DM_VARKEY"
lpdmresult
Puntero hacia el valor del tipo de datos "DM_VAR_UPDATE_STRUCTEX"
lpdmError
Puntero hacia la estructura que contiene la descripción del error
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa determina el valor de varKey con la función
GetTagValueStateQC.
El estado y el Quality Code se guardan en las direcciones de dwState y dwQC .
{
DM_VARKEY varKey;
DM_VAR_UPDATE_STRUCTEX result;
CMN_ERROR error:
// zu klären (DM_VAR_UPDATE_STRUCTEX enthält bereits QualityCode)
DWORD dwState;
DWORD dwQC;
BOOL keyFound;
if (keyFound)
{
// User defined code if the
// value of the tag is true
...
}
else
{
// User defined code if the
// value of the tag is false
...
}
}
Descripción
Permite la transferencia de un valor en forma de Variant. Determina el puntero hacia la
estructura de resultados que contiene el valor. El valor se lee explícitamente del PLC. Se
devuelve también el estado y el Quality Code de las variables.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL GetTagValueStateQCWait (LPDM_VARKEY lpdmVarKey,
LPDM_VAR_UPDATE_STRUCTEX lpdmresult, LPCMN_ERROR lpdmError);
Parámetros
lpdmVarKey
Puntero hacia una estructura del tipo de datos "DM_VARKEY"
lpdmresult
Puntero hacia el valor del tipo de datos "DM_VAR_UPDATE_STRUCTEX"
lpdmError
Puntero hacia la estructura que contiene la descripción del error.
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa lee con la función GetTagValueStateQCWait
El estado y el Quality Code se guardan en las direcciones de dwState y dwQC .
{
DM_VARKEY varKey;
DM_VAR_UPDATE_STRUCTEX result;
CMN_ERROR error:
// zu klären (DM_VAR_UPDATE_STRUCTEX enthält bereits QualityCode)
DWORD dwState;
DWORD dwQC;
BOOL keyFound;
if (keyFound)
{
// User defined code if the
// value of the tag is true
...
}
else
{
// User defined code if the
// value of the tag is false
...
}
}
Descripción
Permite la transferencia de un valor en forma de Variant. Determina el puntero hacia la
estructura de resultados que contiene el valor. El valor se lee directamente del PLC.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL GetTagValueWait(LPDM_VARKEY lpdmVarKey, LPDM_VAR_UPDATE_STRUCT
lpdmresult, LPCMN_ERROR lpdmError);
Parámetros
lpdmVarKey
Puntero hacia una estructura del tipo de datos "DM_VARKEY"
lpdmresult
Puntero hacia el valor del tipo de datos "DM_VAR_UPDATE_STRUCT"
lpdmError
Puntero hacia la estructura que contiene la descripción del error
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa determina el valor de varKey con la función GetTagValueWait.
{
DM_VARKEY varKey;
DM_VAR_UPDATE_STRUCT result;
CMN_ERROR error:
BOOL keyFound;
if (keyFound)
{
// succeeded, key found
// print tag value
printf ("Value of varKey: %d\r\n", &varKey);
...
}
else
{
// failed
printf ( "Error - function failed." );
}
...
}
Descripción
La función GetTagWaitXXX determina el valor de una variable del tipo de datos especificado.
El valor se lee explícitamente del PLC.
Utilizable sólo en C-Scripting.
La siguiente tabla muestra las diferentes funciones GetTagWait para leer el valor de la variable:
Sintaxis
<Tipo><Nombre de función><(Parámetro)>;
Ejemplo: BYTE GetTagByteWait (Tag Tag_Name);
Parámetros
Tag_Name
Nombre de la variable
pValue
Puntero hacia un campo de bytes que contiene el valor de las variables de datos sin formato
Valor de retorno
Valor de la variable en el tipo indicado.
La función de sistema "GetTagCharWait" devuelve un puntero hacia la cadena de caracteres
que contiene el valor de la variable.
La función de sistema "GetTagRawWait" devuelve TRUE o FALSE:
TRUE: la función de sistema se ha ejecutado sin errores.
FALSE: ha ocurrido un error.
Ejemplo
El siguiente código de programa lee con la función GetTagByteWait el valor de la variable
gs_tag_byte y lo guarda en la variable bvalue.
{
BYTE bvalue;
// print value
printf ("Value of gs_tag_byte: %d\r\n", bvalue);
...
}
Descripción
Suma el valor indicado al valor de la variable.
X=X+a
Nota
La función de sistema utiliza la misma variable como valor de entrada y como valor de salida.
Si utiliza esta función de sistema para convertir un valor, deberá utilizar una variable auxiliar.
A la variable auxiliar se le puede asignar un valor con la función de sistema "DefinirVariable".
Parámetros
Variable
Variable a la que se debe agregar el valor indicado.
Valor
Valor que se suma.
Ejemplo
El siguiente código de programa aumenta el valor de la variable varX la cantidad que indica
la variable value. El valor introducido se guarda en la variable old_value y se muestra junto
con el nuevo valor varX.
{
BYTE varX;
BYTE value;
//user input
...
BYTE old_value = varX;
//Increase tag
IncreaseTag(varX, value);
Descripción
Determina todos los idiomas configurados en la librería de textos para el tiempo de ejecución.
Con Pointer to a counter se indica dónde debe guardarse el número de códigos de idioma
determinados.
La función de sistema sólo puede utilizarse en C-Scripting.
Sintaxis
DWORD* InquireLanguage (DWORD* Pointer to a counter);
Parámetros
Pointer to a counter
Puntero hacia el número de códigos de idioma determinados.
Valor de retorno
Puntero hacia un campo que contiene los códigos de idioma determinados.
Rigen las asignaciones siguientes (código de idioma hexadecimal):
Ejemplo
El siguiente código de programa determina con la función InquireLanguage los idiomas
configurados en el tiempo de ejecución y los procesa del siguiente modo:
1. Almacenamiento del código de idioma determinado en la variable language
2. Almacenamiento del número de idiomas en la variable count
3. Impresión formateada del número de idiomas y sus códigos
{
DWORD count;
DWORD* language;
int i;
Descripción
Asigna a la variable X un valor que se calcula a partir del valor de la variable Y indicada
mediante la función lineal X = (Y - b) / a.
Las variables X e Y no pueden ser idénticas. Esta función de sistema es la función inversa de
"EscalaLineal".
Nota
Las variables X e Y no pueden ser idénticas. Si desea convertir una variable en Sí misma,
debe utilizar una variable auxiliar
Con la función de sistema "DefinirVariable" se puede asignar a la variable auxiliar el valor de
la variable que se va convertir.
Parámetros
X
Variable a la que se asigna el valor calculado en la ecuación lineal.
Y
Variable cuyo valor se utiliza para el cálculo.
b
Valor que se va a restar.
a
Valor por el que se divide.
Ejemplo
El siguiente código de programa asigna un valor a la variable varX con la función
InverseLinearScaling.
{
BYTE varX;
BYTE Yvalue = 10;
BYTE bvalue = 3;
BYTE avalue = 4;
Descripción
Invierte el valor de la variable indicada del tipo "Bool".
● Si la variable tiene el valor 1 (TRUE), se ajusta a 0 (FALSE).
● Si la variable tiene el valor 0 (FALSE), se ajusta a 1 (TRUE).
Parámetros
Variable
Variable cuyo bit se debe ajustar.
Ejemplo
El siguiente código de programa invierte el valor de la variable booleana b_value y muestra
el resultado junto con el valor original b_saved.
{
BOOL b_value = 0;
BOOL b_saved = b_value;
//Invert variable
invertBit(b_value);
Descripción
Invierte un bit en la variable indicada:
● Si el bit de la variable tiene el valor 1 (TRUE), se ajusta a 0 (FALSE).
● Si el bit de la variable tiene el valor 0 (FALSE), se ajusta a 1 (TRUE).
Tras modificar el bit indicado, la función de sistema vuelve a transferir toda la variable al
controlador. No se comprueba si entretanto se han modificado otros bits en la variable. El
operador y el controlador sólo podrán acceder a la variable indicada en modo de lectura hasta
que la variable vuelva a transferirse al controlador.
Nota
No utilice esta función de sistema si el controlador admite variables BOOL. En su lugar utilice
la función de sistema "InvertirBit".
Parámetros
Tag
Variable en la que se debe ajustar el bit indicado.
Bit
Número del bit a ajustar.
Si utiliza esta función de sistema en un script de usuario, los bits de una variable se cuentan
de derecha a izquierda. El contaje comienza a partir de "0".
Ejemplo
El siguiente código de programa invierte un bit en la posición indicada bitposition de la variable
bvalue y muestra el resultado junto con el valor original bsaved.
{
BYTE bvalue;
BYTE bsaved = bvalue;
BYTE bitposition = 2;
Descripción
Comprueba si un operador posee la autorización indicada.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL IsUserAuthorized (DWORD AuthorizationNumber);
Parámetros
AuthorizationNumber
La autorización (numérica) que debe comprobarse.
Valor de retorno
TRUE
El operador posee la autorización indicada.
FALSE
El operador no posee la autorización indicada.
Ejemplo
El siguiente código de programa comprueba la autorización del usuario con la función
IsUserAuthorized y escribe el valor en la variable booleana ok.
{
BOOL ok;
DWORD authnumber;
//error handling
if(ok)
{
// user authorized
printf ( "User is authorized." );
}
else
{
// user not authorized
printf ( "Authorization failed." );
}
...
}
Descripción
Asigna a la variable Y un valor que se calcula a partir del valor de las variables X indicadas
mediante la función lineal Y = (a * X) + b.
Nota
Las variables X e Y no pueden ser idénticas. Si desea convertir una variable en Sí misma,
debe utilizar una variable auxiliar
Con la función de sistema "DefinirVariable" se puede asignar a la variable auxiliar el valor de
la variable que se va convertir.
Parámetros
Y
Variable a la que se asigna el valor calculado en la ecuación lineal.
a
Valor con el que se multiplica.
X
Variable cuyo valor se utiliza para el cálculo.
b
Valor que se suma.
Ejemplo
El siguiente código de programa asigna con la función LinearScaling un valor a la variable
Yvar.
{
BYTE Yvar;
BYTE Xvalue = 10;
BYTE bvalue = 3;
BYTE avalue = 4;
// linear scaling
LinearScaling ( Yvar, avalue, Xvalue, bvalue);
Descripción
Según el valor del parámetro Name of method se inicia un trabajo de impresión o bien la vista
preliminar de un trabajo de impresión.
Utilizable sólo en C-Scripting.
Sintaxis
void ReportJob(LPCSTR Print job name, LPCSTR Name of method)
Parámetros
Name of method
Determina si se inicia el trabajo de impresión o la vista preliminar de un trabajo de impresión:
● PRINTJOB: se inicia el trabajo de impresión.
● PREVIEW: se inicia la vista preliminar del trabajo de impresión
Ejemplo
El siguiente código de programa ejecuta una vista preliminar o una impresión por cada
contenido de la variable printmethod.
{
char* pszPrintjobName;
char* printmethod;
//error handling
if(printmethod=="PRINTJOB")
{
// message for printing completed
printf("printing done");
...
}
else
{
// User defined code if the
// job is a preview or failed
...
}
}
Descripción
Pone a 0 (FALSE) el valor de una variable del tipo "Bool".
Parámetros
Variable
Variable del tipo BOOL que se ajusta a "0" (FALSE).
Ejemplo
El siguiente código de programa pone a 0 el valor de la variable booleana b_value con la
función ResetBit y muestra el resultado junto con el valor original b_saved.
{
BOOL b_value = 1;
BOOL b_saved = b_value;
//Reset bit
ResetBit (b_value);
Descripción
Pone un bit a 0 (FALSE) en las variables indicadas.
Tras modificar el bit indicado, la función de sistema vuelve a transferir toda la variable al
controlador. No se comprueba si entretanto se han modificado otros bits en la variable. El
operador y el controlador sólo podrán acceder a la variable indicada en modo de lectura hasta
que la variable vuelva a transferirse al controlador.
Nota
No utilice esta función de sistema si el controlador admite variables BOOL. En su lugar utilice
la función de sistema "DesactivarBit".
Utilizable, siempre que el dispositivo configurado soporte funciones definidas por el usuario.
Encontrará más información al respecto en "Dependencia del dispositivo".
Parámetros
Variable
Variable en la que un bit se ajusta a "0" (FALSE).
Bit
Número del bit que se ajusta a "0" (FALSE).
Si utiliza esta función de sistema en un script de usuario, los bits de la variable indicada se
contarán de derecha a izquierda, independientemente del controlador utilizado. El contaje
comienza a partir de "0".
Ejemplo
El siguiente código de programa pone a 0 un bit en la posición indicada bitposition de la
variable bvalue y muestra el resultado junto con el valor original bsaved.
{
BYTE bvalue;
BYTE bsaved = bvalue;
BYTE bitposition = 2;
Descripción
Ajusta a "1" (TRUE) el valor de una variable del tipo "Bool".
Utilizable, siempre que el dispositivo configurado soporte funciones definidas por el usuario.
Encontrará más información al respecto en "Dependencia del dispositivo".
Parámetros
Variable
Variable del tipo BOOL que se ajusta a "1" (TRUE).
Ejemplo
El siguiente código de programa pone a 1 el valor de la variable booleana b_value con la
función SetBit y muestra el resultado junto con el valor original b_saved.
{
BOOL b_value = 0;
BOOL b_saved = b_value;
//Set bit
SetBit (b_value);
Descripción
Ajusta un bit a "1" (TRUE) en la variable indicada.
Tras modificar el bit indicado, la función de sistema vuelve a transferir toda la variable al
controlador. No se comprueba si entretanto se han modificado otros bits en la variable. El
operador y el controlador sólo podrán acceder a la variable indicada en modo de lectura hasta
que la variable vuelva a transferirse al controlador.
Nota
No utilice esta función de sistema si el controlador admite variables BOOL. En su lugar utilice
la función de sistema "ActivarBit".
Parámetros
Variable
Variable en la que un bit se ajusta a "1" (TRUE).
Bit
Número del bit que se ajusta a "1" (TRUE).
Si utiliza esta función de sistema en un script de usuario, los bits de la variable indicada se
contarán de derecha a izquierda, independientemente del controlador utilizado. El contaje
comienza a partir de "0".
Nota
Para garantizar una funcionalidad fiable es imprescindible una actualización garantizada de
las variables utilizadas con los valores de proceso actuales. Por tanto, configure la variable
en un campo E/S, o bien asocie la función de sistema a un objeto de imagen (p. ej. un botón).
Si asocia la función de sistema a un evento breve (p. ej. aparición de un mensaje), los valores
de proceso actuales sólo se alcanzarán si la variable puede leerse de forma permanente.
Ejemplo
El siguiente código de programa pone a 1 un bit en la posición indicada bitposition de la
variable bvalue y muestra el resultado junto con el valor original bsaved.
{
BYTE bvalue;
BYTE bsaved = bvalue;
BYTE bitposition = 2;
Descripción
Modifica la configuración de idioma en runtime.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL SetLanguageByLocaleID (DWORD dwLocaleID);
Parámetros
dwLocaleID
Código del idioma que debe ajustarse.
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa ajusta el idioma de runtime actual a alemán con la función
SetLanguage y guarda el valor de retorno en la variable ok.
{
BOOL ok;
DWORD old_language;
DWORD new_language;
//error handling
if(ok)
{
// succeeded
printf ( "RT language is now German." );
}
else
{
// failed
printf ( "RT language was not updated." );
}
//print language code
printf ("Former language code: %d\r\n", old_language);
printf ("Current language code: %d\r\n", new_language);
}
Consulte también
GetLanguageByLocaleID (Página 34)
Descripción
Establece una propiedad de objeto con el tipo de datos "BOOL".
Utilizable sólo en C-Scripting.
Sintaxis
BOOL SetPropBOOL(LPCTSTR Screen name, LPCTSTR Object, LPCTSTR Name of the
property, BOOL Value)
Parámetros
Screen name
Nombre de la imagen.
Object
Nombre del objeto. Si la llamada de la función hace referencia a una propiedad del objeto de
imagen, deberá activarse el parámetro Object = NULL.
Value
Valor que se asigna a la propiedad de objeto del tipo de datos "BOOL".
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa ajusta la propiedad del objeto gs_graph_iofield a "Visible"
con la función SetPropBool. El valor de retorno se guarda en la variable ok.
{
BOOL ok;
//error handling
if(ok)
{
// succeeded
printf ( "IO field is visible." );
}
else
{
// failed
printf ( "Error - visibility not set" );
}
...
}
Descripción
Establece una propiedad de objeto con el tipo de datos "char".
Utilizable solo en C-Scripting.
Sintaxis
BOOL SetPropChar(LPCTSTR Screen name, LPCTSTR Object, LPCTSTR Name of the
property, char* Value)
Parámetros
Screen name
Nombre de la imagen.
Object
Nombre del objeto. Si la llamada de la función hace referencia a una propiedad del objeto de
imagen, deberá activarse el parámetro Object = NULL.
Value
Valor que se asigna a la propiedad de objeto del tipo de datos "char".
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa ajusta la propiedad Tooltiptext del objeto gs_graph_iofield al
valor "Tooltiptext 1" con la función SetPropChar. El valor de retorno se guarda en la variable
ok.
{
BOOL ok;
//error handling
if(ok)
{
// succeeded
printf ( "Property of Tooltiptext is now Tooltiptext 1." );
}
else
{
// failed
printf ( "Error - property not set" );
}
...
}
Descripción
Establece una propiedad de objeto con el tipo de datos "Double".
Utilizable sólo en C-Scripting.
Sintaxis
BOOL SetPropDouble(LPCTSTR Screen name, LPCTSTR Object, LPCTSTR Name of the
property, double Value)
Parámetros
Screen name
Nombre de la imagen.
Object
Nombre del objeto. Si la llamada de la función hace referencia a una propiedad del objeto de
imagen, deberá activarse el parámetro Object = NULL.
Value
Valor que se asigna a la propiedad de objeto del tipo de datos "double".
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa accede a una propiedad del objeto en la imagen screenName.
En este ejemplo, la función SetPropDouble ajusta la propiedad (Radio) del círculo "Circle_1"
al valor 10. El valor de retorno se guarda en la variable ok.
{
BOOL ok;
//error handling
if(ok)
{
// succeeded
printf ( "Radius was set." );
}
else
{
// failed
printf ( "Error - radius not set" );
}
...
}
Descripción
Establece una propiedad de objeto con el tipo de datos "long".
Utilizable sólo en C-Scripting.
Sintaxis
BOOL SetPropLong(LPCTSTR Screen name, LPCTSTR Object, LPCTSTR Name of the
property, long Value)
Parámetros
Screen name
Nombre de la imagen.
Object
Nombre del objeto. Si la llamada de la función hace referencia a una propiedad del objeto de
imagen, deberá activarse el parámetro Object = NULL.
Value
Valor que se asigna a la propiedad de objeto del tipo de datos "long".
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa modifica el color de primer plano de un objeto con la función
SetPropLong: en la imagen "Screen_1" se ajusta la propiedad "ForeColor" del objeto incluido
"Button1" al valor 65333 (rojo). El valor de retorno se guarda en la variable ok.
{
BOOL ok;
//error handling
if(ok)
{
// succeeded
printf ( "Color was set." );
}
else
{
// failed
printf ( "Error - color not set" );
}
...
}
Descripción
Define el valor de una propiedad de objeto como cadena de caracteres.
Parámetros
Nombre de imagen
Nombre de la imagen en la que está contenido el objeto.
Objeto
Nombre del objeto cuya propiedad se modifica.
Nombre de la propiedad
Nombre de la propiedad que se modifica.
Valor
Valor que se asigna a la propiedad.
Ejemplo
El siguiente código de programa modifica la propiedad de un objeto con la función
SetPropertyByConstant: en la imagen "Trends" se ajusta la propiedad "ToolbarButtonClick"
del objeto incluido "Control_1" al valor 26.
Como alternativa, puede utilizar en lugar del segundo parámetro (Objeto) la contraseña NULL
o bien un string de espacios en blanco.
Descripción
Define el valor de una propiedad de objeto por medio de otra propiedad de objeto.
Parámetros
Nombre de imagen
Nombre de la imagen en la que está contenido el objeto.
Objeto
Nombre del objeto cuya propiedad se transfiere al objeto de destino.
Nombre de la propiedad
Nombre de la propiedad al que se transfiere el objeto de destino.
Objeto de destino
Nombre del objeto de destino al que se transfiere la propiedad.
Ejemplo
El siguiente código de programa transfiere con la función SetPropertyByProperty la propiedad
"ToolbarButtonClick" del objeto "Control_1" en la imagen de salida "Trend_1" a la propiedad
correspondiente de la imagen de destino"Trend_2".
Descripción
Define el valor de una propiedad de objeto por medio de un valor de variable.
Parámetros
Nombre de imagen
Nombre de la imagen en la que está contenido el objeto.
Objeto
Nombre del objeto cuya propiedad se activa por medio del valor de variable.
Nombre de la propiedad
Nombre de la propiedad que se activa por medio del valor de variable.
Nombre de variable
Nombre de la variable que contiene el valor de la propiedad.
Ejemplo
El siguiente código de programa modifica la propiedad de un objeto con la función
SetPropertyByTag: Al hacer clic sobre el objeto se transfieren el nombre del objeto y la imagen
en la que se encuentra el objeto. El título CaptionText de la ventana de imagen contiene el
valor de la variable HMI_value_1.
Ejemplo
El siguiente código de programa modifica la propiedad de un objeto con la función
SetPropertyByTag: en la imagen "Trends" se ajusta la propiedad "ToolbarButtonClick" del
objeto incluido "Control_1" al valor 26.
Descripción
Define el valor de una propiedad de objeto por medio de una variable. La variable contiene el
nombre de variable que determina la propiedad del objeto.
Parámetros
Nombre de imagen
Nombre de la imagen en la que está contenido el objeto.
Objeto
Nombre del objeto cuya propiedad se activa por medio del valor de variable.
Nombre de la propiedad
Nombre de la propiedad que se activa por medio del valor de variable.
Nombre de variable
Nombre de la variable que, a su vez, contiene el nombre de la variable que determina la
propiedad del objeto.
Ejemplo
El siguiente código de programa modifica la propiedad de un objeto con la función
SetPropertyByTagIndirect: .
Descripción
La función SetTagXXX establece el valor de una variable del tipo de datos especificado.
Utilizable sólo en C-Scripting.
La tabla siguiente muestra las diferentes funciones SetTag para activar el valor de la
variable:
Sintaxis
BOOL<Nombre de la función><(Parámetro)>;
Ejemplo: BOOL SetTagBit (Tag Tag_Name, short int value);
Parámetros
Tag_Name
Nombre de la variable
value
Valor de la variable en el tipo de datos indicado.
pValue
Puntero hacia un campo de bytes que contiene el valor de las variables de datos sin formato
size
Tamaño del campo de bytes en bytes
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
Sin embargo, no se comprueba si la variable ha podido escribirse también sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa ajusta con la función SetTagBit el valor de las variables
gs_tag_bit a TRUE y guarda el valor de retorno en la variable ok.
{
BOOL ok;
BOOL bvalue;
Función
Establece el valor de una variable del tipo de datos "Fecha/hora".
Sintaxis
BOOL SetTagDateTime(Tag Tag_Name, SYSTEMTIME value);
Parámetros
Tag_Name
Nombre de la variable
value
Valor de la variable en el tipo de datos "Fecha/hora".
Valor de retorno
TRUE
La función en sí se ha ejecutado sin errores.
Sin embargo, no se comprueba si la variable ha podido escribirse también sin errores.
FALSE
Se ha producido un error.
Descripción
Establece los valores de varias variables. La función de sistema no finaliza hasta que el PLC
ha comunicado la aceptación del valor.
La función de sistema sólo puede utilizarse en C-Scripting.
Debe transferirse a la función de sistema una matriz DWORD en cuyo miembro se encuentren
los estados de las variables individuales después de llamar la función de sistema. El tamaño
de la matriz debe ser lo suficientemente grande como para que haya suficiente espacio de
memoria para estos estados.
Sintaxis
BOOL SetTagMultiStateWait(DWORD* pdwState, const char* pFormat,...);
Parámetros
pdwState
Campo en el que se guardan los estados de variables
pFormat
Descripción de formato para todas las variables solicitadas y nombre y valor para cada
variable.
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
Sin embargo, no se comprueba si la variable ha podido escribirse también sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa establece el valor de diversas variables con la función
SetTagMultiStateWait.
1. Creación de una matriz DWord con el tamaño necesario (número de variables)
2. Creación de las variables cuyos valores se transferirán a las variables de WinCC con la
función SetTagMultiStateWait
3. Descripción de las variables de WinCC con los valores de las variables que acaban de
declararse:
– gs_tag_bit con el valor de la variable "lValue1"
– gs_tag_SByte con el valor de la variable en la dirección "&lValue2"
– etc.
{
#define DATA_SIZE 5
DWORD dwData[DATA_SIZE];
Descripción
Los valores de varias variables se establecen en el formato indicado. La función de sistema
no finaliza hasta que el PLC ha comunicado la aceptación del valor.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL SetTagMultiWait(const char* pFormat,...);
Parámetros
pFormat
Descripción de formato para todas las variables solicitadas y nombre y valor para cada
variable.
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
Sin embargo, no se comprueba si la variable ha podido escribirse también sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa modifica el valor de diversas variables con la función
SetTagMultiWait. El valor de retorno se guarda en la variable ok.
{
BOOL ok;
//memory for values allocated via SysMalloc
DWORD dwVar1Value;
char* szVar2Value;
double dbVar3Value;
//settings
ok=SetTagMultiWait("%d%s%f", "Ernie_word", 16,
"Ernie_char", "Hallo Welt",
"Ernie_double", 55.4711);
//error handling
if(ok)
{
// succeeded
printf ( "Function has run through.\r\n" );
Ejemplo
El siguiente código de programa lee diversas variables de tipos distintos con la función
GetTagMultiWait.
1. Declaración de tres variables como memoria para tres tipos de variable distintos
2. Declaración de las variables booleanas ok para guardar en caché el valor de retorno (TRUE/
FALSE)
3. Lectura de las tres variables y almacenamiento de los valores en las direcciones
correspondientes.
El valor de retorno de la función se guarda en la variable ok.
4. Impresión de las tres variables con el tipo de variable antepuesto
DWORD dwVar1Value;
char* szVar2Value;
//Speicher für den Variablenwert wird
//durch die Funktion mit SysMalloc angelegt
double dbVar3Value;
BOOL ok;
Descripción
Establece el valor de una variable del tipo de datos indicado. Además se devuelve el estado
de las variables.
Utilizable sólo en C-Scripting.
La siguiente tabla muestra las diferentes funciones SetTagStateXXX para establecer el valor
de la variable:
Sintaxis
BOOL <Nombre de la función><(Parámetro)>;
Ejemplo: BOOL SetTagBitState (Tag Tag_Name, short int value, PDWORD lp_dwstate);
Parámetros
Tag_Name
Nombre de la variable
value
Valor de la variable en el tipo de datos indicado.
lp_dwstate
Puntero hacia un DWORD en el que se guarda el estado de la variable después de ejecutar
la función de sistema.
pFormat
Descripción de formato para todas las variables solicitadas y nombre y valor para cada
variable.
pValue
Puntero hacia un campo de bytes que contiene el valor de las variables de datos sin formato
size
Tamaño del campo de bytes en bytes
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa ajusta con la función SetTagBitState el valor de las variables
gs_tag_bit a TRUE y guarda el valor de retorno en la variable ok. "&dwstate" es la dirección
de la variable en la que se guarda el estado de la variable.
El valor de retorno guardado puede procesarse en el código subsiguiente.
{
DWORD dwstate;
BOOL ok;
//error handling
if(ok)
{
// succeeded
printf ( "Function has run through.\r\n" );
printf ("Status of gs_tag_bit: %d\r\n", dwstate);
}
else
{
// failed
printf ( "Error - function failed." );
}
...
}
Descripción
Establece el valor de una variable del tipo de datos indicado. La función de sistema no finaliza
hasta que el PLC ha comunicado la aceptación del valor. Además se devuelve el estado de
las variables.
Utilizable sólo en C-Scripting.
La siguiente tabla muestra las diferentes funciones SetTagStateWait para establecer el valor
de la variable:
Sintaxis
BOOL<Nombre de la función><(Parámetro)>;
Ejemplo: BOOL SetTagBitStateWait (Tag Tag_Name, short int value, PDWORD lp_dwstate);
Parámetros
Tag_Name
Nombre de la variable
value
Valor de la variable en el tipo de datos indicado.
lp_dwstate
Puntero hacia un DWORD en el que se guarda el estado de la variable después de ejecutar
la función de sistema.
pValue
Puntero hacia un campo de bytes que contiene el valor de las variables de datos sin formato
size
Tamaño del campo de bytes en bytes
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
Sin embargo, no se comprueba si la variable ha podido escribirse también sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa ajusta con la función SetTagBitStateWait el valor de las
variables gs_tag_bit a TRUE y guarda el valor de retorno en la variable ok. "&dwstate" es la
dirección de la variable en la que se guarda el estado de la variable.
{
DWORD dwstate;
BOOL ok;
//error handling
if(ok)
{
// succeeded
printf ( "Function has run through.\r\n" );
printf ("Status of gs_tag_bit: %d\r\n", dwstate);
}
else
{
// failed
printf ( "Error - function failed." );
}
...
}
Descripción
Permite la transferencia de un valor en forma de Variant y pone el puntero hacia el valor del
tipo de datos "Variant".
Utilizable sólo en C-Scripting.
Sintaxis
BOOL SetTagValue (LPDM_VARKEY lpdmVarKey, LPVARIANT lpdmValue, PDWORD
dwState, LPCMN_ERROR lpdmError);
Parámetros
lpdmVarKey
Puntero hacia una estructura del tipo de datos "DM_VARKEY"
lpdmValue
Puntero hacia el valor del tipo de datos "Variant". Encontrará la descripción del tipo de datos
VARIANT en la correspondiente documentación técnica.
lpdmError
Puntero hacia la estructura que contiene la descripción del error
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
Sin embargo, no se comprueba si la variable ha podido escribirse también sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa transfiere el valor de varKey con la función SetTagValue.
En función del valor de retorno en keyFound (TRUE/FALSE) se ejecuta un código específico.
{
// tags for setting the value
DM_VARKEY varKey;
LPVARIANT value;
LPCMN_ERROR error1:
BOOL keyFound;
if (keyFound)
{
// succeeded, get the new value
GetTagValue(&varKey, &result, &error);
// print tag value
printf ("Value of varKey: %d\r\n", &varKey);
...
}
else
{
// failed
printf ( "Error - function failed." );
...
}
}
Descripción
Permite la transferencia de un valor en forma de Variant y pone el puntero hacia el valor del
tipo de datos "Variant". La función de sistema no finaliza hasta que el PLC ha comunicado la
aceptación del valor.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL SetTagValueWait(LPDM_VARKEY lpdmVarKey, LPVARIANT lpdmValue, PDWORD
dwState, LPCMN_ERROR lpdmError);
Parámetros
lpdmVarKey
Puntero hacia una estructura del tipo de datos "DM_VARKEY"
lpdmValue
Puntero hacia el valor del tipo de datos "Variant". Encontrará la descripción del tipo de datos
VARIANT en la correspondiente documentación técnica.
dwState
Estado de la variable que se devuelve después de la ejecución de la función de sistema
lpdmError
Puntero hacia la estructura que contiene la descripción del error
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
No obstante, no se comprueba si también pudo escribirse la variable sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa transfiere el valor de varKey con la función SetTagValueWait.
{
// tags for setting the value
DM_VARKEY varKey;
LPVARIANT value;
LPCMN_ERROR error1:
BOOL keyFound;
if (keyFound)
{
// succeeded, get the new value
GetTagValueWait(&varKey, &result, &error);
// print tag value
printf ("Value of varKey: %d\r\n", &varKey);
...
}
else
{
// failed
printf ( "Error - function failed." );
...
}
}
Descripción
Establece el valor de una variable del tipo de datos indicado. La función de sistema no finaliza
hasta que el PLC ha comunicado la aceptación del valor.
Utilizable sólo en C-Scripting.
La siguiente tabla muestra las diferentes funciones SetTagWait para establecer el valor de la
variable:
Sintaxis
BOOL <Nombre de función><(Parámetro)>;
Ejemplo: BOOL SetTagBitWait (Tag Tag_Name, short int value);
Parámetros
Tag_Name
Nombre de la variable
value
Valor de la variable en el tipo de datos indicado.
pValue
Puntero hacia un campo de bytes que contiene el valor de las variables de datos sin formato
size
Tamaño del campo de bytes en bytes
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
Sin embargo, no se comprueba si la variable ha podido escribirse también sin errores.
FALSE
se ha producido un error.
Ejemplo
El siguiente código de programa ajusta con la función SetTagBitWait el valor de las variables
gs_tag_bit a TRUE y guarda el valor de retorno en la variable ok.
{
BOOL ok;
BOOL bvalue;
Descripción
Asigna un valor nuevo a la variable indicada.
Nota
Dependiendo del tipo de variable, con esta función de sistema puede asignar cadenas de
caracteres y números.
Parámetros
Variable
Variable a la que se debe asignar el valor indicado.
Valor
Valor que se asigna a la variable indicada.
Nota
La función de sistema "DefinirVariable" se ejecuta únicamente tras establecer una conexión.
Ejemplo
El siguiente código de programa ajusta con la función SetTag el valor de las variables
gs_tag_bit a TRUE y guarda el valor de retorno en la variable ok.
{
BOOL ok;
BOOL bvalue;
Descripción
Define un valor de variable por medio del valor de una propiedad de objeto. La modificación
se registra adicionalmente en el sistema de avisos.
Parámetros
Nombre de variable
Nombre de la variable cuyo valor se define por medio de la propiedad de objeto.
Nombre de imagen
Nombre de la imagen en la que está contenido el objeto.
Objeto
Nombre del objeto cuya propiedad proporciona el valor de variable.
Nombre de la propiedad
Nombre de la propiedad que proporciona el valor de variable.
Ejemplo
El siguiente código de programa devuelve el valor del texto seleccionado al hacer clic en un
cuadro combinado.
{
char* rt_value;
...
}
Descripción
Define el valor de variable por medio del valor de una variable indirecta. La modificación se
registra adicionalmente en el sistema de avisos.
Parámetros
Nombre de variable
Nombre de la variable cuyo valor se define por medio de una variable indirecta.
Nombre de variable
Nombre de la variable indirecta que proporciona el valor de variable.
Ejemplo
El siguiente código de programa devuelve el valor de la variable "@LocalMachineName" al
hacer clic en cualquier tecla.
{
char* rt_value;
...
}
Descripción
Define el nombre indirecto para una variable.
Parámetros
LpValue
Nombre de la variable en la que se escribe la variable.
Ejemplo
El siguiente código de programa transfiere el valor de la variable "value" a la variable "result"
al hacer clic en cualquier tecla.
{
BYTE result;
BYTE value;
Descripción
Define un nombre de variable por medio del valor de una propiedad de objeto. La modificación
se registra adicionalmente en el sistema de avisos.
Parámetros
Nombre de variable
Nombre de la variable cuyo nombre se define por medio de la propiedad de objeto.
Nombre de imagen
Nombre de la imagen en la que está contenido el objeto.
Objeto de imagen
Nombre del objeto cuya propiedad proporciona el nombre de variable.
Nombre de la propiedad
Nombre de la propiedad que proporciona el nombre de variable.
Ejemplo
El siguiente código de programa ajusta la variable "rt_value_property" al valor de la propiedad
"FlashingEnabled" al hacer clic en la tecla objectName.
{
Int rt_value_property;
SetTagIndirectByProperty ("rt_value_property", screenName, objectName, "FlashingEnabled",
hmiWithoutOperatorEvent);
...
}
Descripción
Define el valor de variable por medio del valor de una variable indirecta. La modificación se
registra adicionalmente en el sistema de avisos.
Parámetros
Nombre de variable
Nombre de la variable indirecta cuyo valor se define por medio de una variable indirecta.
nombre de variable
Nombre de la variable indirecta que proporciona el valor de variable.
Ejemplo
El siguiente código de programa ajusta la variable "rt_value" al valor de la variable "value" al
hacer clic en la tecla objectName.
{
Int rt_value;
Int value;
Descripción
Define el nombre indirecto para una variable. La modificación se registra adicionalmente en
el sistema de avisos.
Parámetros
LpValue
Nombre de la variable en la que se escribe la variable.
Descripción
Define el valor de una variable. La modificación se registra adicionalmente en el sistema de
avisos.
Parámetros
LpValue
El valor que se escribe la variable.
Ejemplo
El siguiente código de programa transfiere el valor de la variable "value" a la variable "result"
al hacer clic en cualquier tecla.
{
BYTE result;
BYTE value;
Descripción
Inicia el programa indicado con los parámetros especificados.
La función de sistema sólo puede utilizarse en C-Scripting.
Sintaxis
void StartProgram(Program_name,Program_parameter,Display_mode,
Wait_for_program_end);
Parámetros
Program_name
Ruta y nombre del programa que se debe iniciar.
Program_parameters
Parámetros que deben utilizarse al iniciar el programa. En la descripción del programa que
se va a iniciar encontrará información sobre los parámetros posibles.
Display_mode
Define en qué modo de visualización debe iniciarse el programa:
0 (hmiShowNormal) = visualización en ventana
1 (hmiShowMinimized) = visualización en ventana minimizada
2 (hmiShowMaximized) = visualización en ventana maximizada
3 (hmiShowMinimizedAndInaktive) = visualización en ventana inactiva minimizada
Wait_for_program_end
WinCC Runtime Professional no evalúa el parámetro.
Ejemplo
El siguiente código de programa inicia el programa calc.exe en la ventana minimizada.
{
BOOL Wait_for_program_end;
float number;
Descripción
Sale del software runtime y, con ello, del proyecto que se está ejecutando en el panel de
operador.
Parámetros
Modo
Determina si al finalizar el software runtime también se debe cerrar el sistema operativo.
0 (hmiStopRuntime) = Runtime: No cerrar el sistema operativo
1 (hmiStopRuntimeAndOperatingSystem) = Runtime y sistema operativo: Cerrar el sistema
operativo (no en Windows CE)
Ejemplo
El siguiente código de programa cierra Runtime y el sistema operativo.
Descripción
Guarda la imagen actual. Esta imagen puede abrirse con la función de sistema
ActivateStoredScreen.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL StoreScreen();
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
FALSE
Se ha producido un error.
Ejemplo
El siguiente código de programa escribe el valor de retorno de la función StoreScreen en la
variable screen_stored y abre la imagen guardada siempre que se haya guardado sin errores.
{
BOOL screen_stored;
screen_stored = StoreScreen();
//user defined code
...
//error handling
if(screen_stored)
{
// succeeded
ActivateStoredScreen();
printf ( "Stored screen is now activated.\r\n" );
}
else
{
// failed
printf ( "Error - no screen stored." );
}
...
}
Consulte también
ActivateStoredScreen (Página 28)
Descripción
La función de sistema TriggerOperatorEvent lanza un aviso de operador.
Sintaxis
int TriggerOperatorEvent( DWORD dwFlags, DWORD dwMsgNum, char* lpszObjectName,
DWORD dwMyTextID, double doValueOld, double doValueNew, char* pszComment );
Parámetros
dwFlags
dwMsgNum
Número del aviso de operador lanzado.
lpszObjectName
Puntero hacia el nombre de las variables con el valor antiguo y el valor nuevo.
dwMyTextID
ID del texto que debe utilizarse como comentario.
doValueOld
Valor antiguo.
doValueNew
Valor nuevo.
pszComment
Puntero hacia el texto que debe utilizarse como comentario.
Valor de retorno
TRUE
La función de sistema se ha ejecutado sin errores.
FALSE
se ha producido un error.
Descripción
Agregar una nueva receta. Equivale a la configuración de una nueva receta con el editor
"Recetas".
Utilizable sólo en C-Scripting.
Sintaxis
LONG uaAddArchive (
UAHCONFIG hConfig,
UACONFIGARCHIVE* pArchive )
Parámetros
UAHCONFIG hConfig
Handle de configuración para la receta. Este handle se crea con uaQueryConfiguration.
UACONFIGARCHIVE* pArchive
Puntero hacia el búfer para la memoria de la configuración de receta
Valor de retorno
Índice de la nueva receta. Un error corresponde a -1.
Consulte también
uaQueryConfiguration (Página 166)
Descripción
Agregar un nuevo campo de datos.
Utilizable sólo en C-Scripting.
Sintaxis
LONG uaAddField (
UAHCONFIG hConfig,
long lArchive,
UACONFIGFIELD* pField )
Parámetros
UAHCONFIG hConfig,
Handle de configuración de la receta. Este handle se crea con uaQueryConfiguration .
long lArchive,
Índice de ficheros (de 0 a (uaGetNumArchives()-1))
UACONFIGFIELD* pArchive
Puntero sobre el búfer de la configuración de campo
Valor de retorno
Índice del nuevo campo. Un valor de -1 indica un error.
Descripción
Se suprime la conexión con la receta actual.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaArchiveClose (
UAHARCHIVE hArchive )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
TRUE
Cierre correcto de la receta
FALSE
error
Descripción
Borra los datos de una receta, aunque la receta configurada se conserva.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaArchiveDelete (
UAHARCHIVE hArchive,
LPCSTR pszWhere )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
LPCSTR pszWhere
En este string está la expresión de selección SQL. Este determina los registros que hay que
borrar. La expresión es la misma que en la instrucción SQL "DELETE FROM <archive>
WHERE pszWhere".
¡Atención! Si este string está vacío, se borra toda la receta.
Valor de retorno
TRUE
borrado correcto de la receta
FALSE
Error
Descripción:
Exporta la receta actual a un fichero en formato CSV.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaArchiveExport (
UAHARCHIVE hArchive,
LPCSTR pszDestination,
LONG lType,
LONG lOptions )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con UaQueryArchive o UaQueryArchiveByName.
LPCSTR pszDestination
Nombre de archivo del fichero de destino
LONG lType
Formato de datos del fichero de destino. Los dos formatos disponibles son:
● UA_FILETYPE_DEFAULT = 0: Formato de archivo predeterminado = CSV
● UA_FILETYPE_CSV = 1: Formato de archivo CSV
LONG lOptions
Reservado para extensiones posteriores. Debe ser 0.
Valor de retorno
TRUE
exportación correcta de la receta
FALSE
Error
Descripción
Lee la cantidad de registros.
Utilizable sólo en C-Scripting.
Sintaxis
LONG uaArchiveGetCount(
UAHARCHIVE hArchive,
LONG * plCount )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName .
LONG plCount
Puntero sobre una variable, en el cual se debe depositar los registros.
Valor de retorno
Cantidad de registros.
0 = Fichero vacío o se ha producido un error. Es necesario realizar una consulta mediante
uaGetLastError() .
Descripción
Lee la longitud de un campo en el registro actual.
Utilizable sólo en C-Scripting.
Sintaxis
LONG uaArchiveGetFieldLength(
UAHARCHIVE hArchive,
LONG lField )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
LONG lField
El número de campo, siendo lField = 1 el que direcciona el primer campo.
Valor de retorno
Longitud del campo actual
Descripción
Lee el nombre de un campo en el registro actual.
Utilizable sólo en C-Scripting.
Sintaxis
VOID uaArchiveGetFieldName (
UAHARCHIVE hArchive,
LONG lField,
LPCSTR pszName,
LONG cMaxLen )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
LONG lField
El número de campo, siendo lField = 1 el que direcciona el primer campo.
LPCSTR pszName
Nombre de campo
LONG cMaxLen
Longitud máxima
Descripción
Lee la cantidad de los campos de datos configurados, donde los campos "ID", "Último usuario"
y "Último acceso" no se cuentan. En los accesos de Runtime se indican los índices de los
campos configurados con 1 a N. El campo ID tiene el índice 0. Los campos "Último usuario"
y "Último acceso" añaden al final de los campos configurados.
Utilizable sólo en C-Scripting.
Sintaxis
LONG uaArchiveGetFields (
UAHARCHIVE hArchive )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
Cantidad de campos configurados.
Descripción
Lee el tipo de un campo en el registro actual.
Utilizable sólo en C-Scripting.
Sintaxis
LONG uaArchiveGetFieldType (
UAHARCHIVE hArchive,
LONG lField )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
LONG lField
El número de campo, siendo lField = 1 el que direcciona el primer campo.
Valor de retorno
Tipo del campo actual
Las denominaciones simbólicas para los tipos de campo son:
UA_FIELDTYPE_INTEGER
UA_FIELDTYPE_DOUBLE
UA_FIELDTYPE_STRING
UA_FIELDTYPE_DATETIME
Descripción
Lee la fecha y la hora de un campo en el registro actual.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaArchiveGetFieldValueDate (
UAHARCHIVE hArchive,
LONG lField,
LPSYSTEMTIME pstDateTime )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName .
LONG lField
El número de campo, siendo lField = 1 el que direcciona el primer campo.
LPSYSTEMTIME pstDateTime
Puntero sobre la variable del tipo SYSTEMTIME
Valor de retorno
TRUE
Lectura correcta de fecha y hora
FALSE
Error
Descripción
Lee valor double de un campo en el registro actual.
La función de sistema sólo puede utilizarse en C-Scripting.
BOOL uaArchiveGetFieldValueDouble (
UAHARCHIVE hArchive,
LONG lField,
double* pdValue )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
LONG lField
El número de campo, siendo lField = 1 el que direcciona el primer campo.
double* pdValue
Puntero sobre la variable para el contenido de campo actual
Valor de retorno
TRUE
lectura correcta del valor del campo
FALSE
Error
Descripción
Lee valor Float de un campo en el registro actual.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaArchiveGetFieldValueFloat (
UAHARCHIVE hArchive,
LONG lField,
FLOAT* pfValue )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
LONG lField
El número de campo, siendo lField = 1 el que direcciona el primer campo.
FLOAT* pfValue
Puntero sobre la variable Float para el contenido de campo actual
Valor de retorno
TRUE
Lectura correcta del valor del campo
FALSE
Error
Descripción
Lee valor número entero Long de un campo en el registro actual.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaArchiveGetFieldValueLong (
UAHARCHIVE hArchive,
LONG lField,
LONG* pdValue )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
LONG lField
El número de campo, siendo lField = 1 el que direcciona el primer campo.
LONG* pdValue
Puntero sobre la variable Long para el contenido de campo actual
Valor de retorno
TRUE
Lectura correcta del valor del campo
FALSE
Error
Descripción
Lee string de un campo en el registro actual.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaArchiveGetFieldValueString (
UAHARCHIVE hArchive,
LONG lField,
LPSTR pszString,
LONG cMaxLen )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
LONG lField
El número de campo, siendo lField = 1 el que direcciona el primer campo.
LPCSTR pszString
Valor de campo como String
LONG cMaxLen
Longitud máxima del string
Valor de retorno
TRUE
Lectura correcta del valor del campo
FALSE
Error
Descripción
Lee el filtro del registro actual de datos. En el anexo, capítulo "Instrucciones de SQL"
encontrará más información.
Utilizable sólo en C-Scripting.
Sintaxis
VOID uaArchiveGetFilter (
UAHARCHIVE hArchive,
LPSTR pszFilter,
LONG cMaxLen )
La función de sistema sólo puede utilizarse en C-Scripting.
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
LPSTR pszFilter
Filtro leído
LONG cMaxLen
Longitud máxima
Descripción
uaArchiveGetID lee la identificación (ID) de la receta.
La ID de la receta sirve para fines internos y puede ser distinta al número indicado en la receta.
Utilizable sólo en C-Scripting.
Sintaxis
LONG uaArchiveGetID (
UAHARCHIVE hArchive )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
ID de la receta.
Descripción
Lee el nombre de la receta.
Utilizable sólo en C-Scripting.
Syntax
VOID uaArchiveGetName (
UAHARCHIVE hArchive,
LPSTR pszName,
LONG cMaxLen )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
LPSTR pszName
Puntero hacia el búfer para el nombre de la receta
LONG cMaxLen
Longitud máxima
Ejemplo
char Relleno[40];
uaArchiveGetName( hArchive, relleno, 39 );
Descripción
uaArchiveGetSort lee la clasificación de la receta.
Utilizable sólo en C-Scripting.
Sintaxis
VOID uaArchiveGetSort (
UAHARCHIVE hArchive,
LPSTR pszSort,
LONG cMaxLen )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
LPCSTR pszSort
Clasificación
LONG cMaxLen
Longitud máxima
Descripción
uaArchivImport importa una receta con formato de datos CSV. La estructura de la receta de
destino debe ser idéntica a la de la receta importada.
Sintaxis
BOOL uaArchiveImport (
UAHARCHIVE hArchive,
LPCSTR pszSource,
LONG lType,
LONG lOptions )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
LPCSTR pszSource
Nombre de archivo del fichero de origen
LONG lType
Formato de datos del fichero de origen. Los dos formatos disponibles son:
UA_FILETYPE_DEFAULT = 0: Formato de archivo predeterminado = CSV
UA_FILETYPE_CSV = 1: Formato de archivo CSV
LONG lOptions
Reservado para extensiones posteriores. Debe ser 0.
Valor de retorno
TRUE
importación correcta de la receta
FALSE
Error
Descripción
Añade el búfer de registro a la base de datos actual. Para que haya datos apropiados en el
nuevo registro, los campos del búfer local de registros tienen que escribirse antes de llamar
uaArchiveInsert con las funciones de sistema "uaArchiveSetFieldValue...".
La "ID" de columna interna tiene que escribirse con la función de sistema
"uaArchiveSetFieldValueLong" en el registro de datos actual. Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaArchiveInsert (
UAHARCHIVE hArchive )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
TRUE
Inserción correcta del registro.
Descripción
Ir al primer registro.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaArchiveMoveFirst (
UAHARCHIVE hArchive )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
TRUE
salto correcto en la receta
FALSE
Error
Descripción
Ir al último registro.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaArchiveMoveLast (
UAHARCHIVE hArchive )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName .
Valor de retorno
TRUE
Salto correcto en la receta
FALSE
Error
Descripción
Ir al siguiente registro.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaArchiveMoveNext (
UAHARCHIVE hArchive )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
TRUE
Salto correcto en la receta
FALSE
Error
Descripción
Ir al registro anterior.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaArchiveMovePrevious (
UAHARCHIVE hArchive )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
TRUE
Salto correcto en la receta
FALSE
Error
Descripción
uaArchiveOpen debe llamarse antes que todas las funciones RT (p. ej., uaArchiveMoveFirst,
uaArchiveMoveLast, uaArchiveMoveNext, uaArchiveMovePrevious, uaArchiveDelete,
uaArchiveUpdate, uaArchiveInsert, uaArchiveGetID, uaArchiveGetFields,
uaArchiveGetFieldType, uaArchiveGetFieldValueDate, uaArchiveGetFieldValueDouble,
uaArchiveGetFieldValueFloat, uaArchiveGetFieldValueLong, uaArchiveGetFieldValueString,
uaArchiveSetFieldValueDate, uaArchiveSetFieldValueDouble, uaArchiveSetFieldValueFloat,
uaArchiveSetFieldValueLong y uaArchiveSetFieldValueString).
Nota
Clasificar y filtrar recetas
Las funciones de sistema "uaArchiveSetSort" y "uaArchiveSetFilter" pueden utilizarse en una
receta sin abrir la receta con "uaArchiveOpen".
Sintaxis
BOOL uaArchiveOpen (
UAHARCHIVE hArchive )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
TRUE
apertura correcta de la receta
FALSE
Error
Descripción
Lee los valores actuales de las variables de campos.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaArchiveReadTagValues (
UAHARCHIVE hArchive,
LONG* pnFields,
LONG cFields,
LONG lOptions )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
LONG* pnFields
Reservado para aplicaciones futuras (0)
LONG cFields
Cantidad de los índices de campo transmitidos (Tamaño del Arrays pnFields).
Reservado para aplicaciones futuras (0)
LONG lOptions
Reservado para aplicaciones futuras (0)
Para el resto de los valores de IOptions se insertan los datos en la posición del puntero.
Valor de retorno
TRUE
lectura correcta en la receta
FALSE
Error
Descripción
Lee los valores de variables en los datos actuales
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaArchiveReadTagValuesByName (
UAHARCHIVE hArchive,
LPCSTR pszFields,
LONG lOptions )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
LPCSTR pszFields
Reservado para aplicaciones futuras (0)
LONG lOptions
Reservado para aplicaciones futuras (0)
Valor de retorno
TRUE
Lectura correcta en la receta
FALSE
Error
Descripción
Tras llamar uaArchiveSetFilter y uaArchiveSetSort se debe volver a cargar la receta con
uaArchiveRequery.
Nota
Clasificar y filtrar recetas
Las funciones de sistema "uaArchiveSetSort" y "uaArchiveSetFilter" pueden utilizarse en una
receta sin abrir la receta con "uaArchiveOpen". En este caso no se debe llamar la función de
sistema "uaArchiveRequery".
Sintaxis
BOOL uaArchiveRequery(
UAHARCHIVE hArchive )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
TRUE
Requery correcto
FALSE
Error
Descripción
Escribe la fecha y la hora en un campo en el registro actual.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaArchiveSetFieldValueDate (
UAHARCHIVE hArchive,
LONG lField,
LPSYSTEMTIME pstDateTime )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
LONG lField
El número de campo, de modo que el primer campo configurado se direcciona con lField = 1.
Con lField = 0 se direcciona el campo ID.
LPSYSTEMTIME pstDateTime
Fecha y hora
Valor de retorno
TRUE
Escritura correcta de fecha y hora
FALSE
Error
Descripción
Escribe un valor double en un campo en el registro actual.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaArchiveSetFieldValueDouble (
UAHARCHIVE hArchive,
LONG lField,
double dValue )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
LONG lField
El número de campo, donde lField = 1 direcciona el primer campo configurado. Con lField =
0 se direcciona el campo ID.
double dValue
Valor de campo
Valor de retorno
TRUE
escritura correcta del valor del campo
FALSE
Error
Descripción:
Escribe un valor Float en un campo en el registro actual.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaArchiveSetFieldValueFloat (
UAHARCHIVE hArchive,
LONG lField,
float fValue )
Parámetros:
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
LONG lField
El número de campo, donde lField = 1 direcciona el primer campo configurado. Con lField =
0 se direcciona el campo ID.
float fValue
Valor de campo
Valor de retorno:
TRUE
Escritura correcta del valor del campo
FALSE
Error
Descripción
Escribe un valor de número entero Long en un campo en el registro actual.
Utilizable sólo en C-Scripting.
Syntax
BOOL uaArchiveSetFieldValueLong (
UAHARCHIVE hArchive,
LONG lField,
LONG dValue )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
LONG lField
El número de campo, donde lField = 1 direcciona el primer campo configurado. Con lField =
0 se direcciona el campo ID.
LONG dValue
Valor de campo
Valor de retorno
TRUE
Escritura correcta del valor del campo
FALSE
Error
Descripción
Escribe un string en un campo en el registro actual.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaArchiveSetFieldValueString (
UAHARCHIVE hArchive,
LONG lField,
LPCSTR pszString )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
LONG lField
El número de campo, donde lField = 1 direcciona el primer campo configurado. Con lField =
0 se direcciona el campo ID.
LPCSTR pszString
Valor de campo
Valor de retorno
TRUE
Escritura correcta del valor del campo
FALSE
Error
Descripción
Pone un filtro. Puede llamar la función de sistema sin abrir la receta con "uaArchiveOpen".
Nota
Si abre la receta con "uaArchiveOpen", esta vuelve a cargarse tras filtrar con
"uaArchiveRequery".
Sintaxis
VOID uaArchiveSetFilter (
UAHARCHIVE hArchive,
LPSTR pszFilter )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
LPSTR pszFilter
Filtro que se debe poner
Descripción
Establece la clasificación de la receta. Puede llamar la función de sistema sin abrir la receta
con "uaArchiveOpen".
Nota
Si abre la receta con "uaArchiveOpen", esta vuelve a cargarse tras clasificar con
"uaArchiveRequery".
Sintaxis
BOOL uaArchiveSetSort (
UAHARCHIVE hArchive,
LPSTR pszSort )
La función de sistema sólo puede utilizarse en C-Scripting.
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
LPCSTR pszSort
Clasificación
Valor de retorno
TRUE
Se ha activado correctamente la clasificación
FALSE
Error
Descripción
Actualiza la receta abierta. Se aplican todas las modificaciones de datos de una receta en la
base de datos. La configuración de la receta permanece inalterada.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaArchiveUpdate (
UAHARCHIVE hArchive )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
TRUE
actualización correcta de la receta
FALSE
Error "Update_failed" = 106
Este error se produce si se viola la coherencia. Ejemplo: en un campo está fijada la marca "El
campo debe poseer un valor", pero en el campo no existe ningún valor.
Descripción
Escribe los valores del registro actual en las variables.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaArchiveWriteTagValues (
UAHARCHIVE hArchive,
LONG* pnFields,
LONG cFields,
LONG lOptions )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
LONG* pnFields
Reservado para aplicaciones futuras (0)
LONG cFields
Reservado para aplicaciones futuras (0)
LONG lOptions
Reservado para aplicaciones futuras (0)
Valor de retorno
TRUE
Lectura correcta en la receta
FALSE
Error
Descripción
Escribe los valores del registro actual en las variables. El acceso se produce sobre la base
del nombre de la receta y del campo.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaArchiveWriteTagValuesByName (
UAHARCHIVE hArchive,
LPCSTR pszFields,
LONG lOptions )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
LPCSTR pszFields
Reservado para aplicaciones futuras (0)
LONG lOptions
Reservado para aplicaciones futuras (0)
Valor de retorno
TRUE
Lectura correcta en la receta
FALSE
Error
Descripción
Establecer conexión con recetas (runtime).
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaConnect (
UAHCONNECT* phConnect )
Parámetros
UAHCONNECT* phConnect
Puntero hacia el handle para la receta recién conectada.
Valor de retorno
TRUE
conexión correcta de una receta
FALSE
Error
Descripción
En el caso de que haya una conexión con recetas (runtime), ésta se suprime.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaDisconnect (
UAHCONNECT hConnect )
Parámetros
UAHCONNECT hConnect
Handle para la receta conectada (runtime). El handle se crea con uaConnect.
Valor de retorno
TRUE
desacoplamiento correcto de una receta
FALSE
Error
Descripción
Lee la configuración de la receta.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaGetArchive (
UAHCONFIG hConfig,
long lArchive,
UACONFIGARCHIVE* pArchive )
Parámetros
UAHCONFIG hConfig,
Handle de configuración de la receta. Este handle se crea con uaQueryConfiguration.
long lArchive,
Índice de ficheros (de 0 a (uaGetNumArchives()-1))
UACONFIGARCHIVE* pArchive
Puntero hacia el búfer para recibir la configuración de la receta
Valor de retorno
TRUE
acceso correcto a la receta
FALSE
Error
Descripción:
Lee la configuración del campo.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaGetField (
UAHCONFIG hConfig,
long lArchive,
long lField,
UACONFIGFIELD* pField )
Parámetros:
UAHCONFIG hConfig,
Handle de configuración de la receta. Este handle se crea con uaQueryConfiguration.
long lArchive,
Índice de ficheros (de 0 a (uaGetNumArchives()-1))
long lField,
El número de campo, donde lField = 0 el primer campo direccionado.
UACONFIGFIELD* pArchive
Puntero sobre el búfer para recibir la configuración del campo
Valor de retorno:
TRUE
Acceso correcto a la receta
FALSE
Error
Descripción
Las funciones de sistema del lenguaje Script WinCC devuelven un valor BOOL, donde TRUE
corresponde a una edición sin errores. Si se devuelve FALSE, el error de la última función de
sistema se puede leer con "uaGetLastError()" y "uaGetLastHResult()".
Utilizable sólo en C-Scripting.
Si no se llama uaGetLastError() hasta después de procesar varias funciones de sistema,
uaGetLastError() devuelve el último error que se haya producido. Para saber con seguridad
la función de sistema en que se ha producido el error, se recomienda llamar "uaGetLastError()"
y "uaGetLastHResult()" cada vez que se devuelva FALSE en una función de sistema.
Ejemplo:
if ( uaArchiveGetFieldValueLong ( hArchive, Index, &IntValue ) ==
TRUE )
printf( "Field Value = %u\n", IntValue );
else
printf("Error calling uaArchiveGetFieldValueLong: %d / %08lx\n",
uaGetLastError(), uaGetLastHResult());
En el caso de funciones de sistema que no devuelven ningún valor de retorno (VOID), se debe
realizar siempre una consulta con uaGetLastError() .
Ejemplo:
uaArchiveGetFilter(hArchive, pszFilter, cMaxLen);
INT nUAError = uaGetLastError ( );
if ( UA_ERROR_SUCCESS != nUAError)
{
printf( "Filter = [%s]\n", pszFilter );
}
else
{
printf("Error calling uaArchiveGetFilter: %d, hr=0x%08lX\n",
nUAError, uaGetLastHResult());
}
INT uaGetLastError()
Valor de retorno
Estado de fallo de la última función de sistema que se ha ejecutado. uaGetLastError() puede
devolver los siguientes errores:
UA_ERROR_SUCCESS
UA_ERROR_GENERIC
UA_ERROR_CONNECT_FAILED
UA_ERROR_OPEN_FAILED
UA_ERROR_CLOSE_FAILED
UA_ERROR_REQUERY_FAILED
UA_ERROR_MOVE_FAILED
UA_ERROR_INSERT_FAILED
UA_ERROR_UPDATE_FAILED
UA_ERROR_DELETE_FAILED
UA_ERROR_IMPORT_FAILED
UA_ERROR_EXPORT_FAILED
UA_ERROR_READ_FAILED
UA_ERROR_WRITE_FAILED
UA_ERROR_GET_FAILED
UA_ERROR_SET_FAILED
UA_ERROR_INVALID_NAME
UA_ERROR_INVALID_TYPE
UA_ERROR_INVALID_NUMRECS
UA_ERROR_INVALID_COMMTYPE
UA_ERROR_INVALID_LENGTH
UA_ERROR_INVALID_PRECISION
UA_ERROR_NULL_POINTER
UA_ERROR_INVALID_POINTER
UA_ERROR_INVALID_HANDLE
UA_ERROR_INVALID_INDEX
UA_ERROR_SERVER_UNKNOWN
Estas constantes de error y los Predefines de las rutinas de los User Archives están en
CCUACAPI.H.
Descripción
Lee el último error COM que ha ocurrido. Esta función de sistema sirve sobre todo para
diagnosticar incompatibilidades en la implementación COM utilizada o para encontrar errores
de registro y problemas de comunicación.
En principio, esta función de sistema se debe utilizar adicionalmente a UAGetLastError cuando
una función de sistema del User Archive (p. ej. uaConnect) señaliza un error con "FALSE".
Utilizable sólo en C-Scripting.
Sintaxis
LONG uaGetLastHResult()
Valor de retorno
Último error COM ocurrido
Descripción
Lee el número de recetas actualmente configuradas.
Utilizable sólo en C-Scripting.
Sintaxis
LONG uaGetNumArchives (
UAHCONFIG hConfig )
Parámetros
UAHCONFIG hConfig
Handle de configuración de la receta. Este handle se crea con uaQueryConfiguration.
Valor de retorno
Número de recetas actualmente configuradas. En caso de error se retorna -1.
Descripción
Lista del número de campos configurados. Los campos "ID", "Último usuario" y "Último acceso"
no se cuentan. En los accesos de configuración se indican los índices con 0 a
uaGetNumFields()-1.
Utilizable sólo en C-Scripting.
Sintaxis
LONG uaGetNumFields (
UAHCONFIG hConfig,
long lArchive )
Parámetros
UAHCONFIG hConfig,
Handle de configuración de la receta. Este handle se crea con uaQueryConfiguration.
long lArchive,
Índice de ficheros (de 0 a (uaGetNumArchives()-1))
Valor de retorno
Cantidad de campos configurados. En caso de error se retorna -1.
Descripción
Establecer conexión con la receta para el modo runtime. UaQueryArchive crea el handle
UAHARCHIVE.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaQueryArchive (
UAHCONNECT hConnect,
LONG lArchive,
UAHARCHIVE* phArchive )
Parámetros
UAHCONNECT hConnect
Handle de la receta conectada (runtime). El handle se crea con uaConnect.
LONG lArchive
ID del fichero que debe conectarse (0... uaGetNumArchives() -1)
UAHARCHIVE* phArchive
Puntero hacia el handle de la receta
Valor de retorno
TRUE
Creación correcta del handle para la receta.
FALSE
Error
Observación
Si se utilizan las funciones de User Archives en un proyecto de cliente que mira a pares de
servidores redundantes, en caso de cambiar de maestro la conexión de User Archives no se
puede conmutar automáticamente al nuevo maestro. En este caso, todas las llamadas de
User Archives envían el LastError UA_ERROR_SERVER_UNKNOWN = 1004, de modo que
los programas de usuario deben ejecutar un nuevo uaQueryArchive() o
uaQueryArchiveByName() y uaArchiveOpen().
Descripción
Establecer conexión con una receta a través del nombre de receta para el modo runtime.
UaQueryArchiveByName crea el handle UAHARCHIVE para la receta.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaQueryArchiveByName (
UAHCONNECT hConnect,
LPCSTR pszName,
UAHARCHIVE* phArchive )
Parámetros
UAHCONNECT hConnect
Handle de la receta conectada (runtime). El handle se crea con uaConnect.
LPCSTR pszName
Nombre de la receta. En el caso de un proyecto de cliente, aquí puede preceder al nombre
de la receta un prefijo de servidor con "::" como separador, en caso de que se utilice un servidor
que no sea el predeterminado.
UAHARCHIVE* phArchive
Puntero hacia el handle de la receta
Valor de retorno
TRUE
creación correcta del handle para la receta
FALSE
Error
Observación
Si se utilizan las funciones de User Archives en un proyecto de cliente que mira a pares de
servidores redundantes, en caso de cambiar de maestro la conexión de User Archives no se
puede conmutar automáticamente al nuevo maestro. En este caso, todas las llamadas de
User Archives envían el LastError UA_ERROR_SERVER_UNKNOWN = 1004, de modo que
los programas de usuario deben ejecutar un nuevo uaQueryArchive() o
uaQueryArchiveByName() y uaArchiveOpen().
Descripción
Crea una conexión con la receta para la configuración.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaQueryConfiguration (
UAHCONFIG* phConfig )
Parámetros
UAHCONFIG* phConfig,
Puntero hacia el handle de la receta.
Valor de retorno
TRUE
acceso correcto a la receta
FALSE
Error
Consulte también
uaAddArchive (Página 129)
Descripción
Interrumpe la conexión con la receta actual.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaReleaseArchive (
UAHARCHIVE hArchive )
Parámetros
UAHARCHIVE hArchive
Handle de la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
TRUE
interrupción correcta de la conexión con la receta.
FALSE
Error
Observación
Si el acoplamiento se realiza con éxito, el handle "hArchive" debe ajustarse a "CERO" para
que, si vuelve a utilizarse el handle que ha dejado de ser válido, el error
"UA_ERROR_INVALID_HANDLE" aparezca de inmediato sin que la función en cuestión esté
en vacío en las interfaces COM durante un tiempo prolongado.
Descripción
Interrumpe la conexión con recetas (configuración).
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaReleaseConfiguration (
UAHCONFIG hConfig,
BOOL bSave )
Parámetros
UAHCONFIG hConfig
Handle de configuración de la receta. Este handle se crea con uaQueryConfiguration.
BOOL bSave
Modificaciones de configuración seguras antes de interrumpir la conexión con recetas para
la configuración.
TRUE = Guardar modificaciones, FALSE = rechazar modificaciones
Atención: ¡Guardar modificaciones (bSave = TRUE) sólo puede
realizarse cuando el Runtime no está activo!Accediendo a uaIsActive() puede
comprobar si Runtime está activo.
Valor de retorno
TRUE
interrupción correcta de la conexión
FALSE
Error
Descripción
Borra todas las recetas que no se utilizan en vistas.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaRemoveAllArchives
( UAHCONFIG hConfig )
Parámetros
UAHCONFIG hConfig
Handle de configuración de la receta. Este handle se crea con uaQueryConfiguration.
Valor de retorno
TRUE
Borrado correcto
FALSE
Error
Observación
A continuación puede consultar con "uaGetNumArchives()" si se han borrado todas las recetas.
Descripción
Elimina todos los campos
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaRemoveAllFields (
UAHCONFIG hConfig,
long lArchive )
Parámetros
UAHCONFIG hConfig,
Handle de configuración de la receta. Este handle se crea con uaQueryConfiguration.
long lArchive,
Índice de ficheros (de 0 a (uaGetNumArchives()-1))
Valor de retorno
TRUE
Eliminación correcta de campos
FALSE
Error
Descripción
uaRemoveArchive borra toda la receta configurada.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaRemoveArchive (
UAHCONFIG hConfig,
long lArchive )
Parámetros
UAHCONFIG hConfig,
Handle de configuración de la receta. Este handle se crea con uaQueryConfiguration.
long lArchive,
Índice de ficheros (de 0 a (uaGetNumArchives()-1))
Valor de retorno
TRUE
borrado correcto de la receta.
FALSE
Error
Descripción
Elimina un campo.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaRemoveField (
UAHCONFIG hConfig,
long lArchive,
long lField )
Parámetros
UAHCONFIG hConfig,
Handle de configuración para la receta. Este handle se crea con uaQueryConfiguration.
long lArchive,
Índice de ficheros (de 0 a (uaGetNumArchives()-1))
long lField,
El número de campo, siendo lField = 0 el que direcciona el primer campo.
Valor de retorno
TRUE
Eliminación correcta del campo
FALSE
error
Descripción:
Establece la configuración de una receta.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaSetArchive (
UAHCONFIG hConfig,
long lArchive,
UACONFIGARCHIVE* pArchive
)
Parámetros
UAHCONFIG hConfig,
Handle de configuración para la receta. Este handle se crea con uaQueryConfiguration.
long lArchive,
Índice de ficheros (de 0 a (uaGetNumArchives()-1))
UACONFIGARCHIVE* pArchive
Puntero hacia el búfer pArchive con la configuración de la receta.
Valor de retorno
TRUE
acceso correcto a la receta.
FALSE
Se ha producido un error.
Descripción
Pone configuración de campo.
Utilizable sólo en C-Scripting.
Sintaxis
BOOL uaSetField (
UAHCONFIG hConfig,
long lArchive,
long lField,
UACONFIGFIELD* pField )
Parámetros
UAHCONFIG hConfig,
Handle de configuración para la receta. Este handle se crea con uaQueryConfiguration.
long lArchive,
Índice de ficheros (de 0 a (uaGetNumArchives()-1))
long lField,
El número de campo, siendo lField = 0 el que direcciona el primer campo.
UACONFIGFIELD* pField
Puntero sobre el búfer de la configuración de campo
Valor de retorno
TRUE
Acceso correcto a la receta.
FALSE
Error
Resumen de funciones
Están disponibles las siguientes funciones ctype:
● long int isalnum (long int x);
● long int isalpha (long int x);
● long int isdigit (long int x);
● long int isgraph (long int x);
● long int islower (long int x);
● long int isprint (long int x);
● long int ispunct (long int x);
● long int isspace (long int x);
● long int isupper (long int x);
● long int isxdigit (long int x);
Introducción
El grupo de funciones c_bib contiene funciones C de la biblioteca C y está dividido en:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio está dividido a su vez en:
● char_io
● directio
● error
● file
● file_pos
● output
Encontrará la descripción de estas funciones en la correspondiente documentación técnica.
Resumen de funciones
Están disponibles las siguientes funciones math:
● double acos (double x);
● double asin (double x);
● double atan (double x);
● double atan2 (double x, double y);
● double ceil (double x);
● double cos (double x);
● double cosh (double x);
● double exp (double x);
● double fabs (double x);
● double floor (double x);
● double fmod (double x, double y);
● double frexp (double x, long int* y);
● double ldexp (double x, long int y);
● double log (double x);
● double log10 (double x);
● double modf (double x, double* y);
● double pow (double x, double y);
● double sin (double x);
● double sinh (double x);
● double sqrt (double x);
● double tan (double x);
● double tanh (double x);
En la documentación técnica sobre el lenguaje de programación C existe una descripción de
las funciones math.
Las funciones sólo pueden utilizarse en C Scripts.
Resumen de funciones
Están disponibles las siguientes funciones memory:
● long int memcmp (const void* cs, const void* ct, size_t n);
● void* memchr (const void* cs, long int c, size_t n);
● void* memcpy (void* s, const void* ct, size_t n);
● void* memmove (void* s, const void* ct, size_t n);
● void* memset (void* s, long int c, size_t n);
En la documentación técnica sobre el lenguaje de programación C existe una descripción de
las funciones memory.
Las funciones sólo pueden utilizarse en C Scripts.
Resumen de funciones
Están disponibles las siguientes funciones multibyte:
● int _ismbcalnum( unsigned int c )
● int _ismbcalpha( unsigned int c )
● int _ismbcdigit( unsigned int c )
● int _ismbcgraph( unsigned int c )
● int _ismbclower( unsigned int c )
● int _ismbcprint( unsigned int c )
● int _ismbcpunct( unsigned int c )
● int _ismbcspace( unsigned int c )
● int _ismbcupper( unsigned int c )
● int _mbscmp(const unsigned char *string1, const unsigned char *string2 )
● int _mbsncmp( const unsigned char *string1, const unsigned char *string2, size_t count )
● int _mbsrchr( const unsigned char *string, unsigned int c )
● size_t _mbscspn( const unsigned char *string, const unsigned char *strCharSet )
● size_t _mbsspn( const unsigned char *string, const unsigned char *strCharSet )
● size_t _mbstrlen( const char *string )
● size_t _mbslen( const unsigned char *string )
● unsigned char *_mbscat( unsigned char *strDestination, const unsigned char *strSource)
Resumen de funciones
Están disponibles las siguientes funciones stdio:
● char* fgets (char* s, long int n, FILE* stream);
● char* tmpnam (char* s);
● FILE* fopen (const char* name, const char* mode);
● FILE* freopen (const char* filename, const char* mode, FILE* stream);
● FILE* tmpfile ();
● fprintf();
● long int fclose (FILE* stream);
● long int feof (FILE* stream);
● long int ferror (FILE* stream);
● long int fflush (FILE* stream);
● long int fgetc (FILE* stream);
● long int fgetpos (FILE* stream, fpos_t* ptr);
● long int fputc (long int c, FILE* stream);
● long int fputs (const char* s, FILE* stream);
● long int fseek (FILE* stream, long int offset, long int origin);
Resumen de funciones
Están disponibles las siguientes funciones stdlib:
● char* getenv (const char* name);
● div_t div (long int num, long int denom);
● double atof (const char* s);
● double strtod (const char* s, char** endp);
● ldiv_t ldiv (long int num, long int denom);
● long int abs (long int n);
● long int atoi (const char* s);
● long int atol (const char* s);
● long int labs (long int n);
● long int rand ();
Resumen de funciones
Están disponibles las siguientes funciones string:
● char* strcat (char* s, const char* ct);
● char* strchr (const char* cs, long int c);
● char* strcpy (char* s, const char* ct);
● char* strerror (size_t n);
● char* strncat (char* s, const char* ct, size_t n);
● char* strncpy (char* s, const char* ct, size_t n);
● char* strpbrk (const char* cs, const char* ct);
● char* strrchr (const char* cs, long int c);
● char* strstr (const char* cs, const char* ct);
● char* strtok (char* s, const char* ct);
● long int strcmp (const char* cs, const char* ct);
● long int strncmp (const char* cs, const char* ct, size_t n);
● size_t strcspn (const char* cs, const char* ct);
Resumen de funciones
Están disponibles las siguientes funciones time:
● char* asctime (const struct tm* tp);
● char* ctime (const time_t* tp);
● clock_t clock ();
● double difftime (time_t time2, time_t time1);
● size_t strftime (char* s, size_t smax, const char* fmt, const struct tm* tp);
● struct tm* gmtime (const time_t* tp);
● struct tm* localtime (const time_t* tp);
● time_t mktime (struct tm* tp);
● time_t time (time_t* tp);
En la documentación técnica sobre el lenguaje de programación C existe una descripción de
las funciones time.
Las funciones sólo pueden utilizarse en C Scripts.
typedef struct {
DWORD dwCurrentThreadID; Thread ID of the current thread
DWORD dwErrorCode1; Error code 1
DWORD dwErrorCode2; Error code 2
BOOL bCycle; cycle/acycle
char* szApplicationName; Name of the application
char* szFunctionName; Name of the function
char* szTagName; Name of the tag
LPVOID lpParam; Pointer to the action stack
DWORD dwParamSize; Size of the action stack
DWORD dwCycle; Cycle of the variable
CMN_ERROR* pError; Pointer to CMN_ERROR
} CCAPErrorExecute;
Members
El significado de los diferentes identificadores de error y los elementos de estructura
transferidos en función del significado se indican en la siguiente tabla:
Estructura de error
La función OnErrorExecute utiliza la estructura de error para la evaluación o la salida de
mensajes de error si así está identificado en la columna pError con una "x".
typedef struct {
DWORD dwCurrentThreadID; ThreadID of the current Thread
DWORD dwCode; Code
BOOL bCycle; cycle/acycle
char* szApplicationName; Name of the Application
char* szFunctionName; Name of the Function
LPVOID lpParam; Pointer to the Action-Stack
DWORD dwParamSize; size of the Action-Stack
double dblTime;
DWORD dwFlags; flags
} CCAPTime;
Members
dwCode
El elemento de estructura dwCode proporciona información sobre la llamada de OnTime:
dwFlags
El elemento de estructura dwFlags proporciona información sobre el tipo de salida:
struct CMNERRORSTRUCT {
DWORD dwError1,
DWORD dwError2,
DWORD dwError3,
DWORD dwError4,
DWORD dwError5;
TCHAR szErrorText[MAX_ERROR_LEN];
}
CMN_ERROR
Descripción
En la estructura de error ampliada hay un código de error y un texto de error para el error
ocurrido. Cada aplicación puede utilizar la estructura de error para la evaluación o para la
emisión de avisos de error.
Members
dwError1 .. dwError5
Las funciones API pueden utilizar estas entradas de forma ilimitada.
En las descripciones API se describe en cada caso qué valores contienen las entradas en
caso de error. Si no se indica otra cosa, los códigos de error están en dwError1.
szErrorText
Búfer para la descripción textual de la causa del error
El contenido se determina a partir de los recursos, por lo que varía para cada idioma.
typedef struct {
DWORD dwType;
DWORD dwSize;
char szTypeName[MAX_DM_TYPE_NAME + 1];
}
DM_TYPEREF;
Members
dwType
Especifica el tipo de variable
dwSize
Indica la longitud del tipo de datos en bytes.
szTypeName
En variables de estructura, contiene el nombre del tipo de estructura
typedef struct {
DM_TYPEREF dmTypeRef;
DM_VARKEY dmVarKey;
VARIANT dmValue;
DWORD dwState;
}
DM_VAR_UPDATE_STRUCT;
Members
dmTypeRef
Contiene información sobre el tipo de datos. En solicitudes cíclicas, por motivos de rendimiento
en esta estructura no se registra nada.
dmVarKey
Especifica la variable a editar.
dmValue
Valor de la variable.
En caso de acceso al valor del VARIANT, entre el nombre del VARIANT y el nombre del
miembro debe insertarse una ".u.".
Ejemplo
// Suministrar Variant
myVariant.vt = VT_I4;
myVariant.u.lVal = 233;
Encontrará la descripción del tipo de datos VARIANT en la correspondiente literatura
especializada. VARIANT dmValue debe inicializarse con VariantInit() ante del primer uso y
volver a habilitarse con VariantClear(&dmValue) después del uso. Por eso, la estructura
DM_VAR_UPDATE_STRUCT no puede borrarse con ZeroMemory() o memset().
dwState
Identifica el tipo de la variable.
typedef struct {
DM_TYPEREF dmTypeRef;
DM_VARKEY dmVarKey;
VARIANT dmValue;
DWORD dwState;
DWORD dwQualityCode;
}
DM_VAR_UPDATE_STRUCTEX;
Members
dmTypeRef
Contiene información sobre el tipo de datos. En solicitudes cíclicas, por motivos de rendimiento
en esta estructura no se registra nada.
dmVarKey
Especifica la variable que debe editarse.
dmValue
Valor de la variable.
En caso de accesos al valor del VARIANT, entre el nombre del VARIANT y el nombre del
miembro debe insertarse una ".u.".
Ejemplo
// Suministrar Variant
myVariant.vt = VT_I4;
myVariant.u.lVal = 233;
Encontrará la descripción del tipo de datos VARIANT en la correspondiente documentación
técnica. VARIANT dmValue debe inicializarse con VariantInit() ante del primer uso y volver a
habilitarse con VariantClear(&dmValue) después del uso. Por eso, la estructura
DM_VAR_UPDATE_STRUCTEX no puede borrarse con ZeroMemory() o memset().
dwState
Identifica el estado de la variable.
dwQualityCode
Identifica el QualityCode de la variable.
typedef struct {
DWORD dwKeyType;
DWORD dwID;
char szName[ MAX_DM_VAR_NAME + 1 ];
LPVOID lpvUserData;
}
DM_VARKEY;
Members
dwKeyType
Indica si debe accederse a la variable a través de un ID clave o de su nombre:
DM_VARKEY_ID especificación a través de ID clave
DM_VARKEY_NAME especificación a través de nombre de variable
dwID
Contiene la ID clave de la variable si dwKeyType está activado en correspondencia
szName
Contiene el nombre de la variable si dwKeyType está activado en correspondencia.
lpvUserData
Puntero en datos específicos de aplicación
typedef struct {
LINKTYPE LinkType;
DWORD dwCycle;
TCHAR szLinkName[256];
}
LINKINFO;
Members
LinkType
LinkType son constantes de enumeración definidas en el archivo "Trigger.h". Deben integrarse
en el script con el comando #include "Trigger.h" y la correspondiente constante de
enumeración.
dwCycle
Tiempo de ciclo de la actualización
szLinkName
Nombre de variable
typedef struct {
CHAR szFilterName[MSG_MAX_TEXTLEN+1];
WORD dwFilter;
SYSTEMTIME st[2];
DWORD dwMsgNr[2];
DWORD dwMsgClass;
DWORD dwMsgType[MSG_MAX_CLASS];
DWORD dwMsgState;
WORD wAGNr[2];
WORD wAGSubNr[2];
DWORD dwArchivMode;
char szTB[MSG_MAX_TB][
MSG_MAX_TB_CONTENT+1]
DWORD dwTB;
Double dPValue[MSG_MAX_PVALUE][2];
DWORD dwPValue[2];
DWORD dwMsgCounter[2];
DWORD dwQuickSelect;
}
MSG_FILTER_STRUCT;
Descripción
Es esta estructura se indican los criterios.
Members
dwFilter
Las condiciones de filtrado se definen a partir del archivo "m_global.h" por medio de las
siguientes constantes:
st
Fecha / hora desde - hasta
st[0] es el instante de inicio (desde), st[1] el instante final (hasta)
Rellene estos campos para los criterios: MSG_FILTER_DATE, MSG_FILTER_DATE_FROM,
MSG_FILTER_DATE_TO, MSG_FILTER_TIME, MSG_FILTER_TIME_FROM, bzw.
MSG_FILTER_TIME_TO
Si se necesita un tiempo actual para la transferencia de un parámetro SYSTEMTIME-, debe
utilizarse la función GetLocalTime y no GetSystemTime. Por lo general, existe una diferencia
de tiempo considerable entre estas dos funciones.
dwMsgNr
Número de aviso desde - hasta
dwMsgNr[0] es el número de inicio (desde), dwMsgNr[1] el número final. (hasta)
Rellene estos campos para los criterios: MSG_FILTER_NR, MSG_FILTER_NR_FROM bzw.
MSG_FILTER_NR_TO
dwMsgClass
Clases de aviso codificadas al bit
Rellene este campo para el criterio: MSG_FILTER_CLASS
dwMsgType
Tipo de aviso por cada clase de aviso, codificado al bit
Rellene este campo para el criterio: MSG_FILTER_CLASS
dwMsgState
Estado de aviso codificado al bit
Rellene este campo para el criterio: MSG_FILTER_STATE
wAGNr
N.º de PLC desde - hasta
wAGSubNr
Sub n.º de PLC desde - hasta
Rellene este campo para los criterios: MSG_FILTER_AGSUB_FROM o bien
MSG_FILTER_AGSUB_TO
dwArchivMode
Archivamiento/Generación de informes
Debe rellenarse con 0.
szTB
Textos de los bloques de texto
Rellene estos campos para el criterio: MSG_FILTER_TEXT
dwTB
Bloques de texto activos (desde - hasta, codificados al bit)
Rellene este campo para el criterio: MSG_FILTER_TEXT
dPValue
Valores de proceso desde - hasta
Rellene estos campos para el criterio: MSG_FILTER_PVALUE
dwPValue
Valores de proceso activos (desde - hasta, codificados al bit)
Rellene este campo para el criterio: MSG_FILTER_PVALUE
dwMsgCounter
Contador de avisos interno desde - hasta
Rellene estos campos para los criterios: MSG_FILTER_COUNTER_FROM,
MSG_FILTER_COUNTER_TO
dwQuickSelect
Selección rápida para hora, día, mes
El parámetro está separado para posteriores ampliaciones y debe estar ocupado por defecto
por 0.
Rellene este campo para el criterio: MSG_FILTER_QUICKSELECT
LOWORD tipo:
El momento final de la selección rápida se refiere a la hora actual del sistema del ordenador
local. El momento de inicio es n * ( meses, días, horas de retroceso ).
typedef struct {
DWORD dwMsgState;
DWORD dwMsgNr;
SYSTEMTIME stMsgTime;
DWORD dwTimeDiff;
DWORD dwCounter;
DWORD dwFlags;
WORD wPValueUsed;
WORD wTextValueUsed;
double dPValue[MSG_MAX_PVALUE];
MSG_TEXTVAL_STRUCT mtTextValue[MSG_MAX_PVALUE];
}
MSG_RTDATA_STRUCT;
Members
dwMsgState
Estado de un aviso
dwMsgNr
Número de aviso
stMsgTime
Fecha / hora: Hora de telegrama en función de la función que llama
dwTimeDiff
Duración entrante / tiempo de telegrama en segundos
dwCounter
Contador de avisos interno
dwFlags
Flags de avisos en la base de datos
wPValueUsed
Valores de proceso utilizados, codificados al bit. Cada bit sólo puede activarse en uno de los
elementos de estructura "wPValueUsed" o "wTextValueUsed". Un valor de consigna puede
ser un número o un texto.
wTextValueUsed
Valores de texto utilizados, codificados al bit. Cada bit sólo puede activarse en uno de los
elementos de estructura "wPValueUsed" o "wTextValueUsed". Un valor asociado puede ser
un número o un texto.
Introducción
Runtime API describe la interfaz de programación abierta de WinCC. Las funciones API
permiten utilizar las funciones internas de WinCC en aplicaciones propias y acceder a datos
de variables HMI o a los datos de fichero.
Nota
Siemens no acepta responsabilidad o garantía alguna sobre la compatibilidad de los datos y
la información transferida a través de las interfaces API con software de otros fabricantes.
Hacemos referencia expresa al hecho de que el uso indebido de la interfaz API puede provocar
pérdida de datos o paradas de producción.
Ejemplos:
● MSRTCreateMsgPlus(): crear aviso
● DMGetValue(): determinar valor de variable.
Requisitos
● Hay un entorno de programación instalado, p. ej. MS Visual Studio
● Está instalado WinCC Runtime Professional.
Utilización
Las funciones API se aplican en los siguientes casos:
● En WinCC: En funciones C definidas por el usuario y C scripts locales.
● Fuera de WinCC: En aplicaciones Windows generadas en el lenguaje de programación C/
C++. Para utilizar Runtime API en los lenguajes de programación C# o VB.net hay que
programar la conversión correspondiente.
Ejemplos en C y C++
Encontrará ejemplos en el directorio "%ProgramFiles%\SIEMENS\Automation\SCADA-
RT_V11\WINCC\samples"
Sinopsis
Sinopsis
Consulte también
DMGetDataLocale (Página 299)
Introducción
El Quality Code se necesita para comprobar el estado y la calidad de una variable. En el
Quality Code visualizado se recoge la calidad de toda la transferencia y procesamiento de
valores de la variable HMI correspondiente. De este modo, en el Quality Code se reconoce,
entre otras cosas, si el valor actual es un valor inicial o sustitutivo.
Los Quality Codes están sujetos a prioridades. Si aparecen varios códigos a la vez, se muestra
el peor Quality Code.
Estructura
El Quality Code tiene la siguiente estructura binaria:
QQSSSSLL
Q: Calidad
S: Estado Sub de la calidad
L: Límites. Este valor es opcional.
Nota
Los Quality Code representados en la tabla "Calidad" son valores básicos de los niveles de
calidad. Por el uso del estado Sub y Limit se crean valores intermedios por encima del nivel
de calidad correspondiente.
Calidad
Los primeros dos dígitos indican la calidad de las variables.
Q Q S S S S L L
2 2 2 2 2 2 2 2
7 6 5 4 3 2 1 0
Estado Sub
La calidad sola no llega. Sub Stati dividen cada una de las calidades. El Quality Code está
codificado en binario. Para analizar el Quality Code, el valor debe convertirse a su
representación hexadecimal.
Límite
Los límites pueden subdividir aún más los Quality Codes. Limits son opcional.
Q Q S S S S L L
O.K. - The value is free to move. - - - - - - 0 0
Low limited - The value has acceded its low limits. - - - - - - 0 1
Definiciones generales
Tipos de variables
Flags de propiedad
Flags de estado
En runtime puede monitorizarse el estado de distintas variables de WinCC. El estado de la
variable incluye también las violaciones de los límites configurados del rango de medida, así
como el estado de acoplamiento entre WinCC y el sistema de automatización.
El Quality Code indica la calidad de una variable, con independencia de dónde se haya creado
el código. A estos efectos se tiene en cuenta siempre el estado de la transferencia de valores
y el procesamiento de valores completo.
Si, p. ej., se produce una infracción del límite inferior del rango de medida, se emite siempre
el Quality Code "0x55". Esta infracción del rango de medida puede haberse producido en el
administrador de datos de WinCC o en el aparato de campo. El estado de la variable permite
conocer si esta infracción del rango de medida se ha producido en WinCC o antes de la
transferencia del valor a WinCC.
Si, p. ej., el estado de la variable indica una infracción de rango de medida con el código
0x0010, se ha rebasado por defecto el límite de rango configurado en WinCC. Si el estado de
la variable no indica ninguna violación de límite, entonces el Quality Code transferido a WinCC
ya contenía la infracción de límite.
Clases de notificación
Códigos de notificación
Tipo de equipo
Mensajes registrados
DM_OHIOLANGUAGE "WM_OHIOLANGUAGE"
Sinopsis
Las funciones API pueden devolver los siguientes mensajes de error en la estructura de error
CMN_ERROR:
Consulte también
CMN_ERROR (Página 1138)
Sinopsis
N.° Rutinas de conversión para el tipo de datos "Valor de 8 bits con signo"
0 CharToSignedByte
1 CharToUnsignedByte
2 CharToUnsignedWord
3 CharToUnsignedDword
4 CharToSignedWord
5 CharToSignedDword
6 CharToMSBByte
7 CharToMSBWord
8 CharToMSBDword
9 CharToBCDByte
10 CharToBCDWord
11 CharToBCDDword
12 CharToSignedBCDByte
13 CharToSignedBCDWord
14 CharToSignedBCDDword
15 CharToExtSignedBCDByte
16 CharToExtSignedBCDWord
17 CharToExtSignedBCDDword
18 CharToAikenByte
19 CharToAikenWord
20 CharToAikenDword
21 CharToSignedAikenByte
22 CharToSignedAikenWord
23 CharToSignedAikenDword
24 CharToExcessByte
25 CharToExcessWord
26 CharToExcessDword
27 CharToSignedExcessByte
28 CharToSignedExcessWord
29 CharToSignedExcessDword
> 29 (CharToSignedByte)
N.° Rutinas de conversión para el tipo de datos "Valor de 8 bits sin signo"
0 ByteToUnsignedByte
1 ByteToUnsignedWord
2 ByteToUnsignedDword
3 ByteToSignedByte
4 ByteToSignedWord
5 ByteToSignedDword
6 ByteToBCDByte
7 ByteToBCDWord
8 ByteToBCDDword
9 ByteToAikenByte
10 ByteToAikenWord
11 ByteToAikenDword
12 ByteToExcessByte
13 ByteToExcessWord
14 ByteToExcessDword
> 14 (ByteToUnsignedByte)
12 ShortToSignedBCDByte
13 ShortToSignedBCDWord
14 ShortToSignedBCDDword
15 ShortToExtSignedBCDByte
16 ShortToExtSignedBCDWord
17 ShortToExtSignedBCDDword
18 ShortToAikenByte
19 ShortToAikenWord
20 ShortToAikenDword
21 ShortToSignedAikenByte
22 ShortToSignedAikenWord
23 ShortToSignedAikenDword
24 ShortToExcessByte
25 ShortToExcessWord
26 ShortToExcessDword
27 ShortToSignedExcessByte
28 ShortToSignedExcessWord
29 ShortToSignedExcessDword
> 29 (ShortToSignedWord)
15 FloatToSignedBCDWord
16 FloatToSignedBCDDword
17 FloatToExtSignedBCDByte
18 FloatToExtSignedBCDWord
19 FloatToExtSignedBCDDword
20 FloatToAikenByte
21 FloatToAikenWord
22 FloatToAikenDword
23 FloatToSignedAikenByte
24 FloatToSignedAikenWord
25 FloatToSignedAikenDword
26 FloatToExcessByte
27 FloatToExcessWord
28 FloatToExcessDword
29 FloatToSignedExcessByte
30 FloatToSignedExcessWord
31 FloatToSignedExcessDword
32 FloatToSimaticBCDTimer
33 (FloatToFloat)
34 (FloatToFloat)
35 (FloatToFloat)
36 FloatToS5Float
37 FloatToSimaticTimer
> 37 (FloatToFloat)
16 DoubleToSignedBCDDword
17 DoubleToExtSignedBCDByte
18 DoubleToExtSignedBCDWord
19 DoubleToExtSignedBCDDword
20 DoubleToAikenByte
21 DoubleToAikenWord
22 DoubleToAikenDword
23 DoubleToSignedAikenByte
24 DoubleToSignedAikenWord
25 DoubleToSignedAikenDword
26 DoubleToExcessByte
27 DoubleToExcessWord
28 DoubleToExcessDword
29 DoubleToSignedExcessByte
30 DoubleToSignedExcessWord
31 DoubleToSignedExcessDword
32 DoubleToSimaticBCDTimer
33 (DoubleToDouble)
34 (DoubleToDouble)
35 (DoubleToDouble)
36 DoubleToS5Float
37 DoubleToSimaticTimer
> 37 (DoubleToDouble)
Declaración
typedef struct {
CHAR szConnection[
MAX_DM_CONNECTION_NAME +3];
CHAR szUnitName[MAX_DM_UNIT_NAME +1];
CHAR szCommon[MAX_DM_CON_COMMON +1];
CHAR szSpecific[MAX_DM_CON_SPECIFIC +1];
DWORD dwVarNum;
}
DM_CONNECTION_DATA;
Miembros
szConnection
Nombre de la conexión lógica
szUnitName
Nombre de la unidad de canal
szCommon
El parámetro está reservado para ampliaciones posteriores.
szSpecific
szSpecific contiene el parámetro de dirección de la conexión, p. ej., dirección Ethernet, número
de slot.... Consulte la información específica del PLC en el manual de comunicación.
Es el mismo valor que se muestra en las propiedades de una variable en WinCC, en la columna
Parámetros.
dwVarNum
Número de variables asignadas
Archivos necesarios
dmclient.h
Funciones API
Consulte también
DM_ENUM_CONNECTION_PROC (Página 447)
Declaración
typedef struct {
CHAR szName[ MAX_DM_CONNECTION_NAME + 1 ];
LPVOID lpvUserData;
}
DM_CONNKEY;
Miembros
szName
Nombre de la conexión lógica
lpvUserData
Puntero a datos específicos de aplicación
Archivos necesarios
dmclient.h
Funciones API
Consulte también
DMEnumConnectionData (Página 444)
Declaración
typedef struct {
DWORD dwCycleTime;
DWORD dwCycleIndex;
char szDescription[ MAX_DM_CYCLE_NAME + 1 ];
}
DM_CYCLE_INFO;
Members
dwCycleTime
Base de tiempo del ciclo de actualización
dwCycleIndex
Identifica el orden dentro de la lista del ciclo de actualización.
szDescription
Nombre del ciclo de actualización.
Archivos necesarios
dmclient.h
Funciones API
Consulte también
DM_ENUM_CYCLES_PROC (Página 292)
Declaración
typedef struct {
DWORD dwTeleType;
char szService[MAX_DM_SERVICE_NAME + 1];
char szSendingApp[MAX_DM_APP_NAME + 1];
DWORD dwSendingMachine;
DWORD dwDataSize;
BYTE byData[1];
}
DM_DATA_SERVICE;
Miembros
dwTeleType
El parámetro está reservado para posteriores ampliaciones y debe estar ocupado por defecto
por 0.
szService
Nombre del canal de transporte de datos. Este nombre corresponde al asignado durante la
instalación del servicio (DMInstallDataService).
szSendingApp
Nombre lógico del remitente. Este nombre corresponde al nombre de aplicación asignado en
DMConnect
dwSendingMachine
Índice del equipo desde el que se ha enviado el paquete (0 - .63). Para las funciones API se
puede acceder a todos los equipos registrados en la lista de equipos a través de su índice.
La primera entrada de la lista de equipos tiene el índice "0".
dwDataSize
Tamaño en bytes del paquete de datos: Data[0] ... byData[dwDataSize - 1]
byData
Puntero a los datos
Archivos necesarios
dmclient.h
Funciones API
Consulte también
DM_DATA_SERVICE_PROC (Página 320)
Declaración
typedef struct {
char szProjectDir[_MAX_PATH + 1 ];
char szProjectAppDir[_MAX_PATH + 1 ];
char szGlobalLibDir[_MAX_PATH + 1 ];
char szProjectLibDir[_MAX_PATH + 1 ];
char szLokalProjectAppDir[_MAX_PATH + 1 ];
}
DM_DIRECTORY_INFO;
Members
szProjectDir
Indicación completa de la ruta del directorio del proyecto, p. ej., D:\WinCC\Projekt1
szProjectAppDir
Indicación completa de la ruta del subdirectorio de la aplicación en el directorio del proyecto,
p. ej.: D:\WinCC\Projekt1\GraCS
szGlobalLibDir
Indicación completa de la ruta del directorio de la librería más allá del proyecto, p. ej.: D:\WinCC
\aplib
szProjectLibDir
Indicación completa de la ruta del directorio de la librería relacionada con el proyecto, p. ej.,
D:\WinCC\Projekt1\Library
szLokalProjectAppDir
Indicación completa de la ruta del subdirectorio de la aplicación en el directorio del proyecto
del equipo local.
Archivos necesarios
dmclient.h
Funciones API
Consulte también
DMGetProjectDirectory (Página 309)
Declaración
typedef struct {
DWORD dwFlags;
LPRECT lprcPreference;
DM_TEST_DROP_TARGET_PROC lpfnTestDropTarget;
DM_DROP_TARGET_PROC lpfnDropTarget;
LPVOID lpvUser;
}
DM_DLGOPTIONS;
Miembros
dwFlags
dwFlags define el comportamiento del diálogo o del cuadro de diálogo:
lprcPreference
Puntero a una estructura del tipo RECT con información relativa al tamaño del cuadro de
diálogo. Si lprcPreference == NULL, el cuadro de diálogo aparece centrado y con un tamaño
predefinido.
lpfnTestDropTarget
El parámetro está reservado para posteriores ampliaciones y debe estar ocupado por defecto
por NULL.
lpfnDropTarget
El parámetro está reservado para posteriores ampliaciones y debe estar ocupado por defecto
por NULL.
lpvUser
Puntero a datos específicos de aplicación.
Archivos necesarios
dmclient.h
Funciones API
Consulte también
DMShowVarDatabase (Página 411)
DMShowVarDatabaseMulti (Página 416)
Declaración
typedef struct {
DWORD dwID;
char szName[MAX_DM_FORMAT_NAME + 1];
}
DM_FORMAT_INFO;
Miembros
dwID
Número de rutinas de conversión que hay que utilizar. Encontrará más información en el
apartado "Rutinas de conversión".
szName
Nombre de las rutinas de conversión que hay que utilizar. Encontrará más información en el
apartado "Rutinas de conversión".
Archivos necesarios
dmclient.h
Funciones API
Consulte también
DM_ENUM_FORMATS_PROC (Página 289)
Declaración
typedef struct {
LONG nNumMachines;
LONG nLocalMachine;
DM_SD_TARGET_MACHINE tm[MAX_DM_OHIO_MACHINES];
}
DM_MACHINE_TABLE;
Miembros
nNumMachines
Número de equipos en el proyecto (no debe exceder la cantidad máxima
MAX_DM_OHIO_MACHINES).
nLocalMachine
Índice de la entrada del equipo local en la lista de equipos.
Para las funciones API se puede acceder a todos los equipos registrados en la lista de equipos
a través de su índice. La primera entrada de la lista de equipos tiene el índice "0".
tm
Matriz completa de tipo DM_SD_TARGET_MACHINE (Página 225) con información de los
equipos implicados en el proyecto. No obstante, sólo se transfieren nNumMachines de estas
estructuras (para lo que, como máximo se puede utilizar un índice = (nMumMachines - 1) ).
Archivos necesarios
dmclient.h
Funciones API
Consulte también
DM_SD_TARGET_MACHINE (Página 225)
DMGetMachineTable (Página 302)
Declaración
typedef struct {
char szProjectFile[ _MAX_PATH + 1 ];
char szDSNName[ MAX_DM_DSN_NAME + 1 ];
DWORD dwDataLocale;
}
DM_PROJECT_INFO;
Miembros
szProjectFile
Nombre de archivo del proyecto, ruta y extensión incluidas.
szDSNName
Data Source Name de la base de datos
dwDataLocale
Código del idioma que se utiliza en la configuración.
Archivos necesarios
dmclient.h
Funciones API
Consulte también
DM_ENUM_OPENED_PROJECTS_PROC (Página 307)
DMEnumOpenedProjects (Página 306)
DMGetProjectInformation (Página 310)
Declaración
typedef struct {
BOOL fHighPriority;
char szService[MAX_DM_SERVICE_NAME + 1];
DWORD dwTargetMachineFlags;
DWORD dwTargetMachines;
DM_SD_TARGET_MACHINE dmTargetMachine[
MAX_DM_OHIO_MACHINES];
DWORD dwTargetApps;
DM_SD_TARGET_APP dmTargetApp[
MAX_DM_OHIO_APPLICATIONS];
DWORD dwDataSize;
BYTE byData[1];
}
DM_SEND_DATA_STRUCT;
Miembros
fHighPriority
fHighPriority indica la prioridad con la que debe efectuarse el intercambio de datos:
1 Prioridad alta
0 Prioridad normal
szService
Nombre del servicio que se debe utilizar. Para que una aplicación pueda recibir datos, no
basta con que tenga la condición dwTargetMachineFlags, sino que también debe tener
instalado el correspondiente servicio con DMInstallDataService.
dwTargetMachineFlags
dwTargetMachineFlags indica las aplicaciones a las que deben enviarse datos con la función
DMSendApplicationData.
dwTargetMachines
Número de estructuras ocupadas en dmTargetMachine.
Reservado para futura ampliación y debe estar ocupado por 0.
dmTargetMachine
Puntero a la estructura DM_SD_TARGET_MACHINE (Página 225) para especificar el equipo
al que deben enviarse los datos. Sólo tiene importancia el parámetro szMachineName.
Reservado para futura ampliación y debe inicializarse totalmente con 0L.
dwTargetApps
Número de estructuras ocupadas en dmTargetApp.
dmTargetApp
Las estructuras de tipo DM_SD_TARGET_APP (Página 226) contienen el nombre de las
aplicaciones a las que deben enviarse los datos.
dwDataSize
Tamaño en bytes de los datos que hay que transmitir
byData
Matriz que contiene los datos que hay que transmitir
Observaciones
La función DMSendApplicationData sólo se implementa localmente.
Los miembros existentes en esta estructura para acceso remoto están reservados para futura
ampliación.
dwTargetMachineFlags sólo puede ocuparse con DM_SD_LOCAL; cualquier otra información
produce errores y dwTargetMachines debe ser 0L.
Archivos necesarios
dmclient.h
Funciones API
Consulte también
DMSendApplicationData (Página 324)
DM_SD_TARGET_MACHINE (Página 225)
DM_SD_TARGET_APP (Página 226)
Declaración
typedef struct {
BOOL fServer;
BOOL fLocal;
char szMachineName[
MAX_COMPUTERNAME_LENGTH + 1];
}
DM_SD_TARGET_MACHINE;
Miembros
fServer
Indica si el equipo es servidor o cliente.
El parámetro es irrelevante para el intercambio de datos (DM_SEND_DATA_STRUCT).
fLocal
Indica si la aplicación que realiza la consulta utiliza el equipo local u otro equipo configurado
en la red.
El parámetro es irrelevante para el intercambio de datos (DM_SEND_DATA_STRUCT).
szMachineName
Nombre del equipo
Observaciones
DM_SD_TARGET_MACHINE forma parte de las estructuras DM_MACHINE_TABLE
(Página 221) y DM_SEND_DATA_STRUCT (Página 223).
Archivos necesarios
dmclient.h
Consulte también
DM_MACHINE_TABLE (Página 221)
DM_SEND_DATA_STRUCT (Página 223)
Declaración
typedef struct {
char szAppName[MAX_DM_APP_NAME + 1];
}
DM_SD_TARGET_APP;
Miembros
szAppName
Utilice para szAppName el nombre de la aplicación utilizado en la llamada de DMConnect.
Observaciones
DM_SD_TARGET_APP forma parte de la estructura DM_SEND_DATA_STRUCT
(Página 223).
Archivos necesarios
dmclient.h
Consulte también
DM_SEND_DATA_STRUCT (Página 223)
Declaración
typedef struct {
DWORD dwType;
DWORD dwSize;
char szTypeName[MAX_DM_TYPE_NAME + 1];
}
DM_TYPEREF;
Miembros
dwType
En dwType se especifica el tipo de variable:
dwSize
En dwSize se indica la longitud (en bytes) del tipo de datos en el OS.
szTypeName
En szTypeName el nombre del tipo de estructura está en variables de estructura.
Observaciones
DM_TYPEREF se utiliza dentro de las estructuras DM_VAR_UPDATE_STRUCT
(Página 228) y DM_VARIABLE_DATA (Página 237).
Archivos necesarios
dmclient.h
Funciones API
Consulte también
DM_VAR_UPDATE_STRUCT (Página 228)
DMGetVarType (Página 379)
DM_VARIABLE_DATA (Página 237)
DM_VAR_UPDATE_STRUCTEX (Página 230)
DM_VARIABLE_DATA4 (Página 239)
Declaración
typedef struct {
DM_TYPEREF dmTypeRef;
DM_VARKEY dmVarKey;
VARIANT dmValue;
DWORD dwState;
}
DM_VAR_UPDATE_STRUCT;
Miembros
dmTypeRef
La estructura DM_TYPEREF (Página 227) contiene información sobre el tipo de variable.
Excepción: En solicitudes cíclicas, por motivos de rendimiento en esta estructura no se registra
nada.
dmVarKey
Con la estructura DM_VARKEY (Página 242) se especifica la variable que debe procesarse.
dmValue
Valor de la variable.
Nota
VARIANT dmValue debe inicializarse con VariantInit(&dmValue) antes del primer uso y volver
a habilitarse con VariantClear(&dmValue) después del uso.
Solo se puede preinicializar antes del primer uso una matriz de varias
DM_VAR_UPDATE_STRUCT con ZeroMemory() o memset(). Esto tiene efecto en la
VARIANT dmValue aquí contenida como una VariantInit(&dmValue), puesto que 0 equivale
a VT_EMPTY.
La estructura DM_VAR_UPDATE_STRUCT no se puede borrar con ZeroMemory() o memset()
si ya se ha utilizado una vez. Entonces VARIANT contiene datos que también pueden ser de
tipo VT_BSTR.
Si el tipo de variante es VT_BSTR surgen problemas con la administración de memoria
(MemoryLeak) si no se efectúa un VariantClear(&dmValue) antes, p. ej., de borrar estructuras
asignadas DM_VAR_UPDATE_STRUCT con delete[]
Archivos requeridos
dmclient.h
Funciones API
Consulte también
DM_NOTIFY_VARIABLE_PROC (Página 459)
DM_VARKEY (Página 242)
DMGetValue (Página 342)
DM_TYPEREF (Página 227)
Declaración
typedef struct {
DM_TYPEREF dmTypeRef;
DM_VARKEY dmVarKey;
VARIANT dmValue;
DWORD dwState;
DWORD dwQualityCode;
}
DM_VAR_UPDATE_STRUCTEX;
Members
dmTypeRef
La estructura DM_TYPEREF (Página 227) contiene información sobre el tipo de variable.
Excepción: En solicitudes cíclicas, por motivos de rendimiento en esta estructura no se registra
nada.
dmVarKey
Con la estructura DM_VARKEY (Página 242) se especifica la variable que debe procesarse.
dmValue
Valor de la variable.
Nota
VARIANT dmValue debe inicializarse con VariantInit(&dmValue) antes del primer uso y volver
a habilitarse con VariantClear(&dmValue) después del uso.
Sólo se puede preinicializar antes del primer uso una matriz de varias
DM_VAR_UPDATE_STRUCT con ZeroMemory() o memset(). Esto tiene efecto en la
VARIANT dmValue aquí contenida como una VariantInit(&dmValue), puesto que 0 equivale
a VT_EMPTY.
La estructura DM_VAR_UPDATE_STRUCTEX no se puede borrar con ZeroMemory() o
memset() si ya se ha utilizado una vez. Entonces VARIANT contiene datos que también
pueden ser de tipo VT_BSTR.
Si el tipo de variante es VT_BSTR surgen problemas con la administración de memoria
(MemoryLeak) si no se hace ningún VariantClear(&dmValue) antes, p. ej., de borrar
estructuras asignadas DM_VAR_UPDATE_STRUCTEX con delete[].
dwState
Indica si el valor de la variable se ha podido modificar correctamente o se han producido
errores:
dwQualityCode
Quality Code del valor de la variable.
Archivos necesarios
dmclient.h
Funciones API
Consulte también
DM_NOTIFY_VARIABLEEX_PROC (Página 470)
DM_TYPEREF (Página 227)
DM_VARKEY (Página 242)
DMGetValueEx (Página 344)
Declaración
typedef struct {
DWORD dwFlags;
DWORD dwNumTypes;
LPDWORD pdwTypes;
LPSTR lpszGroup;
LPSTR lpszName;
LPSTR lpszConn;
}
DM_VARFILTER;
Members
dwFlags
El parámetro dwFlags permite ajustar un criterio de selección para las variables:
dwNumTypes
Número de tipos de variable indicados en pdwTypes.
pdwTypes
pdwTypes indica el tipo de variable que se debe utilizar como criterio de selección.
lpszGroup
Puntero al nombre de un grupo de variables. El nombre debe utilizarse como criterio de
selección. No se pueden indicar comodines.
lpszName
Puntero al nombre de una variable. El nombre debe utilizarse como criterio de selección. No
se pueden indicar comodines.
lpszConn
Puntero al nombre de una conexión lógica. El nombre debe utilizarse como criterio de
selección. No se pueden indicar comodines.
Archivos necesarios
dmclient.h
Funciones API
Consulte también
DMEnumVariables (Página 338)
DMShowVarDatabase (Página 411)
DMShowVarDatabaseMulti (Página 416)
Declaración
typedef struct {
CHAR szName[ MAX_DM_VAR_NAME + 1 ];
DWORD dwCreatorID;
WORD dwVarNum;
LPVOID lpvUserData;
}
DM_VARGRP_DATA;
Miembros
szName
Nombre del grupo de variables
dwCreatorID
La identificación del causante indica quién ha creado un objeto.
Los valores 0 – 10100 y 11000 - 11100 son internos o están reservados para determinados
sistemas.
dwVarNum
Número de variables dentro del grupo de variables
lpvUserData
Puntero a datos específicos de aplicación.
Archivos necesarios
dmclient.h
Funciones API
Consulte también
DM_ENUM_VARGRP_PROC (Página 337)
Declaración
typedef struct {
CHAR szName[ MAX_DM_VAR_NAME + 1 ];
LPVOID lpvUserData;
}
DM_VARGRPKEY;
Miembros
szName
Nombre del grupo de variables
lpvUserData
Puntero a datos específicos de aplicación.
Archivos necesarios
dmclient.h
Funciones API
Consulte también
DMEnumVarGrpData (Página 334)
Declaración
typedef struct {
DM_TYPEREF dmTypeRef;
DM_VARLIMIT dmVarLimit;
VARIANT dmStart;
VARIANT dmDefault;
DWORD dwNotify;
DWORD dwFlags;
CHAR szSpecific[MAX_DM_VAR_SPECIFIC +1];
CHAR szGroup[MAX_DM_GROUP_NAME +1];
CHAR szConnection[
MAX_DM_CONNECTION_NAME +1];
CHAR szChannel[_MAX_PATH +1];
CHAR szUnit[MAX_DM_UNIT_NAME +1];
}
DM_VARIABLE_DATA;
Members
dmTypeRef
La estructura DM_TYPEREF (Página 227) contiene información sobre el tipo de variable.
dmVarLimit
La estructura DM_VARLIMIT (Página 244) contiene información sobre los valores límite de
una variable
dmStart
Valor inicial de las variables. Debe volver a habilitarse con VariantClear(&dmStart) después
del uso.
dmDefault
Valor sustitutivo de la variable. Debe volver a habilitarse con VariantClear(&dmDefault)
después del uso.
dwNotify
dwNotify determina los eventos para los que se genera una entrada en el informe:
dwFlags
Indica cómo debe utilizarse el valor sustitutivo:
szSpecific
szSpecific contiene la relación de direcciones de la variable, p. ej., bloque de datos y byte en
el bloque.... Consulte los detalles específicos del PLC en el manual de comunicación.
Es el mismo valor que se muestra en las propiedades de una variable en WinCC, en la columna
Parámetros.
szGroup
Nombre del grupo al que pertenece la variable.
Este valor no se suministra al multicliente en variables del servidor.
szConnection
Nombre de la conexión lógica con la que se combina la variable.
szChannel
Nombre de archivo del driver del canal.
szUnit
Nombre de la unidad de canal con la que se combina la variable.
Archivos necesarios
dmclient.h
Funciones API
Consulte también
DM_TYPEREF (Página 227)
DM_ENUM_VARIABLE_PROC (Página 328)
DM_VARLIMIT (Página 244)
DMEnumVarData (Página 326)
Declaración
typedef struct {
DM_TYPEREF dmTypeRef;
DM_VARLIMIT dmVarLimit;
VARIANT dmStart;
VARIANT dmDefault;
DWORD dwNotify;
DWORD dwFlags;
CHAR szSpecific[MAX_DM_VAR_SPECIFIC +1];
CHAR szGroup[MAX_DM_GROUP_NAME +1];
CHAR szConnection[
MAX_DM_CONNECTION_NAME +1];
CHAR szChannel[_MAX_PATH +1];
CHAR szUnit[MAX_DM_UNIT_NAME +1];
MCP_VARIABLE_SCALES Scaling;
DWORD dwASDataSize;
DWORD dwOSDataSize;
DWORD dwVarProperty;
DWORD dwFormat;
}
DM_VARIABLE_DATA4;
Miembros
dmTypeRef
La estructura DM_TYPEREF (Página 227) contiene información sobre el tipo de variable.
dmVarLimit
La estructura DM_VARLIMIT (Página 244) contiene información sobre los valores límite de
una variable
dmStart
Valor inicial de las variables. Debe volver a habilitarse con VariantClear(&dmStart) después
del uso.
dmDefault
Valor sustitutivo de la variable. Debe volver a habilitarse con VariantClear(&dmDefault)
después del uso.
dwNotify
dwNotify determina el evento para el que se genera una entrada de protocolo:
dwFlags
Indica cómo debe utilizarse el valor sustitutivo:
szSpecific
szSpecific contiene la relación de direcciones de las variables, p. ej., bloque de datos y bytes
en el bloque.... Consulte la información específica del PLC en el manual de comunicación.
Es el mismo valor que se muestra en las propiedades de una variable en WinCC, en la columna
Parámetros.
szGroup
Nombre del grupo al que pertenece la variable.
szConnection
Nombre de la conexión lógica con la que se combina la variable.
szChannel
Nombre de archivo del driver del canal.
szUnit
Nombre de la unidad de canal con la que se combina la variable.
Scaling
Estructura MCP_VARIABLE_SCALES (Página 269) con la descripción de la escala de las
variables.
dwASDataSize
Longitud de las variables en el PLC (número de bits)
dwOSDataSize
Longitud de las variables en el OS (número de bits)
dwVarProperty
Indica si es una variable interna o externa:
dwFormat
Número de rutinas de conversión utilizadas. Encontrará más información en el apartado
"Rutinas de conversión".
Archivos necesarios
dmclient.h
Funciones API
Consulte también
DMEnumVarData4 (Página 330)
DM_ENUM_VARIABLE_PROC4 (Página 332)
DM_TYPEREF (Página 227)
DM_VARLIMIT (Página 244)
MCP_VARIABLE_SCALES (Página 269)
Declaración
typedef struct {
DWORD dwKeyType;
DWORD dwID;
char szName[ MAX_DM_VAR_NAME + 1 ];
LPVOID lpvUserData;
}
DM_VARKEY;
Miembros
dwKeyType
dwKeyType indica si debe accederse a la variable a través de un ID clave o de su nombre:
Si se utiliza DM_VARKEY como estructura de retorno, los dos tipos pueden ser ocupados
cuando se devuelven la ID clave y el nombre de la variable.
Si se utiliza DM_VARKEY como parámetro de suministro, se debería ocupar preferiblemente
el nombre de la variable, ya que sólo puede especificarse con un prefijo de servidor. Si se
utiliza la ID clave, siempre se trabaja de forma local.
dwID
Contiene la ID clave de la variable, si dwKeyType está activado de la forma correspondiente.
szName
Contiene el nombre de la variable, si dwKeyType está activado de la forma correspondiente.
lpvUserData
Puntero a datos específicos de aplicación.
Observaciones
La estructura DM_VARKEY forma parte de la estructura DM_VAR_UPDATE_STRUCT
(Página 228).
Archivos necesarios
dmclient.h
Funciones API
Consulte también
DMStartVarUpdate (Página 457)
DM_VAR_UPDATE_STRUCT (Página 228)
DMGetValue (Página 342)
DMGetValueWait (Página 355)
DMGetVarInfo (Página 361)
Declaración
typedef struct {
VARIANT dmMaxRange;
VARIANT dmMinRange;
VARIANT dmMaxLimit;
VARIANT dmMinLimit;
}
DM_VARLIMIT;
Miembros
dmMaxRange
Límite superior de la conversión de formato
dmMinRange
Límite inferior de la conversión de formato
dmMaxLimit
Límite superior de la variable.
dmMinLimit
Límite inferior de la variable.
Observaciones
DM_VARLIMIT forma parte de la estructura DM_VARIABLE_DATA (Página 237). Todos los
VARIANT deben volver a habilitarse con VariantClear(&dmxxx) después del uso.
Archivos necesarios
dmclient.h
Funciones API
Consulte también
DM_VARIABLE_DATA (Página 237)
DMGetVarLimits (Página 373)
DM_VARIABLE_DATA4 (Página 239)
Declaración
typedef struct {
DWORD dwFlags;
char szProjectFile[_MAX_PATH +1];
char szConnection[
MAX_DM_CONNECTION_NAME +3];
char szVarName[MAX_DM_VAR_NAME +1];
char szGroupName[MAX_DM_GROUP_NAME +1];
MCP_VARIABLE_COMMON Common;
MCP_VARIABLE_PROTOCOL Protocol;
MCP_VARIABLE_LIMITS Limits;
char szSpecific[MAX_DM_VAR_SPECIFIC +1];
}
MCP_NEWVARIABLE_DATA;
Members
dwFlags
dwFlags indica cómo debe editarse la variable:
szProjectFile
Nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto puede determinarse con DMEnumOpenedProjects o en
RT con DMGetRuntimeProject.
Al indicar una cadena vacía se ejecuta un DMEnumOpenedProjects interno con el proyecto
que está abierto.
En runtime sólo puede especificarse el proyecto que está abierto. Las demás indicaciones se
rechazan con el error DM_E_NOT_CONNECTED.
szConnection
Nombre de la conexión lógica asignada a la variable.
szVarName
Nombre de la nueva variable que se va a procesar.
szGroupName
Nombre del grupo al que pertenece la variable.
Si se indica un nombre de grupo que existe en otra conexión que en la indicada en
szConnection, el nombre del grupo se ignora sin mensaje de error y la variable se crea
directamente en la conexión.
Si se indica un nombre de grupo que aún no existe, el grupo se crea de manera implícita.
Al modificar una variable con MCP_NVAR_FLAG_MODIFY, se ignora un cambio del nombre
del grupo sin mensaje de error.
Common
Estructura MCP_VARIABLE_COMMON (Página 257) con la descripción de la variable.
Protocol
Estructura MCP_VARIABLE_PROTOCOL (Página 266) con la descripción del tratamiento del
rebase de límite por la variable.
Limits
Estructura MCP_VARIABLE_LIMITS (Página 261) con los valores límite de la variable.
szSpecific
szSpecific contiene la relación de direcciones de la variable, p. ej., bloque de datos y byte en
el bloque.... Consulte los detalles específicos del PLC en el manual de comunicación.
Es el mismo valor que se muestra en las propiedades de una variable en WinCC, en la columna
Parámetros.
Observaciones
La estructura MCP_NEWVARIABLE_DATA_EX (Página 252) tiene un uso similar en la
funcionalidad ampliada.
Archivos necesarios
dmclient.h
Funciones API
Consulte también
GAPICreateNewVariable (Página 423)
MCP_VARIABLE_PROTOCOL (Página 266)
MCP_VARIABLE_COMMON (Página 257)
MCP_VARIABLE_LIMITS (Página 261)
MCP_NEWVARIABLE_DATA_EX (Página 252)
Declaración
typedef struct {
DWORD dwFlags;
char szProjectFile[_MAX_PATH +1];
char szConnection[
MAX_DM_CONNECTION_NAME +3];
char szVarName[MAX_DM_VAR_NAME +1];
char szGroupName[MAX_DM_GROUP_NAME +1];
MCP_VARIABLE_COMMON Common;
MCP_VARIABLE_PROTOCOL Protocol;
MCP_VARIABLE_LIMITS Limits;
char szSpecific[MAX_DM_VAR_SPECIFIC +1];
MCP_VARIABLE_SCALES Scaling;
}
MCP_NEWVARIABLE_DATA_4;
Members
dwFlags
dwFlags indica cómo debe editarse la variable:
szProjectFile
Nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto puede determinarse con DMEnumOpenedProjects o en
runtime con DMGetRuntimeProject.
Al indicar una cadena vacía se ejecuta un DMEnumOpenedProjects interno con el proyecto
que está abierto.
En runtime sólo puede especificarse el proyecto que está abierto. Las demás indicaciones se
rechazan con error (DM_E_NOT_CONNECTED).
szConnection
Nombre de la conexión lógica asignada a la variable.
szVarName
Nombre de la nueva variable que se va a procesar.
szGroupName
Nombre del grupo al que pertenece la variable.
Si se indica un nombre de grupo que existe en otra conexión que en la indicada en
szConnection, el nombre del grupo se ignora sin mensaje de error y la variable se crea
directamente en la conexión.
Si se indica un nombre de grupo que aún no existe, el grupo se crea de manera implícita.
Al modificar una variable con MCP_NVAR_FLAG_MODIFY, se ignora un cambio del nombre
del grupo sin mensaje de error.
Common
Estructura MCP_VARIABLE_COMMON (Página 257) con la descripción de la variable.
Protocol
Estructura MCP_VARIABLE_PROTOCOL (Página 266) con la descripción del tratamiento del
rebase de límite por la variable.
Limits
Estructura MCP_VARIABLE_LIMITS (Página 261) con los valores límite de la variable.
szSpecific
szSpecific contiene la relación de direcciones de la variable, p. ej., bloque de datos y byte en
el bloque.... Consulte los detalles específicos del PLC en el manual de comunicación.
Es el mismo valor que se muestra en las propiedades de una variable en WinCC, en la columna
Parámetros.
Scaling
Estructura MCP_VARIABLE_SCALES (Página 269) con la descripción del escalamiento de
la variable.
Observaciones
La estructura MCP_NEWVARIABLE_DATA_EX4 (Página 254) tiene un uso similar en la
funcionalidad ampliada.
Archivos necesarios
dmclient.h
Funciones API
Consulte también
MCP_VARIABLE_COMMON (Página 257)
MCP_VARIABLE_LIMITS (Página 261)
MCP_VARIABLE_PROTOCOL (Página 266)
GAPICreateNewVariable4 (Página 425)
MCP_VARIABLE_SCALES (Página 269)
MCP_NEWVARIABLE_DATA_EX4 (Página 254)
GAPICreateNewVariableEx4 (Página 428)
Declaración
typedef struct {
DWORD dwFlags;
char szProjectFile[_MAX_PATH +1];
char szConnection[
MAX_DM_CONNECTION_NAME +3];
char szVarName[MAX_DM_VAR_NAME +1];
char szGroupName[MAX_DM_GROUP_NAME +1];
MCP_VARIABLE_COMMON Common;
MCP_VARIABLE_PROTOCOL Protocol;
MCP_VARIABLE_LIMITS5 Limits;
char szSpecific[MAX_DM_VAR_SPECIFIC +1];
MCP_VARIABLE_SCALES Scaling;
}
MCP_NEWVARIABLE_DATA_5;
Members
dwFlags
dwFlags indica cómo debe editarse la variable:
szProjectFile
Nombre del archivo de proyecto, ruta y extensión incluidas.
szConnection
Nombre de la conexión lógica asignada a la variable.
szVarName
Nombre de la nueva variable que se va a procesar.
szGroupName
Nombre del grupo al que pertenece la variable.
Si se indica un nombre de grupo que existe en otra conexión que en la indicada en
szConnection, el nombre del grupo se ignora sin mensaje de error y la variable se crea
directamente en la conexión.
Si se indica un nombre de grupo que aún no existe, el grupo se crea de manera implícita.
Al modificar una variable con MCP_NVAR_FLAG_MODIFY, se ignora un cambio del nombre
del grupo sin mensaje de error.
Common
Estructura MCP_VARIABLE_COMMON (Página 257) con la descripción de la variable.
Protocol
Estructura MCP_VARIABLE_PROTOCOL (Página 266) con la descripción del tratamiento del
rebase de límite por la variable.
Limits
Estructura MCP_VARIABLE_LIMITS5 (Página 263) con los valores límite de la variable.
szSpecific
szSpecific contiene la relación de direcciones de la variable, p. ej., bloque de datos y byte en
el bloque.... Consulte los detalles específicos del PLC en el manual de comunicación.
Es el mismo valor que se muestra en las propiedades de una variable en WinCC, en la columna
Parámetros.
Scaling
Estructura MCP_VARIABLE_SCALES (Página 269) con la descripción del escalamiento de
la variable.
Observaciones
La estructura MCP_NEWVARIABLE_DATA_EX4 (Página 254) tiene un uso similar en la
funcionalidad ampliada.
Archivos necesarios
dmclient.h
Funciones API
Consulte también
GAPICreateNewVariable5 (Página 426)
MCP_VARIABLE_COMMON (Página 257)
MCP_VARIABLE_LIMITS5 (Página 263)
MCP_VARIABLE_PROTOCOL (Página 266)
MCP_NEWVARIABLE_DATA_EX4 (Página 254)
MCP_VARIABLE_SCALES (Página 269)
Declaración
typedef struct {
DWORD dwFlags;
char szProjectFile[_MAX_PATH +1];
char szConnection[
MAX_DM_CONNECTION_NAME +3];
char szVarName[MAX_DM_VAR_NAME +1];
char szGroupName[MAX_DM_GROUP_NAME +1];
MCP_VARIABLE_COMMON_EX Common;
MCP_VARIABLE_PROTOCOL_EX Protocol;
MCP_VARIABLE_LIMITS_EX Limits;
char szSpecific[MAX_DM_VAR_SPECIFIC +1]
}
MCP_NEWVARIABLE_DATA_EX;
Members
dwFlags
dwFlags indica cómo debe editarse la variable:
szProjectFile
Nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto puede determinarse con DMEnumOpenedProjects o en
runtime con DMGetRuntimeProject.
Al indicar una cadena vacía se ejecuta un DMEnumOpenedProjects interno con el proyecto
que está abierto.
En runtime sólo puede especificarse el proyecto que está abierto. Las demás indicaciones se
rechazan con error (DM_E_NOT_CONNECTED).
szConnection
Nombre de la conexión lógica asignada a la variable.
szVarName
Nombre de la nueva variable que se va a procesar.
szGroupName
Nombre del grupo al que pertenece la variable.
Si se indica un nombre de grupo que existe en otra conexión que en la indicada en
szConnection, el nombre del grupo se ignora sin mensaje de error y la variable se crea
directamente en la conexión.
Si se indica un nombre de grupo que aún no existe, el grupo se crea de manera implícita.
Al modificar una variable con MCP_NVAR_FLAG_MODIFY, se ignora un cambio del nombre
del grupo sin mensaje de error.
Common
Estructura MCP_VARIABLE_COMMON_EX (Página 258) con la descripción de la variable.
Protocol
Estructura MCP_VARIABLE_PROTOCOL_EX (Página 268) con la descripción del tratamiento
del rebase de límite por la variable.
Limits
Estructura MCP_VARIABLE_LIMITS_EX (Página 265) con los valores límite de la variable.
szSpecific
szSpecific contiene la relación de direcciones de la variable, p. ej., bloque de datos y byte en
el bloque.... Consulte los detalles específicos del PLC en el manual de comunicación.
Es el mismo valor que se muestra en las propiedades de una variable en WinCC, en la columna
Parámetros.
Observaciones
La estructura MCP_NEWVARIABLE_DATA (Página 245) tiene un uso similar.
Archivos necesarios
dmclient.h
Funciones API
Consulte también
MCP_NEWVARIABLE_DATA (Página 245)
DM_ENUM_TYPEMEMBERS_PROC_EX (Página 436)
MCP_VARIABLE_COMMON_EX (Página 258)
MCP_VARIABLE_LIMITS_EX (Página 265)
MCP_VARIABLE_PROTOCOL_EX (Página 268)
Declaración
typedef struct {
DWORD dwFlags;
char szProjectFile[_MAX_PATH +1];
char szConnection[
MAX_DM_CONNECTION_NAME +3];
char szVarName[MAX_DM_VAR_NAME +1];
char szGroupName[MAX_DM_GROUP_NAME +1];
MCP_VARIABLE_COMMON_EX Common;
MCP_VARIABLE_PROTOCOL_EX Protocol;
MCP_VARIABLE_LIMITS_EX Limits;
char szSpecific[MAX_DM_VAR_SPECIFIC +1]
MCP_VARIABLE_SCALES Scaling;
}
MCP_NEWVARIABLE_DATA_EX4;
Members
dwFlags
dwFlags indica cómo debe editarse la variable:
szProjectFile
Nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto puede determinarse con DMEnumOpenedProjects o en
runtime con DMGetRuntimeProject.
Al indicar una cadena vacía se ejecuta un DMEnumOpenedProjects interno con el proyecto
que está abierto.
En runtime sólo puede especificarse el proyecto que está abierto. Las demás indicaciones se
rechazan con error (DM_E_NOT_CONNECTED).
szConnection
Nombre de la conexión lógica asignada a la variable.
szVarName
Nombre de la nueva variable que se va a procesar.
szGroupName
Nombre del grupo al que pertenece la variable.
Si se indica un nombre de grupo que existe en otra conexión que en la indicada en
szConnection, el nombre del grupo se ignora sin mensaje de error y la variable se crea
directamente en la conexión.
Si se indica un nombre de grupo que aún no existe, el grupo se crea de manera implícita.
Al modificar una variable con MCP_NVAR_FLAG_MODIFY, se ignora un cambio del nombre
del grupo sin mensaje de error.
Common
Estructura MCP_VARIABLE_COMMON_EX (Página 258) con la descripción de la variable.
Protocol
Estructura MCP_VARIABLE_PROTOCOL_EX (Página 268) con la descripción del tratamiento
del rebase de límite por la variable.
Limits
Estructura MCP_VARIABLE_LIMITS_EX (Página 265) con los valores límite de la variable.
szSpecific
szSpecific contiene la relación de direcciones de la variable, p. ej., bloque de datos y byte en
el bloque.... Consulte los detalles específicos del PLC en el manual de comunicación.
Es el mismo valor que se muestra en las propiedades de una variable en WinCC, en la columna
Parámetros.
Scaling
Estructura MCP_VARIABLE_SCALES (Página 269) con la descripción del escalamiento de
la variable.
Observaciones
La estructura MCP_NEWVARIABLE_DATA_4 (Página 248) tiene un uso similar.
Archivos necesarios
dmclient.h
Funciones API
Consulte también
MCP_NEWVARIABLE_DATA_4 (Página 248)
MCP_NEWVARIABLE_DATA_5 (Página 250)
DM_ENUM_TYPEMEMBERS_PROC_EX4 (Página 439)
MCP_VARIABLE_COMMON_EX (Página 258)
MCP_VARIABLE_LIMITS_EX (Página 265)
MCP_VARIABLE_PROTOCOL_EX (Página 268)
MCP_VARIABLE_SCALES (Página 269)
Declaración
typedef struct {
DWORD dwVarType;
DWORD dwVarLength;
DWORD dwVarProperty;
DWORD dwFormat;
}
MCP_VARIABLE_COMMON;
Miembros
dwVarType
En dwVarType se especifica el tipo de variable:
dwVarLength
La indicación de la longitud de la variable sólo es relevante en las variables de texto
DM_VARTYPE_TEXT_8 y DM_VARTYPE_TEXT_16.
La longitud del texto se indica en caracteres (1 .... 255).
dwVarProperty
Indica si es una variable interna o externa:
dwFormat
Número de rutinas de conversión que hay que utilizar. Encontrará más información en el
apartado "Rutinas de conversión".
Observaciones
MCP_VARIABLE_COMMON forma parte de las estructuras MCP_NEWVARIABLE_DATA
(Página 245) y MCP_NEWVARIABLE_DATA_4 (Página 248).
La estructura MCP_VARIABLE_COMMON_EX (Página 258) tiene un uso similar en la
funcionalidad ampliada.
Archivos necesarios
dmclient.h
Consulte también
MCP_NEWVARIABLE_DATA (Página 245)
MCP_NEWVARIABLE_DATA_4 (Página 248)
MCP_VARIABLE_COMMON_EX (Página 258)
MCP_NEWVARIABLE_DATA_5 (Página 250)
Declaración
typedef struct {
DWORD dwVarType;
DWORD dwCreatorID
DWORD dwVarLength;
DWORD dwVarProperty;
DWORD dwFormat;
DWORD dwOSOffset;
DWORD dwASOffset;
char szStructTypeName
}
MCP_VARIABLE_COMMON_EX;
Miembros
dwVarType
En dwVarType se especifica el tipo de variable:
dwCreatorID
La identificación del causante indica quién ha creado un objeto.
Los valores 0 – 10100 y 11000 - 11100 son internos o están reservados para determinados
sistemas.
dwVarLength
La indicación de la longitud de la variable sólo es relevante en las variables de texto
DM_VARTYPE_TEXT_8 y DM_VARTYPE_TEXT_16. La longitud del texto se indica en
caracteres (1 .... 255).
dwVarProperty
Indica si es una variable interna o externa:
dwFormat
Número de rutinas de conversión que hay que utilizar. Encontrará más información en el
apartado "Rutinas de conversión".
dwOSOffset
El parámetro está reservado para posteriores ampliaciones y debe estar ocupado por defecto
por 0.
dwASOffset
Offset en el búfer del PLC
szStructTypeName
Nombre del tipo de estructura
Observaciones
MCP_VARIABLE_COMMON_EX forma parte de la estructura
MCP_NEWVARIABLE_DATA_EX (Página 252).
La estructura MCP_VARIABLE_COMMON (Página 257) tiene un uso similar.
Archivos necesarios
dmclient.h
Consulte también
MCP_NEWVARIABLE_DATA (Página 245)
MCP_VARIABLE_COMMON (Página 257)
MCP_NEWVARIABLE_DATA_EX (Página 252)
MCP_NEWVARIABLE_DATA_EX4 (Página 254)
Declaración
typedef struct {
double dTopLimit;
double dBottomLimit;
double dStartValue;
double dSubstituteValue;
BOOL bTopLimit;
BOOL bBottomLimit;
BOOL bStartValue;
BOOL bConnectionErr;
BOOL bTopLimitValid;
BOOL bBottomLimitValid;
BOOL bStartValueValid;
BOOL bSubstValueValid;
}
MCP_VARIABLE_LIMITS;
Miembros
dTopLimit
Valor del límite superior de la variable
dBottomLimit
Valor del límite inferior de la variable
dStartValue
Valor inicial de la variable
dSubstituteValue
Valor sustitutivo de la variable
bTopLimit
Si el parámetro está activado, debe utilizarse el valor sustitutivo cuando el valor de la variable
exceda el valor indicado en dTopLimit.
bBottomLimit
Si el parámetro está activado, debe utilizarse el valor sustitutivo cuando el valor de la variable
sea inferior al valor indicado en dBottomLimit.
bStartValue
Si el parámetro está activado, el valor sustitutivo debe utilizarse como valor inicial.
bConnectionErr
Si el parámetro está activado, debe utilizarse el valor sustitutivo cuando aparece un error de
conexión.
bTopLimitValid
Si el parámetro está activado, el valor del límite superior indicado en dTopLimit es válido.
bBottomLimitValid
Si el parámetro está activado, el valor del límite inferior indicado en dBottomLimit es válido.
bStartValueValid
Si el parámetro está activado, el valor inicial indicado en dStartValue es válido.
bSubstValueValid
Si el parámetro está activado, el valor sustitutivo indicado en dSubstitudeValue es válido.
Observaciones
MCP_VARIABLE_Limits forma parte de las estructuras MCP_NEWVARIABLE_DATA
(Página 245) y MCP_NEWVARIABLE_DATA_4 (Página 248).
La estructura MCP_VARIABLE_LIMITS_EX (Página 265) tiene un uso similar en la
funcionalidad ampliada.
Archivos necesarios
dmclient.h
Consulte también
MCP_NEWVARIABLE_DATA (Página 245)
MCP_NEWVARIABLE_DATA_4 (Página 248)
MCP_VARIABLE_LIMITS_EX (Página 265)
Declaración
typedef struct {
VARIANT varTopLimit;
VARIANT varBottomLimit;
VARIANT varStartValue;
VARIANT varSubstituteValue;
BOOL bTopLimit;
BOOL bBottomLimit;
BOOL bStartValue;
BOOL bConnectionErr;
BOOL bTopLimitValid;
BOOL bBottomLimitValid;
BOOL bStartValueValid;
BOOL bSubstValueValid;
}
MCP_VARIABLE_LIMITS5;
Miembros
varTopLimit
Valor del límite superior de la variable
varBottomLimit
Valor del límite inferior de la variable
varStartValue
Valor inicial de la variable
varSubstituteValue
Valor sustitutivo de la variable
bTopLimit
Si el parámetro está activado, debe utilizarse el valor sustitutivo cuando el valor de la variable
exceda el valor indicado en dTopLimit.
bBottomLimit
Si el parámetro está activado, debe utilizarse el valor sustitutivo cuando el valor de la variable
sea inferior al valor indicado en dBottomLimit.
bStartValue
Si el parámetro está activado, el valor sustitutivo debe utilizarse como valor inicial.
bConnectionErr
Si el parámetro está activado, debe utilizarse el valor sustitutivo cuando aparece un error de
conexión.
bTopLimitValid
Si el parámetro está activado, el valor del límite superior indicado en dTopLimit es válido.
bBottomLimitValid
Si el parámetro está activado, el valor del límite inferior indicado en dBottomLimit es válido.
bStartValueValid
Si el parámetro está activado, el valor inicial indicado en dStartValue es válido.
bSubstValueValid
Si el parámetro está activado, el valor sustitutivo indicado en dSubstitudeValue es válido.
Observaciones
MCP_VARIABLE_LIMITS5 forma parte de la estructura MCP_NEWVARIABLE_DATA_5
(Página 250) y es necesario para poder especificar variables de texto con valor inicial y
sustitutivo con la función GAPICreateNewVariable5 (Página 426).
Archivos necesarios
dmclient.h
Consulte también
MCP_NEWVARIABLE_DATA_5 (Página 250)
GAPICreateNewVariable5 (Página 426)
Declaración
typedef struct {
double dTopLimit
double dBottomLimit;
double dStartValue;
double dSubstituteValue;
DWORD dwLimitFlags
DWORD dwTextBibStartText;
char szTextStartText[255];
DWORD dwTextBibSubstitude;
char szTextSubstitude[255]
}
MCP_VARIABLE_LIMITS_EX;
Miembros
dTopLimit
Valor del límite superior de la variable
dBottomLimit
Valor del límite inferior de la variable
dStartValue
Valor inicial de la variable
dSubstituteValue
Valor sustitutivo de la variable
LimitFlags
El parámetro LimitFlags determina la validez del valor predefinido y del valor límite de una
variable:
dwTextBibStartText
El parámetro sólo es relevante para las variables de texto. Si el texto que va a utilizarse como
valor inicial debe leerse del texto del proyecto, indique la ID del texto correspondiente.
szTextStartText
El parámetro sólo es relevante para las variables de texto. Indique directamente en
szTextStartText el texto que va a utilizarse como valor inicial.
dwTextBibSubstitude
El parámetro sólo es relevante para las variables de texto. Si el texto que va a utilizarse como
valor sustitutivo debe leerse del texto del proyecto, indique la ID del texto correspondiente.
szTextSubstitude
El parámetro sólo es relevante para variables de texto. Indique directamente en
szTextSubstitude el texto que va a utilizarse como valor sustitutivo.
Observaciones
MCP_VARIABLE_LIMITS_EX forma parte de la estructura MCP_NEWVARIABLE_DATA_EX
(Página 252).
La estructura MCP_VARIABLE_LIMITS (Página 261) tiene un uso similar.
Archivos necesarios
dmclient.h
Consulte también
MCP_VARIABLE_LIMITS (Página 261)
MCP_NEWVARIABLE_DATA_EX (Página 252)
MCP_NEWVARIABLE_DATA_EX4 (Página 254)
Declaración
typedef struct {
BOOL bTopLimitErr;
BOOL bBottomLimitErr;
BOOL bTransformationErr;
BOOL bWriteErr;
BOOL bWriteErrApplication;
BOOL bWriteErrProzess;
}
MCP_VARIABLE_PROTOCOL;
Miembros
bTopLimitErr
Se genera una entrada de protocolo si el valor de la variable excede el valor límite superior.
bBottomLimitErr
Se genera una entrada de protocolo si el valor de la variable excede el valor límite inferior.
bTransformationErr
Se crea una entrada de protocolo cuando aparece un error de conversión.
bWriteErr
Se genera una entrada de protocolo en cada acceso de escritura no válido.
bWriteErrApplication
Se crea una entrada de protocolo en cada acceso de escritura no válido en la aplicación.
bWriteErrProzess
Se crea una entrada de protocolo en cada acceso de escritura no válido en el proceso.
Observaciones
MCP_VARIABLE_PROTOCOL forma parte de las estructuras MCP_NEWVARIABLE_DATA
(Página 245) y MCP_NEWVARIABLE_DATA_4 (Página 248).
La estructura MCP_VARIABLE_PROTOCOL_EX (Página 268) tiene un uso similar en la
funcionalidad ampliada.
Archivos necesarios
dmclient.h
Consulte también
MCP_NEWVARIABLE_DATA (Página 245)
MCP_NEWVARIABLE_DATA_4 (Página 248)
MCP_VARIABLE_PROTOCOL_EX (Página 268)
MCP_NEWVARIABLE_DATA_5 (Página 250)
Declaración
typedef struct {
DWORD dwProtocolFlags
}
MCP_VARIABLE_PROTOCOL_EX;
Miembros
dwProtocolFlags
Con el parámetro dwProtocolFlags se determina en qué evento debe generarse una entrada
de protocolo:
Observaciones
MCP_VARIABLE_PROTOCOL_EX forma parte de la estructura
MCP_NEWVARIABLE_DATA_EX (Página 252).
La estructura MCP_VARIABLE_PROTOCOL (Página 266) tiene un uso similar.
Archivos necesarios
dmclient.h
Consulte también
MCP_VARIABLE_PROTOCOL (Página 266)
MCP_NEWVARIABLE_DATA_EX (Página 252)
MCP_NEWVARIABLE_DATA_EX4 (Página 254)
Declaración
typedef struct {
DWORD dwVarScaleFlags;
double doMinProc;
double doMaxProc;
double doMinVar;
double doMaxVar;
}
MCP_VARIABLE_SCALES;
Miembros
dwVarScaleFlags
DM_VARSCALE_NOSCALE: Sin escala
DM_VARSCALE_LINEAR: Escala lineal
doMinProc
Valor mínimo de las variables en el proceso
doMaxProc
Valor máximo de las variables en el proceso
doMinVar
Valor mínimo de las variables en WinCC
doMaxVar
Valor máximo de las variables en WinCC
Observaciones
MCP_VARIABLE_SCALES forma parte de la estructura MCP_NEWVARIABLE_DATA_4
(Página 248).
Archivos necesarios
dmclient.h
Consulte también
MCP_NEWVARIABLE_DATA_4 (Página 248)
MCP_NEWVARIABLE_DATA_5 (Página 250)
Utilización
La función activa el proyecto abierto en WinCC.
Declaración
BOOL DMActivateRTProject (
LPCMN_ERROR lpdmError);
Parámetro
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Proyecto activado.
FALSE
Error.
Comentario
Esta función se edita internamente de forma asíncrona. Si la petición se ha transferido
internamente de forma correcta, siempre devuelve TRUE. Si, p. ej., el nombre del equipo
servidor se ha indicado mal en el proyecto, no se notifica ningún error.
DMGetRTProject(..) comprueba si el inicio ha sido correcto.
Si es necesario comprobar que el nombre del equipo es correcto, utilice las funciones
DMGetMachineTable(..) y GetComputername(..).
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Consulte también
DMGetMachineTable (Página 302)
Declaración
BOOL DMAddNotify (
DM_NOTIFY_PROC lpfnNotify,
LPVOID lpvUser,
LPDWORD lpdwNotifyCookie,
LPCMN_ERROR lpdmError);
Descripción
Incorporación de una llamada adicional de la función Notify a "DMClient". La funcionalidad
Notify se corresponde con la funcionalidad que puede indicarse con "DMConnect".
Parámetro
lpfnNotify
Puntero a funciones Notify adicionales.
lpvUser
Puntero a datos específicos de la aplicación. El puntero no es evaluado por la función, sino
que vuelve a ponerse a disposición en la función Notify.
lpdwNotifyCookie
Puntero a un "DWORD" en el que se devuelve una cookie para Notify.
La cookie vuelve a necesitarse más tarde con la función "DMRemoveNotify" para eliminar la
ejecución de Notify.
lpdmError
Puntero a los datos del aviso de error avanzado en la estructura "CMN_ERROR". En caso de
fallo, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Función Notify adicional incorporada.
FALSE
Error
Observaciones
La función se necesita en el caso de que ya se haya ejecutado "DMConnect" dentro del
proceso pero no sea posible acceder a la función Notify allí indicada. Así, es posible incorporar
una función Notify adicional que permita asimismo evaluar las Notifies correspondientes.
Si, p. ej., se utiliza una DLL de creación propia con funcionalidad DMClient en una función de
script global, no podrán ejecutarse más "DMConnect". El script ya ha ejecutado un
"DMConnect" y ya no es posible la notificación.
En algunos casos excepcionales puede ocurrir que se suministre Notify antes de que retorne
la llamada de función.
Las funciones Notify incorporadas adicionalmente deberán ser eliminadas con
"DMRemoveNotify" antes de "DMDisconnect". Asimismo, la Notify no debe ser una función
miembro de un objeto de clase que pueda ser destruido o borrado antes de tiempo. Podría
haber otra llamada de Notify tras "DMRemoveNotify".
Mensajes de error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Funciones relacionadas
Ejemplos
Button AddNotify:
#include "apdefap.h"
void OnClick(char* lpszPictureName,
char* lpszObjectName,
char* lpszPropertyName)
{
AddNotify();
}
Project-Function AddNotify:
extern BOOL DM_NotifyProcA(DWORD dwNotifyClass,
DWORD dwNotifyCode,
LPBYTE lpbyData,
DWORD dwItems,
LPVOID lpvUser);
void AddNotify()
{
BOOL bRet = FALSE;
DWORD dwNotifyCookie = 0L;
LPVOID lpvUser = NULL;
CMN_ERRORA err;
memset(&err, 0, sizeof(CMN_ERRORA));
dwNotifyCookie = GetTagDWord("DMdwNotifyCookie");
if (dwNotifyCookie)
{
printf("\r\nremove first previous Notify Cookie=%08lx",
dwNotifyCookie);
if (FALSE == bRet)
{
printf("\r\nERROR: DMRemoveNotifyA [%s],%ld,%ld,%ld,
%ld,%ld",
err.szErrorText,
err.dwError1,
err.dwError2,
err.dwError3,
err.dwError4,
err.dwError5);
}
dwNotifyCookie = 0L;
SetTagDWord("DMdwNotifyCookie",dwNotifyCookie);
}
memset(&err, 0, sizeof(CMN_ERRORA));
lpvUser = (LPVOID)dwNotifyCookie; //set only for show in notify
bRet = DMAddNotifyA(DM_NotifyProcA,
lpvUser,
&dwNotifyCookie,
&err);
if (bRet)
{
printf("\r\nNotify added, Cookie=%08lx!", dwNotifyCookie);
SetTagDWord("DMdwNotifyCookie",dwNotifyCookie);
}
else
{
printf("\r\nERROR: DMAddNotifyA [%s],%ld,%ld,%ld,%ld,%ld",
err.szErrorText,
err.dwError1,
err.dwError2,
err.dwError3,
err.dwError4,
err.dwError5);
}
}
Project-Function DM_NotifyProcA:
extern void RemoveNotify();
bShowParams = TRUE;
break;
default:
printf("\r\nunknown DM_NOTIFY_CLASS_ERROR:
dwNotifyCode[%08lx]", dwNotifyCode);
bShowParams = TRUE;
}
break;
case DM_NOTIFY_CLASS_WARNING:
switch (dwNotifyCode)
{
case DM_NOTIFY_QUEUE_50_PERCENT:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_QUEUE_50_PERCENT");
break;
case DM_NOTIFY_QUEUE_60_PERCENT:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_QUEUE_60_PERCENT");
break;
case DM_NOTIFY_QUEUE_70_PERCENT:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_QUEUE_70_PERCENT");
break;
case DM_NOTIFY_QUEUE_80_PERCENT:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_QUEUE_80_PERCENT");
break;
case DM_NOTIFY_QUEUE_90_PERCENT:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_QUEUE_90_PERCENT");
break;
case DM_NOTIFY_QUEUE_OVERFLOW:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_QUEUE_OVERFLOW");
break;
case DM_NOTIFY_CYCLES_CHANGED:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_CYCLES_CHANGED");
bShowParams = TRUE;
break;
case DM_NOTIFY_MACHINES_CHANGED:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_MACHINES_CHANGED");
bShowParams = TRUE;
break;
case DM_NOTIFY_PROJECT_OPENED:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_PROJECT_OPENED [%s]",
(LPSTR)lpbyData);
bSpecialActionRemoveNotify = TRUE;
break;
case DM_NOTIFY_PROJECT_CLOSED:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_PROJECT_CLOSE");
bSpecialActionRemoveNotify = TRUE;
break;
case DM_NOTIFY_SYSTEM_LOCALE:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_SYSTEM_LOCALE [%ld]",
*(DWORD*)lpbyData);
break;
case DM_NOTIFY_DATA_LOCALE:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_DATA_LOCALE [%ld]",
*(DWORD*)lpbyData);
break;
case DM_NOTIFY_PROJECT_RUNTIME:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_ROJECT_RUNTIME [%s]",
(LPSTR)lpbyData);
break;
case DM_NOTIFY_PROJECT_EDIT:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_PROJECT_EDIT [%s]",
(LPSTR)lpbyData);
bSpecialActionRemoveNotify = TRUE;
break;
case DM_NOTIFY_HOTKEY_CHANGE:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_HOTKEY_CHANGE");
bShowParams = TRUE;
break;
case DM_NOTIFY_URSEL:
printf("\r\nDM_NOTIFY_CLASS_WARNING: DM_NOTIFY_URSEL");
bShowParams = TRUE;
break;
case DM_NOTIFY_BODO:
printf("\r\nDM_NOTIFY_CLASS_WARNING: DM_NOTIFY_BODO");
bShowParams = TRUE;
break;
case DM_NOTIFY_BEGIN_PROJECT_EDIT:
printf("\r\nDM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_BEGIN_PROJECT_EDIT [%s]",
(LPSTR)lpbyData);
bShowParams = TRUE;
bSpecialActionRemoveNotify = TRUE;
break;
default:
printf("\r\nunknown DM_NOTIFY_CLASS_WARNING:
dwNotifyCode[%08lx]", dwNotifyCode);
bShowParams = TRUE;
}
break;
case DM_NOTIFY_CLASS_DATA:
switch (dwNotifyCode)
{
case DM_NOTIFY_APPLICATION_DATA:
printf("\r\nDM_NOTIFY_CLASS_DATA:
DM_NOTIFY_APPLICATION_DATA:");
bShowParams = TRUE;
break;
case DM_NOTIFY_VARIABLE_DATA:
printf("\r\nDM_NOTIFY_CLASS_DATA:
DM_NOTIFY_VARIABLE_DATA:");
bShowParams = TRUE;
break;
case DM_NOTIFY_FIRE_DATA:
// the data sended with DMFireNotifyData is char text
printf("\r\nDM_NOTIFY_CLASS_DATA: DM_NOTIFY_FIRE_DATA:
(data as text: [%s])",
(char*)lpbyData);
bShowParams = TRUE;
break;
default:
printf("\r\nunknown DM_NOTIFY_CLASS_DATA:
dwNotifyCode[%08lx]", dwNotifyCode);
bShowParams = TRUE;
}
break;
default:
printf("\r\nunknown dwNotifyClass[%08lx],
dwNotifyCode[%08lx]",
dwNotifyClass,
dwNotifyCode);
bShowParams = TRUE;
}
if (bShowParams)
{
printf("\r\ndwNotifyClass=%08lx, dwNotifyCode=%08lx,
dwItems=%ld, lpbyData=%08lx, lpvUser=%08lx",
dwNotifyClass,
dwNotifyCode,
dwItems,
lpbyData,
(DWORD)lpvUser);
}
if (bSpecialActionRemoveNotify)
{
printf("\r\nHave to remove notify if RT exits:");
RemoveNotify();
}
return TRUE;
}
Utilización
Lanza el aviso a todas las aplicaciones conectadas con DMConnect al cambiar el idioma de
runtime.
Declaración
BOOL DMChangeDataLocale (
LPCTSTR lpszProjectFile,
DWORD dwLocaleID,
LPCMN_ERROR lpdmError);
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto se determina con DMEnumOpenedProjects o en RT con
DMGetRuntimeProject.
dwLocaleID
Puntero al código del nuevo idioma ajustado. Los valores posibles son los códigos de todos
los idiomas configurados en la librería de textos.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Aplicaciones informadas del cambio de idioma.
FALSE
Error.
Comentario
La aplicación será notificada a través de la función Callback DM_NOTIFY_PROC
(Página 282) con los siguientes parámetros:
dwNotifyClass DM_NOTIFY_CLASS_WARNING
dwNotifyCode DM_NOTIFY_DATA_LOCALE
lpbyData Puntero al código del nuevo idioma que debe ajus‐
tarse.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Consulte también
DM_NOTIFY_PROC (Página 282)
DMEnumOpenedProjects (Página 306)
DMGetRuntimeProject (Página 312)
Utilización
Establecimiento de conexión de una aplicación con el administrador de datos. En una
aplicación (proceso) sólo puede realizarse un DMConnect. Las siguientes llamadas devuelven
el error DM_E_ALREADY_CONNECTED.
Declaración
BOOL DMConnect (
LPTSTR lpszAppName,
DM_NOTIFY_PROC lpfnNotify,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Parámetro
lpszAppName
Puntero al nombre de la aplicación que efectúa la llamada. Se puede seleccionar cualquier
nombre ya que el parámetro sirve como identificación interna.
La longitud del nombre de la aplicación está limitada en MAX_DM_APP_NAME (32
caracteres). Los nombres más largos producen errores en el OHIOIPC.DLL subordinado y la
cancelación con el error DM_E_NOT_CONNECTED.
lpfnNotify
Puntero a la función de notificación para enviar mensajes administrativos del administrador
de datos a la aplicación.
Si un programa activa una rutina Notify, deberá vaciar periódicamente su cola de mensajes.
Los mensajes no recogidos pueden bloquear las notificaciones de WinCC y, con ello, todo
WinCC.
En algunos casos excepcionales puede ocurrir que se devuelva Notify antes de que retorne
la llamada de función.
La rutina Notify también debe estar disponible después de DMDisConnect, ya que pueden
llegar llamadas atrasadas.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Conexión con el administrador de datos establecida.
FALSE
Error.
Observación
En las variantes de WinCC que se implementan en las plataformas del sistema operativo que
soportan multithread, las llamadas a la función de notificación se realizan de forma asíncrona
respecto al proceso que efectúa la llamada.
Se debe configurar una sincronización apropiada dentro de la aplicación.
Si en un programa se distribuyen funciones del administrador de datos entre varios threads,
ejecute en cada uno de los threads un DMConnect y al final un DMDisconnet.
Compruebe primero con DMGetConnectionState si otro thread ya ha establecido una
conexión. Si ya existe una conexión, no se debe ejecutar DMConnect ni DMDisConnect.
Para evitar este conflicto, agrupe en un solo thread las llamadas de función al administrador
de datos y ejecute la llamada sólo desde ahí.
Si las funciones del administrador de datos se transfieren a una DLL que se ha integrado en
una aplicación con funciones de administrador de datos, compruebe si puede realizar la
conexión y la desconexión en la DLL. En este caso, la aplicación debe asegurar cada una de
las llamadas de función del administrador de datos con DMGetConnectionState. No obstante,
el encapsulado de threads en la DLL no ofrece ninguna seguridad antes de la desconexión.
Defina un único establecimiento de conexión en un indicador, para que DMDisConnect sólo
se ejecute en caso de que se desee.
Una llamada DMConnect no comprobada con Notify que devuelve el mensaje de error
DM_E_ALREADY_CONNECTED puede cancelar el Notify de una llamada anterior y
ocasionar resultados no deseados.
Los punteros a las áreas de datos transferidos en la función de rellamada sólo tienen validez
dentro de la función, es decir, tras el retorno de Callback el administrador de datos autoriza
posibles áreas de memoria asignadas. Si la aplicación necesita acceder a los datos después
del tiempo de llamada, debe copiarlos adecuadamente.
Además, existen punteros a las áreas de memoria de las plataformas que lo soportan,
exclusivamente acceso a lectura, de modo que un acceso de escritura a los datos relevantes
provoca una violación de protección.
Actualmente no se evalúa el valor de retorno de Callback, pero será relevante en futuras
versiones. La aplicación generalmente debe devolver TRUE.
Las DLL de API no deben utilizarse directamente en los servicios (ISS), ya que no tienen
disponibles los recursos internos necesarios.
Si se utilizan las funciones del administrador de datos, por ejemplo, en un Wrapper de un
entorno gestionado (C#), tenga en cuenta que en el mismo proceso se utilizan varios
ApplicationDomains de una aplicación. Por eso sólo está permitido un DMConnect en todos
los ApplicationDomains.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones relacionadas
Ejemplos
Connection to DM (Página 477)"DM01.cpp"
Consulte también
DM_NOTIFY_PROC (Página 282)
DMDisconnect (Página 286)
DMGetConnectionState (Página 298)
Connection to DM (Página 477)
APConnect (Página 609)
Descripción
Para que la aplicación pueda ser notificada, p. ej., de cambios de idioma, es preciso facilitar
una función Callback del tipo DM_NOTIFY_PROC.
Declaración
BOOL ( * DM_NOTIFY_PROC) (
DWORD dwNotifyClass,
DWORD dwNotifyCode,
LPBYTE lpbyData,
DWORD dwItems,
LPVOID lpvUser);
Parámetro
dwNotifyClass
Indica la clase de notificación:
DM_NOTIFY_CLASS_ERROR (0x00000001)
DM_NOTIFY_CLASS_WARNING (0x00000002)
DM_NOTIFY_CLASS_DATA (0x00000003)
dwNotifyCode
Código de notificación
Para DM_NOTIFY_CLASS_ERROR:
DM_NOTIFY_SHUTDOWN (0x00000001) Se finaliza el administrador de
datos
DM_NOTIFY_PROCESSNET_ERROR (0x00000002) Error en el bus de procesos
DM_NOTIFY_SYSNET_ERROR (0x00000003) Error en el bus de sistemas
Para DM_NOTIFY_CLASS_WARNING:
DM_NOTIFY_QUEUE_50_PERCENT (0x00000001) Nivel de llenado de la cola de
aplicación 50%
DM_NOTIFY_QUEUE_60_PERCENT (0x00000002) Nivel de llenado de la cola de
aplicación 60%
DM_NOTIFY_QUEUE_70_PERCENT (0x00000003) Nivel de llenado de la cola de
aplicación 70%
DM_NOTIFY_QUEUE_80_PERCENT (0x00000004) Nivel de llenado de la cola de
aplicación 80%
DM_NOTIFY_QUEUE_90_PERCENT (0x00000005) Nivel de llenado de la cola de
aplicación 90%
DM_NOTIFY_QUEUE_OVERFLOW (0x00000006) Rebase de la cola de aplicación
DM_NOTIFY_CYCLES_CHANGED (0x00000010) Volver a leer ciclos de actualiza‐
ción
DM_NOTIFY_MACHINES_CHANGED (0x00000011) Volver a leer lista de equipos
DM_NOTIFY_PROJECT_OPENED (0x00000012) El proyecto se carga
DM_NOTIFY_PROJECT_CLOSE (0x00000013) El proyecto se cierra
DM_NOTIFY_SYSTEM_LOCALE (0x00000014) Cambiar idioma de configuración
DM_NOTIFY_DATA_LOCALE (0x00000015) Cambiar el idioma de la interfaz
de usuario
DM_NOTIFY_PROJECT_RUNTIME (0x00000016) El proyecto se activa
lpbyData
Puntero a los datos notificados dentro de la clase DM_NOTIFY_CLASS_DATA.
dwItems
Número de entradas en lpbyData.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
Los valores de retorno dependen de su implementación.
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Si un programa activa una rutina Notify, deberá vaciar periódicamente su cola de mensajes.
Los mensajes no recogidos pueden bloquear las notificaciones de WinCC y, con ello, todo
WinCC.
En algunos casos excepcionales puede ocurrir que se devuelva Notify antes de que retorne
la llamada de función DMConnect.
Archivos necesarios
dmclient.h
Funciones relacionadas
Ejemplos
AUTOHOTSPOT"DM01.cpp"
Consulte también
DMConnect (Página 279)
Utilización
El proyecto ubicado en el modo runtime se desactiva.
Declaración
BOOL DMDeactivateRTProject (
LPCMN_ERROR lpdmError);
Parámetro
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Proyecto desactivado.
FALSE
Error.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
OnTestDeactivateRuntimeProject (Página 489)"TESTCDoc.cpp"
Consulte también
OnTestDeactivateRuntimeProject (Página 489)
Utilización
Con esta función una aplicación deshace una conexión existente con el administrador de
datos.
Declaración
BOOL DMDisConnect (
LPCMN_ERROR lpdmError);
Parámetro
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Conexión finalizada.
FALSE
Error.
Observaciones
Si no se ha inicializado ninguna conexión con el administrador de datos con la función
DMConnect, el valor de retorno es FALSE. El código de error lpdmError->dwError contiene el
valor DM_E_NOT_CONNECTED, sin conexión con el administrador de datos.
Nota
La llamada no puede utilizarse en el destructor de una aplicación (EXE, DLL, OCX, ...). Debido
a unos mecanismos específicos de Microsoft, existe la posibilidad de que la llamada quede
"colgada" y, por tanto, también el programa.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Ejemplos
Connection to DM (Página 477)"DM01.cpp"
Consulte también
DMConnect (Página 279)
Connection to DM (Página 477)
Utilización
La función lista todas las conversiones de formato disponibles en FORMAT.DLL .
Declaración
BOOL DMEnumNumberFormats (
LPDWORD lpdwItems,
DM_ENUM_FORMATS_PROC lpfnFormat,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Parámetro
lpdwItems
Puntero a una variable de palabra doble de la aplicación que tras la llamada contiene la
cantidad de información de formato enumerada.
lpfnFormat
Puntero a la función Callback que se llama para cada formato de número disponible.
lpvUser
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Conversiones de formato listadas.
FALSE
Error.
Observaciones
Los punteros transferidos en la función Callback sólo tienen validez dentro de ella, ya que el
sistema vuelve a autorizar todas las posibles áreas de memoria asignadas tras el retorno de
la función. Si una aplicación requiere acceso externo a los datos, debe copiarlos
adecuadamente.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Consulte también
DM_ENUM_FORMATS_PROC (Página 289)
Descripción
Para poder evaluar las conversiones de formato listadas en el sistema, es preciso facilitar una
función Callback del tipo DM_ENUM_FORMATS_PROC.
Declaración
BOOL ( * DM_ENUM_FORMATS_PROC) (
LPDM_FORMAT_INFO lpdmFormat,
DWORD dwItem,
LPVOID lpvUser);
Parámetro
lpdmFormat
Puntero a una estructura del tipo DM_FORMAT_INFO (Página 221) con datos de una
conversión de formato.
dwItem
Contador de llamadas continuo. Si la enumeración no se cancela prematuramente, dwItem
contiene el número de conversiones de formato disponibles.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
La enumeración continúa.
FALSE
La enumeración se cancela.
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
dmclient.h
Funciones relacionadas
Consulte también
DMEnumNumberFormats (Página 287)
DM_FORMAT_INFO (Página 221)
Utilización
La función lista todos los ciclos de actualización definidos en el sistema. La función transfiere
en cada llamada de la función Callback una estructura de información para el ciclo.
Declaración
BOOL DMEnumUpdateCycles (
LPCSTR lpszProjectFile,
LPDWORD lpdwItems,
DM_ENUM_CYCLES_PROC lpfnCycle,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto se determina con DMEnumOpenedProjects o en RT con
DMGetRuntimeProject.
lpdwItem
Puntero a una variable de palabra doble de la aplicación que tras la llamada contiene la
cantidad de información de ciclo enumerada.
lpfnCycle
Puntero a la función Callback que se llama para cada ciclo de actualización disponible.
lpvUser
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Ciclos de actualización listados
FALSE
Error
Observaciones
Los punteros transferidos en la función Callback sólo tienen validez dentro de la función, ya
que el sistema vuelve a autorizar todas las posibles áreas de memoria asignadas tras el
retorno de la función.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Ejemplos
OnTestUpdateCycles (Página 497)"TESTCDoc.cpp"
Consulte también
DM_ENUM_CYCLES_PROC (Página 292)
OnTestUpdateCycles (Página 497)
Descripción
Para poder evaluar los ciclos de actualización listados en el sistema, es preciso facilitar una
función Callback del tipo DM_ENUM_CYCLES_PROC.
Declaración
BOOL ( * DM_ENUM_CYCLES_PROC) (
LPDM_CYCLE_INFO lpdmCycle,
DWORD dwItem,
LPVOID lpvUser);
Parámetro
lpdmCycle
Puntero a una estructura del tipo DM_CYCLE_INFO (Página 216) con datos de un ciclo de
actualización.
dwItem
Contador de llamadas continuo. Si la enumeración no se cancela prematuramente, dwItem
contiene el número de ciclos de actualización disponibles.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
La enumeración continúa.
FALSE
La enumeración se cancela.
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
dmclient.h
Funciones relacionadas
Consulte también
DMEnumUpdateCycles (Página 290)
DM_CYCLE_INFO (Página 216)
Utilización
Esta función finaliza WinCC.
Declaración
BOOL DMExitWinCC (
VOID);
Parámetro
Ninguno
Observaciones
Asimismo, la función DMExitWinCCEx determina el comportamiento del sistema operativo
tras finalizar WinCC.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Ejemplos
OnTestWinCCShutdown (Página 514)"TESTCDoc.cpp"
Consulte también
OnTestWinCCShutdown (Página 514)
DMExitWinCCEx (Página 294)
Utilización
Esta función finaliza WinCC. Además se puede determinar cómo debe comportarse el sistema
operativo tras finalizar WinCC.
Declaración
BOOL DMExitWinCCEx (
DWORD dwMode );
Parámetro
dwMode
dwMode permite determinar diferentes modos de comportamiento del sistema operativo tras
finalizar WinCC.
Observaciones
Con el parámetro DM_SDMODE_WINCC la función tiene los mismos efectos que
DMExitWinCC.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Consulte también
DMExitWinCC (Página 293)
Declaración
BOOL DMFireNotifyData (
DWORD dwNotifyCookie,
DWORD dwByteCount,
LPBYTE lpbyData,
LPCMN_ERROR lpdmError);
Descripción
Envía una Notify adicional a una Notify incorporada por medio de la identificación de cookie
indicada.
Parámetro
dwNotifyCookie
Cookie de una función Notify adicional incorporada con "DMAddNotify".
Si está indicado "0", los datos Notify se envían a todas las Notifies activas (broadcast).
dwByteCount
Tamaño del búfer de datos que hay que enviar en "BYTE".
lpbyData
Puntero a un búfer "BYTE" que contiene los datos Notify que hay que enviar.
El tamaño del búfer se indica con "dwByteCount".
lpdmError
Puntero a los datos del aviso de error avanzado en la estructura "CMN_ERROR". En caso de
fallo, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Datos Notify enviados.
FALSE
Error
Observaciones
La Notify enviada se procesa en la rutina Notify activada en
"dwNotifyClass=DM_NOTIFY_CLASS_DATA" y "dwNotifyCode=DM_NOTIFY_FIRE_DATA".
Si se ejecuta "DMDisconnect" sin borrar antes las funciones Notify adicionales, vuelve a
enviarse al final un "DM_NOTIFY_SHUTDOWN" a todas estas funciones Notify, que se
borrarán entonces internamente con la administración. A continuación podrán desecharse la
conexión y las cookies, ya que dejan de ser válidas.
Mensajes de error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Funciones relacionadas
Ejemplos
Button DMFireNotifyData:
#include "apdefap.h"
void OnClick(char* lpszPictureName,
char* lpszObjectName,
char* lpszPropertyName)
{
DWORD dwNotifyCookie;
CHAR* pszNotifyText;
CMN_ERROR err;
BOOL bRet;
dwNotifyCookie = GetTagDWord("DMdwNotifyCookie");
pszNotifyText = GetTagChar("DMNotifySendText");
memset(&err, 0, sizeof(err));
bRet = FALSE;
bRet = DMFireNotifyData(dwNotifyCookie,
strlen(pszNotifyText)*sizeof(CHAR)+1,
(LPBYTE)pszNotifyText, &err);
if (FALSE == bRet)
{
printf("\r\nERROR: DMFireNotifyData [%s],%ld,%ld,%ld,%ld,%ld",
err.szErrorText,
err.dwError1,
err.dwError2,
err.dwError3,
err.dwError4,
err.dwError5);
}
Utilización
Esta función consulta si existe una conexión con el administrador de datos, p. ej., para verificar
si la llamada de función DMConnect se ha ejecutado correctamente.
Declaración
BOOL DMGetConnectionState (
LPCMN_ERROR lpdmError);
Parámetro
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
La conexión existe.
FALSE
Error o la conexión no existe.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Ejemplos
AUTOHOTSPOT"DM01.cpp"
Consulte también
DMConnect (Página 279)
Connection to DM (Página 477)
Utilización
La función determina la ID del idioma actualmente ajustado de runtime.
Declaración
BOOL DMGetDataLocale (
LPDWORD lpdwLocaleID,
LPCMN_ERROR lpdmError);
Parámetro
lpdwLocaleID
Puntero al código del idioma ajustado actual. Los valores de retorno son los códigos de todos
los idiomas configurados en la librería de textos.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
ID de idioma determinada.
FALSE
Error.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Utilización
Esta función determina la tecla de acceso directo correspondiente a una acción.
Declaración
BOOL DMGetHotKey (
DWORD dwHotKeyAction,
LPDWORD lpdwHotKey,
LPCMN_ERROR lpdmError);
Parámetro
dwHotKeyAction
Acción
lpdwHotKey
Puntero al lugar de la memoria en que se almacena la tecla de acceso directo.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
ID de tecla de acceso directo determinada.
FALSE
Error.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Utilización
Con esta función una aplicación determina su parámetro de arranque en función del equipo.
No obstante, para ello la aplicación debe haber realizado previamente las correspondientes
entradas para las propiedades del equipo con las funciones del administrador de proyectos.
Declaración
BOOL DMGetMachineInfo (
LPCSTR lpszLogicalName,
LPVOID lpvData,
LPDWORD lpdwSize,
LPCMN_ERROR lpdmError);
Parámetro
lpszLogicalName
Puntero al nombre lógico de la DLL de Explorer cuyos parámetros de arranque se consultan.
lpvData
Puntero a un área de datos por la que se transfieren los datos del parámetro de arranque a
la aplicación.
lpdwSize
Si lpvData = 0, en lpdwSize se indica el tamaño del área de datos.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Información sobre el PC local determinada.
FALSE
Error.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Utilización
Esta función permite obtener, además del número de PCs implicados en el proyecto,
información acerca de PCs individuales.
Declaración
BOOL DMGetMachineTable (
LPCSTR lpszProjectFile,
LPDM_MACHINE_TABLE lpdmMachineTable,
LPCMN_ERROR lpdmError);
Parámetro
lpdwProjectFile
Puntero al nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto se determina con DMEnumOpenedProjects o en RT con
DMGetRuntimeProject.
lpdmMachineTable
Puntero a la estructura DM_MACHINE_TABLE (Página 221), en la que se depositan los datos
de la lista de equipos.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Datos de la lista de equipos determinados.
FALSE
Error.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
OnTestMachines (Página 492)"TESTCDoc.cpp"
Consulte también
DM_MACHINE_TABLE (Página 221)
OnTestMachines (Página 492)
DMActivateRTProject (Página 270)
Declaración
BOOL DMRemoveNotify (
DWORD dwNotifyCookie,
LPCMN_ERROR lpdmError);
Descripción
Borra una función Notify incorporada adicionalmente de la lista Notify adicional por medio de
su identificación de cookie.
Esta función está disponible a partir de la versión V7.2 de WinCC.
Parámetro
dwNotifyCookie
Cookie de una función Notify adicional incorporada con "DMAddNotify".
lpdmError
Puntero a los datos del aviso de error avanzado en la estructura "CMN_ERROR". En caso de
fallo, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Función Notify adicional eliminada.
FALSE
Error
Observaciones
Si se ejecuta "DMDisconnect" sin borrar antes las funciones Notify adicionales, vuelve a
enviarse al final un "DM_NOTIFY_SHUTDOWN" a todas estas funciones Notify, que se
borrarán entonces internamente con la administración. A continuación podrán desecharse la
conexión y las cookies, ya que dejan de ser válidas.
Mensajes de error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Funciones relacionadas
Ejemplos
Button RemoveNotify:
#include "apdefap.h"
void OnClick(char* lpszPictureName,
char* lpszObjectName,
char* lpszPropertyName)
{
RemoveNotify ();
}
Project-Function RemoveNotify:
void RemoveNotify()
{
DWORD dwNotifyCookie = 0L;
CMN_ERRORA err;
BOOL bRet = FALSE;
memset(&err, 0, sizeof(CMN_ERRORA));
dwNotifyCookie = GetTagDWord("DMdwNotifyCookie");
if (dwNotifyCookie)
{
bRet = DMRemoveNotify(dwNotifyCookie, &err);
if (bRet)
{
printf("\r\nNotify [%08lx] removed", dwNotifyCookie);
dwNotifyCookie = 0L;
SetTagDWord("DMdwNotifyCookie",dwNotifyCookie);
}
else
{
printf("\r\nERROR: DMRemoveNotifyA [%s],%ld,%ld,%ld,
%ld,%ld, Cookie=%08lx",
err.szErrorText,
err.dwError1,
err.dwError2,
err.dwError3,
err.dwError4,
err.dwError5,
dwNotifyCookie);
}
}
else
{
printf("\r\nNo Notify present to remove!");
}
}
Utilización
Llama para cada proyecto abierto en WinCC la función Callback transferida.
Declaración
BOOL DMEnumOpenedProjects (
LPDWORD lpdwItems,
DM_ENUM_OPENED_PROJECTS_PROC lpfnEnum,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Parámetro
lpdwItems
Puntero a una variable de palabra doble en la que se almacena el número de proyectos
abiertos tras finalizar la enumeración.
lpfnEnum
Puntero a la función Callback que recibe los datos del proyecto.
lpvUser
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Proyectos listados.
FALSE
Error.
Observaciones
Actualmente sólo se abre un proyecto en WinCC. Por tanto sólo se obtiene información acerca
de dicho proyecto.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Ejemplos
Enum open projects (Página 482)"DM01.cpp"
OnTestOpenProjects (Página 496)"TESTCDoc.cpp"
Consulte también
DM_ENUM_OPENED_PROJECTS_PROC (Página 307)
DM_PROJECT_INFO (Página 222)
Enum open projects (Página 482)
OnTestOpenProjects (Página 496)
DMChangeDataLocale (Página 278)
Descripción
Para poder evaluar los proyectos listados en el sistema, es preciso facilitar una función
Callback del tipo DM_ENUM_OPENED_PROJECTS_PROC.
Declaración
BOOL ( * DM_ENUM_OPENED_PROJECTS_PROC) (
LPDM_PROJECT_INFO lpInfo,
LPVOID lpvUser);
Parámetro
lpInfo
Puntero a una estructura del tipo DM_PROJECT_INFO (Página 222) con información sobre
un proyecto abierto.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
La enumeración continúa.
FALSE
La enumeración se cancela.
Observaciones
Actualmente sólo se puede abrir un proyecto en WinCC. Por tanto sólo se obtiene información
acerca de dicho proyecto.
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
dmclient.h
Funciones relacionadas
Ejemplos
Enum open projects "DM01.cpp"
Consulte también
DMEnumOpenedProjects (Página 306)
DM_PROJECT_INFO (Página 222)
Enum open projects (Página 482)
Utilización
Proporciona a la aplicación la ruta válida de los datos de configuración para el proyecto
transferido.
Declaración
BOOL DMGetProjectDirectory (
LPCSTR lpszAppName,
LPCSTR lpszProjectFile,
LPDM_DIRECTORY_INFO lpdmDirInfo,
LPCMN_ERROR lpdmError);
Parámetro
lpszAppName
Puntero al nombre de la aplicación para la que se determina la ruta.
lpszProjectFile
Puntero al nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto puede determinarse con DMEnumOpenedProjects.
lpdmDirInfo
Puntero a la estructura DM_DIRECTORY_INFO (Página 218), en la que se deposita la
indicación de la ruta de los datos de configuración.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Indicaciones de ruta determinadas.
FALSE
Error.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
OnTestProjectPaths (Página 494)"TESTCDoc.cpp"
Consulte también
DM_DIRECTORY_INFO (Página 218)
OnTestProjectPaths (Página 494)
Utilización
Determina información relevante sobre el proyecto transmitido como indicaciones de ruta,
Data Source Name, configuración del equipo, etc.
Declaración
BOOL DMGetProjectInformation (
LPCSTR lpszProjectFile,
LPDM_PROJECT_INFO lpProjectInfo,
LPCMN_ERROR lpdmError);
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto puede determinarse con DMEnumOpenedProjects o en
RT con DMGetRuntimeProject.
lpProjectInfo
Puntero a la estructura DM_PROJECT_INFO (Página 222), en la que debe depositarse la
información del proyecto.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Información del proyecto determinada
FALSE
Error
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
Inquire project informations (Página 488)"DM01.cpp"
OnTestProjectInfo (Página 492)"TESTCDoc.cpp"
Consulte también
DM_PROJECT_INFO (Página 222)
Inquire project informations (Página 488)
OnTestProjectInfo (Página 492)
Utilización
Proporciona el nombre de archivo del proyecto ubicado en el modo Online. Para determinar
tras la ejecución correcta todos los demás datos del proyecto, la aplicación que efectúa la
llamada recuerda el nombre de archivo del proyecto registrado en lpszProjectFile.
Declaración
BOOL DMGetRuntimeProject (
LPSTR lpszProjectFile,
DWORD dwBufSize,
LPCMN_ERROR lpdmError);
Parámetro
lpszProjectFile
Búfer para incluir el nombre del archivo de proyecto, ruta y extensión incluidas. El búfer debe
tener un tamaño mínimo de _MAX_PATH caracteres.
dwBufSize
El tamaño en caracteres del búfer transmitido.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Nombre del proyecto activado determinado.
FALSE
Error.
Observaciones
Entonces la llamada ya se ejecuta correctamente, cuando runtime arranca, pero no están
activados todos los componentes.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
Read tag (Página 516)"DM02.cpp"
Write tag (Página 521)"DM02.cpp"
OnTestRuntimeProject (Página 496)"TESTCDoc.cpp"
Consulte también
Read tag (Página 516)
Write tag (Página 521)
OnTestRuntimeProject (Página 496)
DMChangeDataLocale (Página 278)
Utilización
Abre el proyecto indicado en lpszProjectFile.
Declaración
BOOL DMOpenProjectDocPlus (
LPSTR lpszProjectFile,
LPCMN_ERROR lpdmError);
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto que hay que abrir, ruta y extensión incluidas.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Proyecto abierto.
FALSE
Error.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Utilización
Selecciona un archivo de proyecto en el diálogo de selección estándar del sistema. Si el
proyecto aún no está abierto en WinCC, se carga la información necesaria para el proyecto.
En una ejecución correcta, la aplicación que efectúa la llamada debe recordar el nombre de
archivo del proyecto registrado en lpszProjectFile para poder determinar todos los demás
datos del proyecto.
El nombre del archivo de proyecto también puede determinarse más adelante con
DMEnumOpenedProjects.
Declaración
BOOL DMOpenProjectPlus (
HWND hwndParent,
LPSTR lpszProjectFile,
DWORD dwBufSize,
LPCMN_ERROR lpdmError);
Parámetro
hwndParent
Handle en la ventana que se utiliza como ventana padre para el cuadro de diálogo.
lpszProjectFile
Puntero al búfer para incluir el nombre del archivo de proyecto, ruta y extensión incluidas. El
búfer debe tener un tamaño mínimo de _MAX_PATH caracteres.
En la llamada de la función, lpszProjectFile debe ser una string vacía o una ruta válida de un
proyecto existente.
Si lpszProjectFile es una string vacía, se llama el diálogo de selección estándar del sistema
(véase arriba).
Si lpszProjectFile no está vacío, WinCC interpreta que la cadena de caracteres que contiene
lpszProjectFile es la ruta del proyecto e intenta abrirla sin diálogo de selección.
El nombre de habilitación creado implícitamente en WinCC (p. ej. WinCC50_Project_Odk) no
puede utilizarse como ruta del proyecto, ya que sólo existe mientras el proyecto está abierto.
dwBufSize
El tamaño en caracteres del búfer transmitido.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Salir del cuadro de diálogo con "ACEPTAR".
FALSE
Error o salir del cuadro de diálogo con "CANCELAR"
Observaciones
El proceso de apertura de un proyecto puede tardar varios minutos.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
Open project by means of dialog (Página 515)"DM01.cpp"
OnTestOpenProject (Página 495)"TESTCDoc.cpp"
Consulte también
Open project by means of dialog (Página 515)
OnTestOpenProject (Página 495)
Utilización
Borra todas las entradas existentes en la cola de espera de notificaciones de la aplicación.
Declaración
BOOL DMClearBlockQueue (
LPCMN_ERROR lpdmError);
Parámetro
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Cola de espera de notificaciones borrada.
FALSE
Error.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Utilización
DMEnumDataServices llama la función Callback transferida para cada servicio instalado
mientras que la función Callback devuelva TRUE.
Declaración
BOOL DMEnumDataServices (
LPDWORD lpdwItems,
DM_ENUM_DATA_SERVICE_PROC lpfnEnum,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Parámetro
lpdwItems
Puntero a una variable de palabra doble de la aplicación que tras la llamada contiene la
cantidad de servicios enumerada.
lpfnEnum
Puntero a la función Callback que se llama para cada servicio instalado.
lpvUser
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Servicios listados.
FALSE
Error.
Comentario
Los punteros transferidos en la función Callback sólo tienen validez dentro de ella, ya que el
sistema vuelve a autorizar todas las posibles áreas de memoria asignadas tras el retorno de
la función. Si una aplicación requiere acceso externo a los datos, debe copiarlos
adecuadamente.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Consulte también
DM_ENUM_DATA_SERVICE_PROC (Página 319)
DMInstallDataService (Página 322)
Descripción
Para poder evaluar los canales de transporte de datos instalados listados en el sistema, es
preciso facilitar una función Callback del tipo DM_ENUM_DATA_SERVICE_PROC.
Declaración
BOOL ( * DM_ENUM_DATA_SERVICE_PROC) (
LPCSTR pszService,
DM_DATA_SERVICE_PROC pfnService,
LPVOID lpvUser);
Parámetro
pszService
Puntero al nombre lógico del canal de transporte de datos.
pfnService
Puntero a la función Callback del tipo DM_DATA_SERVICE_PROC (Página 320), en la que
se ponen a disposición más datos de un servicio.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
La enumeración continúa.
FALSE
La enumeración se cancela.
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
dmclient.h
Funciones relacionadas
Consulte también
DMEnumDataServices (Página 317)
DM_DATA_SERVICE_PROC (Página 320)
Descripción
Para que la aplicación pueda recibir datos, es preciso haber instalado un canal de transporte
de datos con DMInstallDataService y facilitar una función Callback del tipo
DM_DATA_SERVICE_PROC.
También se necesita una función Callback de este tipo, si se quieren evaluar los canales de
transporte (servicios) listados en el sistema.
Declaración
BOOL ( * DM_DATA_SERVICE_PROC) (
LPDM_DATA_SERVICE lpds,
LPVOID lpvUser);
Parámetro
lpds
Puntero a una estructura del tipo DM_DATA_SERVICE (Página 217) con información sobre
un canal de transporte de datos (servicio) instalado.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
Según el uso de la función Callback.
FALSE
Error
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Si un programa activa una rutina Notify, deberá vaciar periódicamente su cola de mensajes.
Los mensajes no recogidos pueden bloquear las notificaciones de WinCC y, con ello, todo
WinCC.
En algunos casos excepcionales puede ocurrir que se devuelva Notify antes de que retorne
la llamada de función.
Archivos necesarios
dmclient.h
Funciones relacionadas
Consulte también
DM_ENUM_DATA_SERVICE_PROC (Página 319)
DM_DATA_SERVICE (Página 217)
DMInstallDataService (Página 322)
Utilización
Con esta función una aplicación determina las entradas existentes en su cola de espera.
Declaración
BOOL DMGetNumPendingBlocks (
LONG *plEntries,
LPCMN_ERROR lpdmError);
Parámetro
plEntries
Contiene en una ejecución correcta de la función el número de paquetes de datos que hay
en la cola de espera de la aplicación.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Número de entradas de la cola de espera determinado.
FALSE
Error.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Utilización
Instala un canal de transporte (servicio) para transferir datos entre aplicaciones. La función
señaliza la disponibilidad de la aplicación para recibir datos que se envían desde cualquier
otra aplicación bajo el nombre del servicio indicado. Si ya se ha instalado un servicio con el
nombre transmitido, la función de rellamada instalada se sustituye por la transmitida. Si
lpfnService == NULL se elimina el servicio instalado con lpszService.
Declaración
BOOL DMInstallDataService (
LPCSTR lpszService,
DM_DATA_SERVICE_PROC lpfnService,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Parámetro
lpszService
Puntero al nombre del servicio. Con él, a partir de los nombres libres asignables, se lleva a
cabo la identificación del canal de transporte.
lpfnService
Puntero a una función Callback que es llamada cuando los datos de este servicio se envían
a la aplicación.
Si un programa inicia una rutina Notify, debe vaciar periódicamente su Message Queue. Los
mensajes no recogidos pueden bloquear las notificaciones de WinCC y, con ello, todo WinCC.
En algunos casos excepcionales puede incluso suceder que Notify ya se haya entregado
antes de que se devuelva la llamada de función.
lpvUser
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Canal de transporte de datos instalado.
FALSE
Error.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Consulte también
DMEnumDataServices (Página 317)
DM_DATA_SERVICE_PROC (Página 320)
Utilización
Los datos transmitidos en lpdmSendData se envían a todas las aplicaciones que
corresponden a las condiciones definidas en la estructura DM_SEND_DATA_STRUCT y han
instalado el servicio descrito en szService con DMInstallDataService.
Declaración
BOOL DMSendApplicationData (
LPDM_SEND_DATA_STRUCT lpdmSendData,
LPCMN_ERROR lpdmError);
Parámetro
lpdmSendData
Puntero a la estructura DM_SEND_DATA_STRUCT (Página 223).
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Datos enviados a la aplicación.
FALSE
Error.
Comentario
La función sólo se implementa localmente.
Los miembros existentes en la estructura DM_SEND_DATA_STRUCT para acceso remoto a
"TargetMachine" están reservados para futura ampliación.
dwTargetMachineFlags sólo puede estar ocupado con DM_SD_LOCAL ; cualquier otra
información produce errores y dwTargetMachines debe ser 0L.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Consulte también
DM_SEND_DATA_STRUCT (Página 223)
Utilización
Con la función se define el número máximo de mensajes que aparecen en la cola de espera
de notificaciones de la aplicación.
Declaración
BOOL DMSetBlockQueueSize (
LONG nCount,
LPCMN_ERROR lpdmError);
Parámetro
nCount
Número máximo de mensajes.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Tamaño de la cola de espera definido.
FALSE
Error.
Comentario
El valor estándar de la plataforma de 32 bits es de 1000 entradas, lo que suele ser suficiente.
Cada mensaje ocupa memoria en el espacio de direcciones de la aplicación. Se recomienda
evitar el aumento del número de mensajes, ya que implica un procesamiento más lento en la
aplicación.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Utilización
La función sirve para determinar datos acerca de objetos que están enlazados con una
variable, p. ej., grupo de variables correspondiente, unidad de canal, etc.
Declaración
BOOL DMEnumVarData (
LPCSTR lpszProjectFile,
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
DM_ENUM_VARIABLE_PROC lpfnEnum,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto se determina con DMEnumOpenedProjects o en RT con
DMGetRuntimeProject.
lpdmVarKey
Puntero al principio de un campo de estructuras del tipo DM_VARKEY (Página 242) sobre el
que deben especificarse las variables que hay que listar. Si a partir de la versión V5.0 de SP2
no se indica ninguna matriz y proporciona NULL, se enumeran todas las variables.
Si en DM_VARKEY se indica un nombre o un ID incorrecto, no hay ninguna indicación de
error ya que en una lista puede haber algunos válidos y algunos defectuosos. Para que el
usuario detecte una DM_VARKEY defectuosa, debe transmitir en Callback una estructura del
tipo DM_VARIABLE_DATA (Página 237) que esté completamente ocupada con 0.
dwItems
Número de las variables cuyos datos se listan (= número de especificaciones de variables en
lpdmVarKey). Si el número se pone a 0, se enumeran todas las variables.
lpfnEnum
Puntero a la función Callback que recibe la información de una variable.
lpvUser
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Información sobre variables listada.
FALSE
Error
Comentario
Hay una función más avanzada: DMEnumVarData4.
Nota
Las implementaciones existentes de una enumeración multietapa de DMEnumVariables con
la llamada de DMEnumVarDataX en la función Callback para cada uno de los elementos debe
sustituirse por una llamada individual de DMEnumVarData4. Los filtros necesarios se llevan
a cabo en la propia función Callback. El cambio mejora el rendimiento considerablemente.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Consulte también
DM_VARKEY (Página 242)
DM_VARIABLE_DATA (Página 237)
DM_ENUM_VARIABLE_PROC (Página 328)
Descripción
Para poder evaluar la información de una variable listada en el sistema, es preciso facilitar
una función Callback del tipo DM_ENUM_VARIABLE_PROC.
Declaración
BOOL ( * DM_ENUM_VARIABLE_PROC) (
LPDM_VARKEY lpdmVarKey,
LPDM_VARIABLE_DATA lpdmVarData,
LPVOID lpvUser
Parámetro
lpdmVarKey
Puntero a una estructura del tipo DM_VARKEY (Página 242) para especificar las variables
que hay que listar.
lpdmVarData
Puntero a una estructura del tipo DM_VARIABLE_DATA (Página 237) con información sobre
una variable.
Si la estructura está completamente ocupada con 0, en DM_VARKEY se ha indicado un
nombre o un ID incorrecto. Es posible consultar, p. ej., con lpdmVarData->dmTypeRef-
>dwType.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
La enumeración continúa.
FALSE
La enumeración se cancela
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
dmclient.h
Funciones relacionadas
Consulte también
DM_VARKEY (Página 242)
DM_VARIABLE_DATA (Página 237)
DMEnumVarData (Página 326)
Utilización
La función sirve para determinar datos acerca de objetos enlazados con una variable, p. ej.,
grupo de variables correspondiente o unidad de canal.
Se diferencia de DMEnumVarData por la salida adicional de los datos de escala.
Declaración
BOOL DMEnumVarData4 (
LPCSTR lpszProjectFile,
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
DM_ENUM_VARIABLE_PROC4 lpfnEnum,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto se determina con DMEnumOpenedProjects o en RT con
DMGetRuntimeProject.
lpdmVarKey
Puntero al principio de un campo de estructuras del tipo DM_VARKEY (Página 242) sobre el
que deben especificarse las variables que hay que listar. Si el parámetro proporciona NULL,
se enumeran todas las variables.
Si en DM_VARKEY se indica un nombre o un ID incorrecto, no hay ninguna indicación de
error ya que en una lista puede haber algunos válidos y algunos defectuosos. Para que el
usuario detecte una DM_VARKEYdefectuosa, debe transmitir en Callback una estructura del
tipo DM_VARIABLE_DATA4 (Página 239) que esté completamente ocupada con 0.
dwItems
Número de las variables cuyos datos deben listarse (= número de especificaciones de
variables en lpdmVarKey). Si el número está puesto a 0, se enumeran todas las variables.
lpfnEnum
Puntero a la función Callback que recibe la información de una variable.
lpvUser
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Información sobre variables listada.
FALSE
Error.
Comentario
Nota
Las implementaciones existentes de una enumeración multietapa de DMEnumVariables con
la llamada de DMEnumVarDataX en la función Callback para cada uno de los elementos debe
sustituirse por una llamada individual de DMEnumVarData4. Los filtros necesarios se llevan
a cabo en la propia función Callback. El cambio mejora el rendimiento considerablemente.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Ejemplos
Enum Data of Tags (Página 480)"DM01.cpp"
Consulte también
DM_VARKEY (Página 242)
DM_VARIABLE_DATA4 (Página 239)
DM_ENUM_VARIABLE_PROC4 (Página 332)
Enum Data of Tags (Página 480)
Descripción
Para poder evaluar la información de una variable listada en el sistema, es preciso facilitar
una función Callback del tipo DM_ENUM_VARIABLE_PROC4. Esta función Callback se
diferencia de DM_ENUM_VARIABLE_PROC por la salida adicional de los datos de escala
Declaración
BOOL ( * DM_ENUM_VARIABLE_PROC4) (
LPDM_VARKEY lpdmVarKey,
LPDM_VARIABLE_DATA4 lpdmVarData,
LPVOID lpvUser
Parámetro
lpdmVarKey
Puntero a una estructura del tipo DM_VARKEY (Página 242) para especificar las variables
que hay que listar.
lpdmVarData
Puntero a una estructura del tipo DM_VARIABLE_DATA4 (Página 239) con información sobre
una variable.
Si la estructura está completamente ocupada con 0, en DM_VARKEY se ha indicado un
nombre o un ID incorrecto. Es posible consultar, p. ej., con lpdmVarData->dmTypeRef-
>dwType.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
La enumeración continúa.
FALSE
La enumeración se cancela.
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
dmclient.h
Funciones relacionadas
Ejemplos
Enum Data of Tags (Página 480)"DM01.cpp"
Consulte también
DMEnumVarData4 (Página 330)
DM_VARKEY (Página 242)
DM_VARIABLE_DATA4 (Página 239)
Enum Data of Tags (Página 480)
Utilización
La función proporciona la información acerca del grupo de variables mediante la función
Callback DM_ENUM_VARGRP_PROC, p. ej., nombre, CreatorID y número de variables en el
grupo.
Declaración
BOOL DMEnumVarGrpData (
LPSTR lpszProjectFile,
LPDM_VARGRPKEY lpdmVarGrpKey,
DWORD dwItems,
DM_ENUM_VARGRP_PROC lpfnEnum,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto se determina con DMEnumOpenedProjects o en RT con
DMGetRuntimeProject.
lpdmVarGrpKey
Puntero a la primera estructura del tipo DM_VARGRPKEY (Página 236) ,en la que se
especifica el grupo de variables.
dwItems
Número de grupos de variables cuyos datos se listan.
lpfnEnum
Puntero a la función Callback que recibe la información de un grupo de variables.
lpvUser
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Información de un grupo de variables listada.
FALSE
Error.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Ejemplos
OnTestEnumGroupsAll (Página 489)"TESTCDoc.cpp"
Consulte también
DM_VARGRPKEY (Página 236)
DM_ENUM_VARGRP_PROC (Página 337)
OnTestEnumGroupsAll (Página 489)
Declaración
BOOL DMEnumVarGrpDataExStr (
LPTSTR lpszProjectFile,
DWORD dwFlags,
LPVARIANT lpvdmVarGrpKey,
LPDWORD lpdwVarGrpCount,
DM_ENUM_VARGRP_PROC_EXSTR lpfnEnum,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Descripción
La función proporciona información acerca de los grupos de variables mediante la función
Callback "DM_ENUM_VARGRP_PROC_EXSTR", p. ej., nombre, ID y número de variables en
el grupo.
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto con ruta y extensión.
El nombre del archivo de proyecto puede determinarse con "DMEnumOpenedProjects" o en
runtime con "DMGetRuntimeProject".
dwFlags
Reservado para uso futuro. Debe ajustarse con "0L".
lpvdmVarGrpKey
Puntero a la primera de las estructuras del tipo "DM_VARGRPKEY" mediante la que se
especifican los grupos de variables.
Puntero a un VARIANT para la lista de grupos de variables. La lista debe crearse como
"VT_ARRAY | VT_VARIANT", ya que se indican diferentes tipos de datos mezclados como
"VT_I4", "VT_BSTR" y, bajo ciertas condiciones, también "VT_LPSTR". También puede
crearse un VARIANT sencillo si solo se indica una clave.
Si aquí se indica "NULL" o "VT_EMPTY", se enumeran todos los grupos.
lpdwVarGrpCount
Puntero a "DWORD" para el número de grupos de variables.
Con "lpfnCallback = NULL", primero se determina cuánta memoria se necesita para los grupos
de variables.
lpfnEnum
Puntero a la función Callback que recibe información de un grupo de variables.
lpvUser
Puntero a datos específicos de la aplicación. El puntero no es evaluado por la función, sino
que vuelve a ponerse a disposición en la función Callback.
lpdmError
Puntero a los datos del aviso de error avanzado en la estructura "CMN_ERROR". En caso de
fallo, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Información del grupo de variables listada
FALSE
Error
Mensajes de error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Funciones relacionadas
Descripción
Para poder evaluar la información de un grupo de variables listada en el sistema, es preciso
facilitar una función Callback del tipo DM_ENUM_VARGRP_PROC.
Declaración
BOOL ( * DM_ENUM_VARGRP_PROC) (
LPDM_VARGRP_DATA lpdmVarGrpData,
LPVOID lpvUser);
Parámetro
lpdmVarGrpData
Puntero a una estructura del tipo DM_VARGRP_DATA (Página 235) con información sobre
el grupo de variables.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
La enumeración continúa.
FALSE
La enumeración se cancela.
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
dmclient.h
Funciones relacionadas
Consulte también
DMEnumVarGrpData (Página 334)
DM_VARGRP_DATA (Página 235)
Utilización
Con la función se listan los nombres de todas las variables que se corresponden con un criterio
de selección determinado. El criterio de selección se define en la estructura DM_VARFILTER .
Declaración
BOOL DMEnumVariables (
LPCSTR lpszProjectFile,
LPDM_VARFILTER lpdmVarFilter,
DM_ENUM_VAR_PROC lpfnEnum,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto se determina con DMEnumOpenedProjects o en RT con
DMGetRuntimeProject.
lpdmVarFilter
Puntero a la estructura DM_VARFILTER (Página 233), en la que se depositan los criterios de
selección.
lpfnEnum
Puntero a la función Callback que recibe los nombres de variable.
lpvUser
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Nombres de variable listados.
FALSE
Error.
Comentario
Nota
Las implementaciones existentes de una enumeración multietapa de DMEnumVariables con
la llamada de DMEnumVarDataX en la función Callback para cada uno de los elementos debe
sustituirse por una llamada individual de DMEnumVarData4. Los filtros necesarios se llevan
a cabo en la propia función Callback. El cambio mejora el rendimiento considerablemente.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Ejemplos
OnTestEnumVariables (Página 490)"TESTCDoc.cpp"
Consulte también
DM_VARFILTER (Página 233)
DM_ENUM_VAR_PROC (Página 340)
OnTestEnumVariables (Página 490)
Descripción
Para poder evaluar los nombres de variable listados en el sistema, es preciso facilitar una
función Callback del tipo DM_ENUM_VAR_PROC.
Declaración
BOOL ( * DM_ENUM_VAR_PROC) (
LPDM_VARKEY lpdmVarKey,
LPVOID lpvUser
Parámetro
lpdmVarKey
Puntero a una estructura del tipo DM_VARKEY (Página 242) con el nombre de una variable.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
Son deseables más llamadas Callback.
FALSE
La serie Callback debe cancelarse.
Observación
ATENCIÓN
No se debe llamar ninguna otra función de DMClient en este Callback, ya que de lo contrario
se puede producir un bloqueo.
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
dmclient.h
Funciones relacionadas
Consulte también
DM_VARKEY (Página 242)
DMEnumVariables (Página 338)
Utilización
Lee el valor de una o varias variables de la memoria imagen de proceso del administrador de
datos. Se lee el valor que presentaba en el momento de la última actualización.
La función DMGetValueEx más avanzada, además proporciona en la estructura
DM_VAR_UPDATE_STRUCTEX el Quality Code.
Declaración
BOOL DMGetValue (
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
LPDM_VAR_UPDATE_STRUCT lpdmvus,
LPCMN_ERROR lpdmError);
Parámetro
lpdmVarKey
Puntero a la primera de las estructuras DM_VARKEY (Página 242) que identifican los valores
de las variables que hay que leer.
dwItems
Número de estructuras transmitidas (equivale al número de valores de variables por leer).
lpdmvus
Puntero a la primera de las estructuras DM_VAR_UPDATE_STRUCT (Página 228) que tras
el retorno de la función contienen los valores de variable.
lpdmError
Puntero a la primera estructura de error dwItems del tipo CMN_ERROR. Si aparece un error
al escribir una variable, el sistema escribe la información de error en la estructura
correspondiente. No hay que olvidar reservar espacio para estas estructuras.
Valor de retorno
TRUE
Valores determinados.
FALSE
Error.
Comentario
Para, p. ej., darle a una aplicación la posibilidad de administrar los ciclos por separado, se
indica en DMStartVarUpdate un puntero NULL como función Callback. A continuación el
administrador de datos aplica la actualización de la variable al ciclo solicitado, sin embargo
deja a la aplicación la responsabilidad sobre el cálculo de tiempo de lectura de la memoria
imagen de proceso.
Dado que puede haber solicitudes de actualización para una variable de varias aplicaciones
en diferentes ciclos, el administrador de datos siempre toma como base el ciclo más pequeño
solicitado para actualizar su memoria imagen de proceso.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
DMGetValueWait (Página 355) Determinar los valores de las variables con actua‐
lización
DMSetValue (Página 386) Modificar valores de variables
Ejemplos
Read tag (Página 516)"DM02.cpp"
OnTestVariablenGetvalue (Página 500)"TESTCDoc.cpp"
Consulte también
DM_VARKEY (Página 242)
DM_VAR_UPDATE_STRUCT (Página 228)
DMGetValueWait (Página 355)
DMSetValue (Página 386)
Read tag (Página 516)
OnTestVariablenGetvalue (Página 500)
Utilización
Lee el valor de una o varias variables de la memoria imagen de proceso del administrador de
datos. Se lee el valor que presentaba en el momento de la última actualización.
A diferencia de DMGetValue, en la estructura DM_VAR_UPDATE_STRUCTEX también se
devuelve el Quality Code.
Declaración
BOOL DMGetValueEx (
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
LPDM_VAR_UPDATE_STRUCTEX lpdmvus,
LPCMN_ERROR lpdmError);
Parámetro
lpdmVarKey
Puntero a la primera de las estructuras DM_VARKEY (Página 242) que identifican los valores
de las variables que hay que leer.
dwItems
Número de estructuras transmitidas (equivale al número de valores de variables por leer).
lpdmvus
Puntero a la primera de las estructuras DM_VAR_UPDATE_STRUCTEX (Página 230) que
tras el retorno de la función contienen los valores de variable.
lpdmError
Puntero a la primera estructura de error dwItems del tipo CMN_ERROR. Si aparece un error
al escribir una variable, el sistema escribe la información de error en la estructura
correspondiente. No hay que olvidar reservar espacio para estas estructuras.
Valor de retorno
TRUE
Valores determinados.
FALSE
Error.
Comentario
Para, p. ej., darle a una aplicación la posibilidad de administrar los ciclos por separado, puede
indicarse en DMStartVarUpdate un puntero NULL como función Callback. A continuación el
administrador de datos aplica la actualización de la variable al ciclo solicitado, sin embargo
deja a la aplicación la responsabilidad sobre el cálculo de tiempo de lectura de la memoria
imagen de proceso.
Dado que puede haber solicitudes de actualización para una variable de varias aplicaciones
en diferentes ciclos, el administrador de datos siempre toma como base el ciclo más pequeño
solicitado para actualizar su memoria imagen de proceso.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
DMGetValueWait (Página 355) Determinar los valores de las variables con actua‐
lización
DMSetValue (Página 386) Modificar valores de variables
Consulte también
DM_NOTIFY_VARIABLEEX_PROC (Página 470)
DM_VAR_UPDATE_STRUCTEX (Página 230)
DM_VARKEY (Página 242)
DMGetValueWait (Página 355)
DMSetValue (Página 386)
DMGetValueWaitEx (Página 357)
Declaración
BOOL DMGetValueExStr (
DWORD dwFlags,
LPVARIANT lpdmVarKey,
LPDM_VAR_UPDATE_STRUCT_EXSTR lpdmvus,
DWORD dwdmvusCount,
LPCMN_ERROR lpdmError);
Descripción
Lee el valor de una o varias variables de la memoria imagen de proceso del administrador de
datos. Se lee el valor que presentaba en el momento de la última actualización.
A diferencia de "DMGetValueEx", ya no se utiliza más la estructura "DM_VARKEY" para que
no haya ninguna limitación de longitud en el nombre de variable.
Parámetro
dmFlags
Si se necesita un retorno del nombre de variable en el VARIANT de la estructura
"DM_VAR_UPDATE_STRUCT_EXSTR" en formato "VT_LPSTR", aquí puede especificarse
el indicador "DM_FLAG_RETURN_PROPVARIANT_VT_LPSTR".
lpvdmVarKey
Puntero a un VARIANT para la lista de variables. La lista debe crearse como "VT_ARRAY |
VT_VARIANT", ya que puede haber diferentes tipos de datos como "VT_I4", "VT_BSTR" y,
bajo ciertas condiciones, también "VT_LPSTR". Esto también vale para una única clave.
lpdmvus
Puntero a la primera de las estructuras "DM_VAR_UPDATE_STRUCT_EXSTR" que
contienen los valores de las variables tras el retorno de la función.
dwdmvusCount
Número de estructuras "DM_VAR_UPDATE_STRUCT_EXSTR" transferidas (equivale al
número de valores de variables por leer). El número debe coincidir con el tamaño de la matriz
Variant en "lpvdmVarKey".
lpdmError
Puntero a la primera de las estructuras de error "dwdmvusCount" del tipo "CMN_ERROR". Si
se produce un error al escribir una variable, el sistema escribe la información de error en la
estructura correspondiente. No hay que olvidar reservar espacio para estas estructuras.
Valor de retorno
TRUE
Valores determinados
FALSE
Error
Observación
Para, p. ej., darle a una aplicación la posibilidad de administrar los ciclos por separado, puede
indicarse en "DMStartVarUpdate" un puntero "NULL" como función Callback. A continuación,
el administrador de datos aplica la actualización de la variable al ciclo solicitado, sin embargo
deja a la aplicación la responsabilidad sobre el cálculo de tiempo de lectura de la memoria
imagen de proceso.
Dado que puede haber solicitudes de actualización para una variable por parte de varias
aplicaciones en diferentes ciclos, el administrador de datos siempre toma como base el ciclo
más pequeño solicitado para actualizar su memoria imagen de proceso.
Mensajes de error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Funciones relacionadas
Ejemplos
Ejemplo de script "Button DMGetValueExStr/DMSetValueExStr|DMGetValueWaitExStr/
DMSetValueWaitExStr":
#include "apdefap.h"
void OnClick(char* lpszPictureName, char* lpszObjectName, char*
lpszPropertyName)
{
#pragma code ("kernel32.dll")
#define CP_ACP 0
int MultiByteToWideChar(UINT CodePage, DWORD dwFlags, LPCSTR
lpMultiByteStr, int cbMultiByte, LPWSTR lpWideCharStr, int
cchWideChar);
int WideCharToMultiByte(UINT CodePage, DWORD dwFlags, LPCWSTR
lpWideCharStr, int cchWideChar, LPSTR lpMultiByteStr, int
cbMultiByte, LPCSTR lpDefaultChar, LPBOOL lpUsedDefaultChar);
#pragma code()
VARIANT vVarKey;
VARIANT* pvElem;
VARIANT vdmValue;
SAFEARRAY* parrayKeys;
SAFEARRAY* parrayValues;
DWORD dwVal[4];
DWORD dwState[4];
DWORD dwMerk;
CMN_ERROR err;
CMN_ERROR errArray[4];
DM_VAR_UPDATE_STRUCT_EXSTR dmvus[4];
HRESULT hr;
long lInx;
BOOL bRet;
DWORD dwFlags;
DWORD* pdwVarState;
DWORD dwTAID;
memset(&err, 0, sizeof(err));
memset(dmvus, 0, sizeof(dmvus));
dwVal[0] = 1;
dwVal[1] = 2;
dwVal[2] = 3;
dwVal[3] = 4;
dwMerk = 0L;
memset(dwState, 0, sizeof(dwState));
pvElem = NULL;
parrayKeys = NULL;
parrayValues = NULL;
hr = 0L; //S_OK
lInx = 0L;
bRet = FALSE;
dwFlags = DM_FLAG_RETURN_PROPVARIANT_VT_LPSTR;
pdwVarState = dwState;
dwTAID = 0L;
VariantInit(&vVarKey);
parrayKeys = SafeArrayCreateVector(VT_VARIANT, 0L, 4);
vVarKey.vt = VT_ARRAY | VT_VARIANT;
vVarKey.u.parray = parrayKeys;
SafeArrayLock(parrayKeys);
lInx = 0L;
hr = SafeArrayPtrOfIndex(parrayKeys, &lInx, &pvElem);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = "dwVal_1";
lInx = 1L;
hr = SafeArrayPtrOfIndex(parrayKeys, &lInx, &pvElem);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = "dwVal_2";
lInx = 2L;
hr = SafeArrayPtrOfIndex(parrayKeys, &lInx, &pvElem);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = "dwVal_3";
lInx = 3L;
hr = SafeArrayPtrOfIndex(parrayKeys, &lInx, &pvElem);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = "dwVal_4";
SafeArrayUnlock(parrayKeys);
printf("\r\ncall DMGetValueExStr:");
bRet = DMGetValueExStr(dwFlags, &vVarKey, dmvus, 4L, &err);
if (bRet == FALSE)
{
printf("\r\n error DMGetValueExStr, err=%ld,%ld,%ld,%ld,%ld,
[%s]",
err.dwError1, err.dwError2, err.dwError3, err.dwError4,
err.dwError5, err.szErrorText);
}
else
{
int i = 0;
for (i = 0; i < 4; i++)
{
hr = VariantChangeType((VARIANTARG*)&(dmvus[i].vdmValue),
(VARIANTARG*)&(dmvus[i].vdmValue), 0, VT_I4);
if (hr)
{
VariantInit(&vdmValue);
parrayValues = SafeArrayCreateVector(VT_VARIANT, 0L, 4);
vdmValue.vt = VT_ARRAY | VT_VARIANT;
vdmValue.u.parray = parrayValues;
SafeArrayLock(parrayValues);
lInx = 0L;
hr = SafeArrayPtrOfIndex(parrayValues, &lInx, &pvElem);
pvElem->vt = VT_I4;
pvElem->u.pbVal = dwVal[0];
lInx = 1L;
printf("\r\ncall DMSetValueExStr:");
memset(&err, 0, sizeof(err));
bRet = DMSetValueExStr(&vVarKey, &vdmValue, pdwVarState, &err);
if (bRet == FALSE)
{
printf("\r\n error DMSetValueExStr, err=%ld,%ld,%ld,%ld,%ld,
[%s]",
err.dwError1, err.dwError2, err.dwError3, err.dwError4,
err.dwError5, err.szErrorText);
}
else
{
int i = 0;
for (i = 0; i < 4; i++)
{
printf("\r\n dwVarState[%d] = %ld", i, dwState[i]);
}
}
printf("\r\ncall DMGetValueWaitExStr:");
memset(&err, 0, sizeof(err));
bRet = DMGetValueWaitExStr(&dwTAID, dwFlags, &vVarKey, TRUE, 2000,
DM_NotifyVariableProcExStr_GetValueWait, dwVal, &err);
if (bRet == FALSE)
{
printf("\r\n error DMGetValueWaitExStr, err=%ld,%ld,%ld,%ld,%ld,
[%s]",
err.dwError1, err.dwError2, err.dwError3, err.dwError4,
err.dwError5, err.szErrorText);
}
else
{
int i = 0;
for (i = 0; i < 4; i++)
{
printf("\r\n dwValue[%d] = %ld", i, dwVal[i]);
}
}
printf("\r\ncall DMSetValueWaitExStr:");
memset(errArray, 0, sizeof(errArray));
bRet = DMSetValueWaitExStr(&dwTAID, &vVarKey, 4, &vdmValue,
pdwVarState, 2000, DM_CompletitionProc, NULL, errArray);
if (bRet == FALSE)
{
int i = 0;
for(i=0; i < 4; i++)
{
printf("\r\n error DMSetValueWaitExStr, errArray[%d]=%ld,
%ld,%ld,%ld,%ld,[%s]",
i, errArray[i].dwError1, errArray[i].dwError2,
errArray[i].dwError3,
errArray[i].dwError4, errArray[i].dwError5,
errArray[i].szErrorText);
}
}
else
{
}
pdwVal = (DWORD*)lpvUser;
// the DMGetValueWait used PROPVARIANT and the lpvUser is ptr to
OutDataArray (DWORDS)
printf("\r\n*** DM_NotifyVariableProcExStr_GetValueWait entry ***");
Project-Function DM_CompletitionProc:
return bRet;
}
Utilización
Lee el valor de una o varias variables de la memoria imagen de proceso del administrador de
datos. Se lee el valor que presentaba en el momento de la última actualización.
A diferencia de DMGetValue, esta función fuerza una actualización de los valores de las
variables en base al valor.
La función DMGetValueWaitEx más avanzada, además proporciona en la estructura
DM_VAR_UPDATE_STRUCTEX de la función Callback DM_NOTIFY_VARIABLEEX_PROC
el Quality Code.
Declaración
BOOL DMGetValueWait (
LPDWORD pdwTAID,
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
BOOL fWaitForCompletition,
DWORD dwTimeOut,
DM_NOTIFY_VARIABLE_PROC lpfnVariable,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Parámetro
pdwTAID
Puntero a una variable que, tras una correcta llamada de la función, contiene la ID de
transacción asignada por el administrador de datos.
lpdmVarKey
Puntero a la primera de las estructuras DM_VARKEY (Página 242) que identifican los valores
de las variables que hay que leer.
dwItems
Número de estructuras transmitidas (equivale al número de valores de variables por leer).
fWaitForCompletition
Si el indicador fWaitForCompletition está activado, la función Callback transmitida sólo es
llamada cuando todas las variables solicitadas están actualizadas o se ha excedido el tiempo
timeout.
Si fWaitForCompletition no está activado, la función Callback transmitida es llamada
inmediatamente. El comportamiento temporal equivale a la función DMGetValue.
dwTimeout
Tiempo de espera máximo de la aplicación en ms. Si una vez transcurrido el tiempo de espera
no se han actualizado todos los valores de las variables, la función Callback es llamada con
los códigos de error correspondientes.
Si el indicador fWaitForCompletition == FALSE, el valor transmitido no se evalúa.
lpfnVariable
Puntero a la función Callback DM_NOTIFY_VARIABLE_PROC que se llama después de
actualizar todas las variables solicitadas o una vez transcurrido el tiempo de espera.
Si fWaitForCompletition == FALSE, la función Callback es llamada inmediatamente con los
valores que hay en ese momento en la memoria imagen de proceso del administrador de
datos.
Si un programa inicia una rutina Notify, debe vaciar periódicamente su Message Queue. Los
mensajes no recogidos pueden bloquear las notificaciones de WinCC y, con ello, todo WinCC.
En algunos casos excepcionales puede incluso suceder que Notify ya se haya entregado
antes de que se devuelva la llamada de función.
lpvUser
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Valores determinados.
FALSE
Error.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
DM_NOTIFY_VARIABLE_PROC (Página 459) Determinar los valores de las variables con actua‐
lización (Callback)
DMGetValue (Página 342) Determinar valores de variables
DMGetValueWaitEx (Página 357) Determinar los valores de las variables con actua‐
lización
AUTOHOTSPOT Modificar valores de variables con aviso
Ejemplos
OnTestVariablenGetvaluewait (Página 503)"TESTCDoc.cpp"
Consulte también
DM_NOTIFY_VARIABLE_PROC (Página 459)
DM_VARKEY (Página 242)
DMGetValue (Página 342)
DMGetValueEx (Página 344)
DMSetValueWait (Página 395)
OnTestVariablenGetvaluewait (Página 503)
DMGetValueWaitEx (Página 357)
Utilización
Lee el valor de una o varias variables de la memoria imagen de proceso del administrador de
datos. Se lee el valor que presentaba en el momento de la última actualización.
A diferencia de DMGetValueEx, con esta función se fuera una actualización de los valores de
las variables en base al valor.
Declaración
BOOL DMGetValueWaitEx (
LPDWORD pdwTAID,
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
BOOL fWaitForCompletition,
DWORD dwTimeOut,
DM_NOTIFY_VARIABLEEX_PROC lpfnVariable,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Parámetro
pdwTAID
Puntero a una variable que, tras una correcta llamada de la función, contiene la ID de
transacción asignada por el administrador de datos.
lpdmVarKey
Puntero a la primera de las estructuras DM_VARKEY (Página 242) que identifican los valores
de las variables que hay que leer.
dwItems
Número de estructuras transmitidas (equivale al número de valores de variables por leer).
fWaitForCompletition
Si el indicador fWaitForCompletition está activado, la función Callback transmitida sólo es
llamada cuando todas las variables solicitadas están actualizadas o se ha excedido el tiempo
timeout.
Si fWaitForCompletition no está activado, la función Callback transmitida es llamada
inmediatamente. El comportamiento temporal equivale a la función DMGetValue.
dwTimeout
Tiempo de espera máximo de la aplicación en ms. Si una vez transcurrido el tiempo de espera
no se han actualizado todos los valores de las variables, la función Callback es llamada con
los códigos de error correspondientes.
Si el indicador fWaitForCompletition == FALSE, el valor transmitido no se evalúa.
lpfnVariable
Puntero a la función Callback DM_NOTIFY_VARIABLEEX_PROC que se llama después de
actualizar todas las variables solicitadas o una vez transcurrido el tiempo de espera.
Si fWaitForCompletition == FALSE, la función Callback es llamada inmediatamente con los
valores que hay en ese momento en la memoria imagen de proceso del administrador de
datos.
Si un programa inicia una rutina Notify, debe vaciar periódicamente su Message Queue. Los
mensajes no recogidos pueden bloquear las notificaciones de WinCC y, con ello, todo WinCC.
En algunos casos excepcionales puede incluso suceder que Notify ya se haya entregado
antes de que se devuelva la llamada de función.
lpvUser
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Valores determinados.
FALSE
Error.
Funciones utilizadas
DM_NOTIFY_VARIABLEEX_PROC (Página 470) Determinar los valores de las variables con notifi‐
cación (Callback)
DMGetValueEx (Página 344) Determinar valores de variables
DMSetValueWait (Página 395) Modificar valores de variables con aviso
Consulte también
DM_NOTIFY_VARIABLEEX_PROC (Página 470)
DMGetValueWait (Página 355)
DM_VARKEY (Página 242)
DMGetValueEx (Página 344)
DMSetValueWait (Página 395)
Declaración
BOOL DMGetValueWaitExStr (
LPDWORD pdwTAID,
DWORD dwFlags
LPVARIANT lpvdmVarKey,
LPVARIANT lpvCookie,
BOOL fWaitForCompletition,
DWORD dwTimeOut,
DM_NOTIFY_VARIABLE_PROC_EXSTR lpfnVariable,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Descripción
Lee el valor de una o varias variables de la memoria imagen de proceso del administrador de
datos. Se lee el valor que presentaba en el momento de la última actualización.
A diferencia de "DMGetValueExStr", con esta función puede forzarse una actualización de los
valores de las variables.
Parámetro
pdwTAID
Puntero a una variable que, tras una correcta llamada de la función, contiene la ID de
transacción asignada por el administrador de datos.
dwFlags
Si se necesita un retorno del nombre de variable en el VARIANT de la estructura
"DM_VAR_UPDATE_STRUCT_EXSTR" de "DM_NOTIFY_VARIABLE_PROC_EXSTR" en
formato "VT_LPSTR", aquí puede especificarse el indicador
"DM_FLAG_RETURN_PROPVARIANT_VT_LPSTR".
lpvdmVarKey
Puntero a un VARIANT para la lista de variables. La lista debe crearse como "VT_ARRAY |
VT_VARIANT", ya que puede haber diferentes tipos de datos como "VT_I4", "VT_BSTR" y,
bajo ciertas condiciones, también "VT_LPSTR".
lpvCookie
Puntero a un VARIANT para una lista adicional de datos específicos de usuario para cada
variable.
Está pensado para sustituir "lpvUserData" del anterior "DM_VARKEY" y se devuelve también
en la estructura "DM_VAR_UPDATE_STRUCT_EXSTR" para cada variable.
fWaitForCompletition
Si "fWaitForCompletition" está activado, la función Callback transmitida solo se llama cuando
todas las variables solicitadas están actualizadas o se ha excedido el tiempo timeout indicado.
Si "fWaitForCompletition" no está activado, la función Callback transmitida se llama
inmediatamente. El comportamiento temporal equivale al de la función "DMGetValueExStr".
dwTimeout
Tiempo de espera máximo de la aplicación en "ms". Si una vez transcurrido el tiempo de
espera no se han actualizado todos los valores de las variables, la función Callback es llamada
con los códigos de error correspondientes.
Con "fWaitForCompletition == FALSE", no se evalúa el valor transferido.
lpfnVariable
Puntero a la función Callback "DM_NOTIFY_VARIABLEEX_PROC_EXSTR" que se llama
después de actualizar todas las variables solicitadas o una vez transcurrido el tiempo de
espera.
Con "fWaitForCompletition == FALSE", la función Callback se llama inmediatamente con los
valores que hay en ese momento en la memoria imagen de proceso del administrador de
datos.
Si un programa activa una rutina Notify, deberá vaciar periódicamente su cola de mensajes.
Los mensajes no recogidos pueden bloquear las notificaciones de WinCC y, con ello, todo
WinCC.
En algunos casos excepcionales puede ocurrir que se suministre Notify antes de que retorne
la llamada de función.
lpvUser
Puntero a datos específicos de la aplicación. El puntero no es evaluado por la función, sino
que vuelve a ponerse a disposición en la función Callback.
lpdmError
Puntero a los datos del aviso de error avanzado en la estructura "CMN_ERROR". En caso de
fallo, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Valores determinados
FALSE
Error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Funciones relacionadas
Ejemplos
Encontrará ejemplos en la página de "DMGetValueExStr".
Utilización
DMGetVarInfo determina la clave completa de una variable. Esta orden permite obtener el
nombre de variable de una ID de variable y viceversa.
Declaración
BOOL DMGetVarInfo (
LPCSTR lpszProjectFile,
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
LPCMN_ERROR lpdmError);
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto se determina con DMEnumOpenedProjects o en RT con
DMGetRuntimeProject.
lpdmVarKey
Puntero a la estructura DM_VARKEY (Página 242) con las claves de variable que se
completan.
dwItems
Número de estructuras transmitidas.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Clave de variable determinada.
FALSE
Error.
Comentario
No alterne la llamada con llamadas para crear variables. Si DMGetVarInfo se utiliza por
primera vez tras crear una variable, se reordenan las listas de búsqueda, lo que ocupa más
tiempo de ejecución.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
OnTestVariablenGetVarInfo (Página 507)"TESTCDoc.cpp"
Consulte también
DM_VARKEY (Página 242)
OnTestVariablenGetVarInfo (Página 507)
Declaración
BOOL DMGetVarInfoExStr (
LPCTSTR lpszProjectFile,
DWORD dwFlags,
LPVARIANT lpvdmVarKeyIn,
LPVARIANT lpvdmVarKeyOut,
LPCMN_ERROR lpdmError);
Descripción
Determina la clave completa de una variable. De tal modo, con una ID de variable se
proporcionará también el nombre de variable y viceversa.
A diferencia de "DMGetVarInfo", la lista de variables se transfiere como puntero a VARIANT
con "VT_ARRAY | VT_VARIANT". El retorno se efectúa en un segundo VARIANT. Con ello
desaparece la limitación de la longitud de los nombres de variable.
Parámetros
lpszProjectFile
Puntero al nombre del archivo de proyecto con ruta y extensión.
El nombre del archivo de proyecto puede determinarse con "DMEnumOpenedProjects" o en
runtime con "DMGetRuntimeProject".
dwFlags
Si se necesita el retorno del nombre de variable en el VARIANT "lpvdmVarKeyOut" en formato
"VT_LPSTR", aquí puede indicarse "DM_FLAG_RETURN_PROPVARIANT_VT_LPSTR".
lpvdmVarKeyIn
Puntero a VARIANT con "VT_ARRAY | VT_VARIANT" para la transferencia de la lista de
variables o VARIANT sencillo si solo se indica una variable.
En el elemento de lista correspondiente se introduce una ID de variable con el tipo "VT_I4" y
el nombre de variable con "VT_BSTR". También es posible "VT_LPSTR" (PROPVARIANT)
para la transferencia como cadena ASCII asignada a fin de, p. ej., transferir nombres
constantes del script. "VT_LPSTR" se convierte entonces internamente en el tipo solicitado
"VT_BSTR".
lpvdmVarKeyOut
Puntero al VARIANT con el que pueden devolverse los correspondientes valores para
"lpvdmVarKeyIn".
Con un nombre de variable predefinido en "lpvdmVarKeyIn" se devolverá la ID de variable y
viceversa.
Si el VARIANT se ha inicializado con "VT_EMPTY", se crea y rellena una matriz
correspondiente con "VT_ARRAY | VT_VARIANT" con el mismo tamaño que en
"lpvdmVarKeyIn".
Si el VARIANT no está vacío, se llama primero un "VariantClear" antes de crearse. Si el
VARIANT no se ha inicializado, puede producirse una excepción.
Si no existe la variable o no puede accederse a ella, se mantiene el tipo en "VT_EMPTY" para
la entrada correspondiente.
lpdmError
Puntero a los datos del aviso de error avanzado en la estructura "CMN_ERROR". En caso de
fallo, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Clave de variable determinada
FALSE
Error
Observación
La llamada no debe alternarse con llamadas para crear variables. Al utilizar por primera vez
la función "DMGetVarInfo" o "DMGetVarInfoExStr" tras la creación de una variable, tendrán
que volver a clasificarse cada vez las listas de búsqueda. Esto aumenta el tiempo de ejecución.
Mensajes de error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Ejemplos
Ejemplo de script "Button DMGetVarInfoExStr":
#include "apdefap.h"
void OnClick(char* lpszPictureName, char* lpszObjectName, char*
lpszPropertyName)
{
#pragma code ("kernel32.dll")
#define CP_ACP 0
int MultiByteToWideChar(UINT CodePage,
DWORD dwFlags,
LPCSTR lpMultiByteStr,
int cbMultiByte,
LPWSTR lpWideCharStr,
int cchWideChar);
int WideCharToMultiByte(UINT CodePage,
DWORD dwFlags,
LPCWSTR lpWideCharStr,
int cchWideChar,
LPSTR lpMultiByteStr,
int cbMultiByte,
LPCSTR lpDefaultChar,
LPBOOL lpUsedDefaultChar);
#pragma code()
HRESULT hr;
CHAR szProjectName[256];
CMN_ERROR err;
DWORD dwFlags;
BOOL bRet;
DWORD dwVarID1, dwVarID2, dwVarID3, dwVarID4;
CHAR szVarNam1[256], szVarNam2[256], szVarNam3[256], szVarNam4[265];
SAFEARRAY* parrayIN;
SAFEARRAY* parrayOUT;
long lInx;
WCHAR wszBuffer[256];
int nRet;
memset(&err, 0, sizeof(err));
bRet = FALSE;
szProjectName[0] = 0;
dwFlags = 0;
VariantInit(&vVarkeyIn);
VariantInit(&vVarkeyOut);
VariantInit(&vElem);
parrayIN = NULL;
parrayOUT = NULL;
//hr = E_FAIL;
nRet = 0;
printf("\r\n\r\n########## enter Test with DMGetVarInfoExStr
##########");
memset(&err, 0, sizeof(err));
bRet = DMGetVarInfoExStr(szProjectName, dwFlags, &vVarkeyIn,
&vVarkeyOut, &err);
if (!bRet)
{
printf("\r\n error DMGetVarInfoExStr[%s], err=%ld,%ld,%ld,%ld,
%ld,[%s]", szProjectName,
err.dwError1, err.dwError2, err.dwError3, err.dwError4,
err.dwError5, err.szErrorText);
if (err.dwError1 == DM_E_DONT_EXIST)
{
//reset error, elements wil be checked each for error in type
(VT_EMPTY == not exist)
bRet = TRUE;
}
}
else
{
printf("\r\n DMGetVarInfoExStr return OK");
}
if (bRet)
{
if (vVarkeyOut.vt == VT_EMPTY)
{
printf("\r\n vVarkeyOut is VT_EMPTY");
}
else
{
parrayOUT = vVarkeyOut.u.parray;
lInx = 0;
SafeArrayGetElement(parrayOUT, &lInx, &vElem);
if (vElem.vt != VT_I4)
{
printf("\r\n vVarKeyOut[%ld].vt = [%ld] != VT_I4", lInx,
vElem.vt);
dwVarID1 = 0L;
}
else
{
dwVarID1 = vElem.u.lVal;
}
SetTagDWord("dwVarKeyID_1",dwVarID1);
lInx = 1;
SafeArrayGetElement(parrayOUT, &lInx, &vElem);
if (vElem.vt != VT_I4)
{
printf("\r\n vVarKeyOut[%ld].vt = [%ld] != VT_I4", lInx,
vElem.vt);
dwVarID2 = 0L;
}
else
{
dwVarID2 = vElem.u.lVal;
}
SetTagDWord("dwVarKeyID_2",dwVarID2);
lInx = 2;
SafeArrayGetElement(parrayOUT, &lInx, &vElem);
if (vElem.vt != VT_BSTR)
{
printf("\r\n vVarKeyOut[%ld].vt = [%ld] != VT_BSTR",
lInx, vElem.vt);
strcpy(szVarNam3, "error!!!");
}
else
{
nRet = WideCharToMultiByte(CP_ACP, 0L,
(WCHAR*)vElem.u.bstrVal, -1,
szVarNam3, 256, NULL, NULL);
}
SetTagChar("szVarKeyName_3",szVarNam3);
lInx = 3;
}
if (bRet)
{
if (vVarkeyOut.vt == VT_EMPTY)
{
printf("\r\n vVarkeyOut is VT_EMPTY");
}
else
{
parrayOUT = vVarkeyOut.u.parray;
lInx = 0;
SafeArrayGetElement(parrayOUT, &lInx, &vElem);
if (vElem.vt != VT_I4)
{
printf("\r\n vVarKeyOut[%ld].vt = [%ld] != VT_I4", lInx,
vElem.vt);
dwVarID1 = 0L;
}
else
{
dwVarID1 = vElem.u.lVal;
}
SetTagDWord("dwVarKeyID_1",dwVarID1);
lInx = 1;
SafeArrayGetElement(parrayOUT, &lInx, &vElem);
if (vElem.vt != VT_I4)
{
printf("\r\n vVarKeyOut[%ld].vt = [%ld] != VT_I4", lInx,
vElem.vt);
dwVarID2 = 0L;
}
else
{
dwVarID2 = vElem.u.lVal;
}
SetTagDWord("dwVarKeyID_2",dwVarID2);
SafeArrayLock(parrayOUT);
lInx = 2;
SafeArrayPtrOfIndex(parrayOUT, &lInx, &pvElem);
if (pvElem->vt != VT_LPSTR)
{
printf("\r\n vVarKeyOut[%ld].vt = [%ld] != VT_LPSTR",
lInx, pvElem->vt);
strcpy(szVarNam3, "error!!!");
}
else
{
strncpy(szVarNam3, (LPSTR)pvElem->u.pbVal, 255);
szVarNam3[255] = 0;
}
SetTagChar("szVarKeyName_3",szVarNam3);
lInx = 3;
SafeArrayPtrOfIndex(parrayOUT, &lInx, &pvElem);
if (pvElem->vt != VT_LPSTR)
{
printf("\r\n vVarKeyOut[%ld].vt = [%ld] != VT_LPSTR",
lInx, pvElem->vt);
strcpy(szVarNam4, "error!!!");
}
else
{
strncpy(szVarNam4, (LPSTR)pvElem->u.pbVal, 255);
szVarNam4[255] = 0;
}
SetTagChar("szVarKeyName_4",szVarNam4);
SafeArrayUnlock(parrayOUT);
}
else
{
printf("\r\n VariantClear(vVarkeyIn) OK after manualy reset
the PROPVARIANT in 2. elem");
}
}
hr = VariantClear(&vVarkeyOut);
if (hr)
{
printf("\r\n error VariantClear(vVarkeyOut): hr = %08lx", hr);
}
vVarkeyIn.vt = VT_I4;
vVarkeyIn.u.lVal = dwVarID1;
bRet = DMGetVarInfoExStr(szProjectName, dwFlags, &vVarkeyIn,
&vVarkeyOut, &err);
if (!bRet)
{
printf("\r\n error DMGetVarInfoExStr[%s], err=%ld,%ld,%ld,%ld,
%ld,[%s]", szProjectName,
err.dwError1, err.dwError2, err.dwError3, err.dwError4,
err.dwError5, err.szErrorText);
if (err.dwError1 == DM_E_DONT_EXIST)
{
//reset error, elements wil be checked each for error in type
(VT_EMPTY == not exist)
bRet = TRUE;
}
}
else
{
printf("\r\n DMGetVarInfoExStr return OK");
}
if (bRet)
{
if (vVarkeyOut.vt == VT_EMPTY)
{
printf("\r\n vVarkeyOut is VT_EMPTY");
}
else
{
if (vVarkeyOut.vt != VT_LPSTR)
{
printf("\r\n vVarKeyOut.vt = [%ld] != VT_LPSTR",
vVarkeyOut.vt);
strcpy(szVarNam1, "error!!!");
}
else
{
strncpy(szVarNam1, (LPSTR)vVarkeyOut.u.pbVal, 255);
szVarNam1[255] = 0;
}
SetTagChar("szVarKeyName_1",szVarNam1);
}
}
Utilización
DMGetVarLimits determina para la variable indicada los límites en los cuales se pueden
realizar operaciones de escritura con la función DMSetValue.
Declaración
BOOL DMGetVarLimits (
LPCSTR lpszProjectFile,
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
LPDM_VARLIMIT lpdmVarLimit,
LPCMN_ERROR lpdmError);
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto se determina con DMEnumOpenedProjects o en RT con
DMGetRuntimeProject.
lpdmVarKey
Puntero a estructuras del tipo DM_VARKEY (Página 242) para especificar variables.
dwItems
Número de estructuras transmitidas.
lpdmVarLimit
Puntero a estructuras del tipo DM_VARLIMIT (Página 244) en el que se agregan los valores
límite.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Valores límite determinados.
FALSE
Error.
Comentario
Además de los límites superior e inferior de una variable definidos en la configuración, hay
otra limitación del margen numérico permitido debido a una norma de formato agregada.
El ejemplo siguiente representa las relaciones con una variable del tipo
DM_VARTYPE_BYTE , que se agrega al sistema de automatización como byte en formato
BCD.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
OnTestVariablenGetvarlimits (Página 508)"TESTCDoc.cpp"
Consulte también
DM_VARKEY (Página 242)
DM_VARLIMIT (Página 244)
OnTestVariablenGetvarlimits (Página 508)
Declaración
BOOL DMGetVarLimitsExStr (
LPCTSTR lpszProjectFile,
LPVARIANT lpvdmVarKey,
LPDM_VARLIMIT lpdmVarLimit,
LPCMN_ERROR lpdmError );
Descripción
Determina para las variables indicadas los límites en los cuales se pueden realizar
operaciones de escritura con las funciones "DMSetValueExStr".
A diferencia de "DMGetVarLimits", la lista de variables se transfiere como puntero a VARIANT
con "VT_ARRAY | VT_VARIANT". Con ello desaparece la limitación de la longitud de los
nombres de variable.
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto con ruta y extensión.
El nombre del archivo de proyecto puede determinarse con "DMEnumOpenedProjects" o en
runtime con "DMGetRuntimeProject".
lpvdmVarKey
Puntero a VARIANT con "VT_ARRAY | VT_VARIANT" para la transferencia de la lista de
variables o VARIANT sencillo si solo se indica una variable.
En el elemento de lista correspondiente se introduce una ID de variable con el tipo "VT_I4" y
el nombre de variable con "VT_BSTR". También es posible "VT_LPSTR" (PROPVARIANT)
para la transferencia como cadena ASCII asignada a fin de, p. ej., transferir nombres
constantes del script. "VT_LPSTR" se convierte entonces internamente en el tipo solicitado
"VT_BSTR".
lpdmVarLimit
Puntero a estructuras del tipo "DM_VARLIMIT" en las que se guardan los valores límite.
lpdmError
Puntero a los datos del aviso de error avanzado en la estructura "CMN_ERROR". En caso de
fallo, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Valores límite determinados
FALSE
Error
Observación
Además de los límites superior e inferior configurados de una variable, se da otra limitación
del margen numérico permitido debido a una norma de formato agregada.
El siguiente ejemplo muestra las relaciones con una variable del tipo "DM_VARTYPE_BYTE"
almacenada en el AS como byte en formato "BCD".
Mensajes de error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Ejemplos
Ejemplo de script "Button DMGetVarLimitsExStr":
#include "apdefap.h"
void OnClick(char* lpszPictureName, char* lpszObjectName, char*
lpszPropertyName)
{
#pragma code ("OleAut32.dll")
SAFEARRAY * SafeArrayCreateVector(VARTYPE vt, long lLbound, unsigned
int cElements );
HRESULT SafeArrayPtrOfIndex(SAFEARRAY FAR* psa, long FAR* rgIndices,
void HUGEP* FAR* ppvData );
HRESULT SafeArrayLock(SAFEARRAY FAR* psa);
HRESULT SafeArrayUnlock(SAFEARRAY FAR* psa);
HRESULT VariantChangeType( VARIANTARG FAR* pvargDest, VARIANTARG
FAR* pvarSrc, unsigned short wFlags, VARTYPE vt );
#pragma code()
VARIANT vdmVarkey;
VARIANT* pvElem;
VARIANT vElem;
HRESULT hr;
CHAR szProjectName[256];
CMN_ERROR err;
BOOL bRet;
CHAR szVarNam1[256], szVarNam2[256], szVarNam3[256], szVarNam4[265];
SAFEARRAY* parray;
long lInx;
int nRet;
DM_VARLIMIT dmLimits[4];
int i;
memset(&err, 0, sizeof(err));
bRet = FALSE;
szProjectName[0] = 0;
VariantInit(&vElem);
VariantInit(&vdmVarkey);
parray = NULL;
nRet = 0;
i = 0;
memset(&err, 0, sizeof(err));
memset(dmLimits, 0, sizeof(DM_VARLIMIT)*4);
bRet = DMGetVarLimitsExStr(szProjectName, &vdmVarkey, dmLimits,
&err);
if (!bRet)
{
printf("\r\n error DMGetVarLimitsExStr[%s], err=%ld,%ld,%ld,%ld,
%ld,[%s]", szProjectName,
err.dwError1, err.dwError2, err.dwError3, err.dwError4,
err.dwError5, err.szErrorText);
bRet = TRUE; //clear error flag, the defect data is set to VT_EMPTY
}
else
{
printf("\r\n DMGetVarLimitsExStr return OK");
}
if (bRet)
{
for (i = 0; i < 4; i++)
{
VariantClear(&vElem);
printf("\r\n dmLimits[%d]:{",i);
hr = VariantChangeType((VARIANTARG*)&vElem,
(VARIANTARG*)&dmLimits[i].dmMaxRange, 0, VT_R8);
if ((0L == hr) && (VT_R8 == vElem.vt) && (VT_EMPTY !=
dmLimits[i].dmMaxRange.vt))
{
printf("dmMaxRange=[%g], ", vElem.u.dblVal);
}
else
{
printf("dmMaxRange{VariantChangeType error hr = 0x%08lx,
vt=0x%04x}",
hr, dmLimits[i].dmMaxRange.vt);
}
VariantClear(&vElem);
hr = VariantChangeType((VARIANTARG*)&vElem,
(VARIANTARG*)&dmLimits[i].dmMinRange, 0, VT_R8);
if ((0L == hr) && (VT_R8 == vElem.vt) && (VT_EMPTY !=
dmLimits[i].dmMinRange.vt))
{
printf("dmMinRange=[%g], ", vElem.u.dblVal);
}
else
{
printf("dmMinRange{VariantChangeType error hr = 0x%08lx,
vt=0x%04x}",
hr, dmLimits[i].dmMinRange.vt);
}
VariantClear(&vElem);
hr = VariantChangeType((VARIANTARG*)&vElem,
(VARIANTARG*)&dmLimits[i].dmMaxLimit, 0, VT_R8);
if ((0L == hr) && (VT_R8 == vElem.vt) && (VT_EMPTY !=
dmLimits[i].dmMaxLimit.vt))
{
printf("dmMaxLimit=[%g], ", vElem.u.dblVal);
}
else
{
printf("dmMaxLimitVariantChangeType error hr = 0x%08lx,
vt=0x%04x}",
hr, dmLimits[i].dmMaxLimit.vt);
}
VariantClear(&vElem);
hr = VariantChangeType((VARIANTARG*)&vElem,
(VARIANTARG*)&dmLimits[i].dmMinLimit, 0, VT_R8);
if ((0L == hr) && (VT_R8 == vElem.vt) && (VT_EMPTY !=
dmLimits[i].dmMinLimit.vt))
{
printf("dmMinLimit=[%g]", vElem.u.dblVal);
}
else
{
printf("dmMinLimitVariantChangeType error hr = 0x%08lx,
vt=0x%04x}",
hr, dmLimits[i].dmMinLimit.vt);
}
printf("}");
}
}
Utilización
DMGetVarType determina la referencia del tipo para las variables indicadas.
Declaración
BOOL DMGetVarType (
LPCSTR lpszProjectFile,
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
LPDM_TYPEREF lpdmTypeRef,
LPCMN_ERROR lpdmError);
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto se determina con DMEnumOpenedProjects o en RT con
DMGetRuntimeProject.
lpdmVarKey
Puntero a la estructura DM_VARKEY (Página 242) con la clave de variable para la que se
determina el tipo.
dwItems
Número de estructuras transmitidas.
lpdmTypeRef
Puntero a la lista de estructuras DM_TYPEREF (Página 227) para retornar las indicaciones
del tipo de variable.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Tipo de datos determinado.
FALSE
Error.
Comentario
Las funciones de configuración para crear variables transmiten a la aplicación que efectúa la
llamada las estructuras DM_VARREF y DM_TYPEREF ocupadas con indicaciones del tipo
de datos de la variable.
Para ahorrar espacio de memoria dentro de la aplicación, ésta no debe ser forzada a recordar
la referencia del tipo de cada variable, sino que puede consultarla cada vez desde el
administrador de datos con DMGetVarType.
No alterne la llamada con llamadas para crear variables. Si DMGetVarType se utiliza por
primera vez tras crear una variable, se reordenan las listas de búsqueda, lo que ocupa más
tiempo de ejecución.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
OnTestVariablenGetvartype (Página 509)"TESTCDoc.cpp"
Consulte también
DM_VARKEY (Página 242)
DM_TYPEREF (Página 227)
OnTestVariablenGetvartype (Página 509)
Declaración
BOOL DMGetVarTypeExStr (
LPCTSTR lpszProjectFile,
LPVARIANT lpvdmVarKey,
LPDM_TYPEREF_EXSTR lpdmTypeRef,
LPCMN_ERROR lpdmError);
Descripción
Determina la referencia del tipo para las variables transferidas.
A diferencia de "DMGetVarType", la lista de variables se transfiere como puntero a VARIANT
con "VT_ARRAY | VT_VARIANT". Con ello desaparece la limitación de la longitud de los
nombres de variable. Lo mismo sucede con los nombres de tipo en las estructuras
"DM_TYPEREF_EXSTR".
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto con ruta y extensión.
El nombre del archivo de proyecto puede determinarse con "DMEnumOpenedProjects" o en
runtime con "DMGetRuntimeProject".
lpvdmVarKey
Puntero a VARIANT con "VT_ARRAY | VT_VARIANT" para la transferencia de la lista de
variables.
En el elemento de lista correspondiente se introduce una ID de variable con el tipo "VT_I4" y
el nombre de variable con "VT_BSTR". También es posible "VT_LPSTR" (PROPVARIANT)
para la transferencia como cadena ASCII asignada a fin de, p. ej., transferir nombres
constantes del script. "VT_LPSTR" se convierte entonces internamente en el tipo solicitado
"VT_BSTR".
lpdmTypeRef
Puntero a la lista de estructuras "DM_TYPEREF_EXSTR" para el retorno de las indicaciones
del tipo de variable.
La lista debe tener al menos el tamaño de la matriz Variant en "lpvdmVarKey". Los punteros
"lpszTypeName" y "dwBufferCount" deben haberse inicializado y remitir a una matriz de
cadena propia.
Si "lpszTypeName" es "NULL", compruebe el retorno. El propio usuario deberá volver a
habilitar los punteros asignados.
lpdmError
Puntero a los datos del aviso de error avanzado en la estructura "CMN_ERROR". En caso de
fallo, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Tipo de datos determinado
FALSE
Error
Observación
Para ahorrar memoria dentro de la aplicación, esta no debe memorizar forzosamente la
referencia del tipo para cada variable. La referencia del tipo puede consultarse en todo
momento al administrador de datos con "DMGetVarType".
La llamada no debe alternarse con llamadas para crear variables. Al utilizar por primera vez
la función "DMGetVarType" o "DMGetVarTypeExStr" tras la creación de una variable, tendrán
que volver a clasificarse cada vez las listas de búsqueda. Esto aumenta el tiempo de ejecución.
Mensajes de error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Ejemplos
Ejemplo de script "Button DMGetVarTypeExStr":
#include "apdefap.h"
void OnClick(char* lpszPictureName, char* lpszObjectName, char*
lpszPropertyName)
{
#pragma code ("OleAut32.dll")
SAFEARRAY * SafeArrayCreateVector(VARTYPE vt, long lLbound, unsigned
int cElements );
HRESULT SafeArrayPtrOfIndex(SAFEARRAY FAR* psa, long FAR* rgIndices,
void HUGEP* FAR* ppvData );
HRESULT SafeArrayLock(SAFEARRAY FAR* psa);
HRESULT SafeArrayUnlock(SAFEARRAY FAR* psa);
#pragma code()
VARIANT vdmVarkey;
VARIANT* pvElem;
HRESULT hr;
CHAR szProjectName[256];
CMN_ERROR err;
BOOL bRet;
CHAR szVarNam1[256], szVarNam2[256], szVarNam3[256], szVarNam4[256];
SAFEARRAY* parray;
long lInx;
int nRet;
DM_TYPEREF_EXSTR dmTypeRef[4];
CHAR szTypeName[4][256];
int i;
memset(&err, 0, sizeof(err));
memset(dmTypeRef, 0, sizeof(DM_TYPEREF_EXSTR)*4);
szTypeName[0][0] = 0;
szTypeName[1][0] = 0;
szTypeName[2][0] = 0;
szTypeName[3][0] = 0;
bRet = FALSE;
szProjectName[0] = 0;
VariantInit(&vdmVarkey);
parray = NULL;
nRet = 0;
i = 0;
}
else
{
printf("\r\n DMGetVarTypeExStr return OK");
}
if (bRet)
{
for (i = 0; i < 4; i++)
{
printf("\r\n dmTypeRef[%d]:{",i);
printf("dwType=[%ld]", dmTypeRef[i].dwType);
printf(", dwSize=[%ld]", dmTypeRef[i].dwSize);
if (dmTypeRef[i].lpszTypeName)
{
printf(", lpszTypeName=[%s]", dmTypeRef[i].lpszTypeName);
printf(", dwNameCharCount=[%ld]",
dmTypeRef[i].dwNameCharCount);
//clear the delivered strings that no memoryleak
free(dmTypeRef[i].lpszTypeName);
dmTypeRef[i].lpszTypeName = NULL;
dmTypeRef[i].dwNameCharCount = 0L;
//set name store for next read (no need to free after
call)
dmTypeRef[i].lpszTypeName = szTypeName[i];
dmTypeRef[i].dwNameCharCount = 255;
}
printf("}");
}
}
printf("\r\n call DMGetVarTypeExStr with pointers and size for name
storage");
memset(&err, 0, sizeof(err));
bRet = DMGetVarTypeExStr(szProjectName, &vdmVarkey, dmTypeRef, &err);
if (!bRet)
{
printf("\r\n error DMGetVarTypeExStr[%s], err=%ld,%ld,%ld,%ld,
%ld,[%s]", szProjectName,
err.dwError1, err.dwError2, err.dwError3, err.dwError4,
err.dwError5, err.szErrorText);
}
else
{
printf("\r\n DMGetVarTypeExStr return OK");
}
if (bRet)
{
for (i = 0; i < 4; i++)
{
printf("\r\n dmTypeRef[%d]:{",i);
printf("dwType=[%ld]", dmTypeRef[i].dwType);
printf(", dwSize=[%ld]", dmTypeRef[i].dwSize);
printf(", lpszTypeName=[%s]", dmTypeRef[i].lpszTypeName);
printf(", dwNameCharCount=[%ld]",
dmTypeRef[i].dwNameCharCount);
printf("}");
}
}
printf("\r\n########## exit Test with DMGetVarTypeExStr ##########\r
\n");
Utilización
La función modifica los valores de las variables descritas en lpdmVarKey por los valores
indicados en lpdmValue.
La interrupción de los cambios las variables es asíncrona de acuerdo con el lema "dispara y
olvida".
Declaración
BOOL DMSetValue (
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
LPVARIANT lpdmValue,
LPDWORD lpdmVarState,
LPCMN_ERROR lpdmError);
Parámetro
lpdmVarKey
Puntero a la primera de las estructuras DM_VARKEY (Página 242) que identifican las variables
que hay que modificar.
dwItems
Número de estructuras transmitidas (equivale al número de variables por modificar).
lpdmValue
Puntero al primer valor nuevo de las variables que hay que modificar.
lpdmVarState
Puntero al primer lugar de la memoria al que se agrega la información si el valor de la variable
se ha podido modificar correctamente o se han producido errores.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Variables modificadas.
FALSE
Error.
Comentario
No es necesario indicar una norma de acceso para lpdmValue ya que el administrador de
datos puede encontrar una asignación para cada tipo de variable partiendo de la clave de
variable transmitida.
En las variables externas se realiza un acceso de escritura al proceso, en los PCs de un cliente
WinCC la petición se transfiere al servidor correspondiente.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Ejemplos
Write tag (Página 521)"DM02.cpp"
OnTestVariablenSetvalue (Página 511)"TESTCDoc.cpp"
Consulte también
DM_VARKEY (Página 242)
DMGetValue (Página 342)
DMGetValueEx (Página 344)
DMSetValueMessage (Página 392)
DMSetValueWait (Página 395)
DMSetValueWaitMessage (Página 401)
Write tag (Página 521)
OnTestVariablenSetvalue (Página 511)
Declaración
BOOL DMSetValueExStr (
LPVARIANT lpvdmVarKey,
LPVARIANT lpvdmValue,
LPDWORD lpdmVarState,
LPCMN_ERROR lpdmError);
Descripción
La función cambia los valores de las variables descritas en "lpvdmVarKey" por los valores
indicados en "lpvdmValue".
La señalización de los cambios de las variables sucede de forma asíncrona de acuerdo con
el lema "dispara y olvida".
A diferencia de "DMSetValue", la lista de variables se transfiere como puntero a VARIANT
con "VT_ARRAY | VT_VARIANT". Con ello desaparece la limitación de la longitud de los
nombres de variable.
Parámetro
lpvdmVarKey
Puntero a VARIANT con "VT_ARRAY | VT_VARIANT" para la transferencia de la lista de
variables o VARIANT sencillo si solo se indica una variable que identifica las variables que
hay que modificar.
En el elemento de lista correspondiente se introduce una ID de variable con el tipo "VT_I4" y
el nombre de variable con "VT_BSTR". También es posible "VT_LPSTR" (PROPVARIANT)
para la transferencia como cadena ASCII asignada a fin de, p. ej., transferir nombres
constantes del script. "VT_LPSTR" se convierte entonces internamente en el tipo solicitado
"VT_BSTR".
En proyectos multicliente a partir de la versión V5.0 de WinCC, aquí también debe indicarse,
dado el caso, un prefijo de servidor en cada nombre (ver tipos de proyecto y versiones).
lpvdmValue
Puntero al primer valor nuevo de las variables que hay que modificar.
lpdmVarState
Puntero al primer lugar de la memoria en el que se almacena información si se ha podido
modificar correctamente el valor de las variables o se han producido errores.
Un "0" (OK) significa que se ha enviado/modificado correctamente y que existe al menos una
de las variables indicadas. Si no existe ninguna de las variables indicadas, se emite un error
con el estado "DM_VARSTATE_INVALID_KEY".
Para comprobar si el valor también ha sido adoptado por el PLC, debe utilizarse
"DMSetValueWaitExStr".
lpdmError
Puntero a los datos del aviso de error avanzado en la estructura "CMN_ERROR". En caso de
fallo, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Variables modificadas.
FALSE
Error
Observación
No es necesario indicar una norma de acceso para "lpdmValue", ya que el administrador de
datos puede efectuar una asignación al tipo correspondiente partiendo de la clave de variable
transmitida.
Con variables externas se realiza un acceso de escritura al proceso; con equipos cliente
WinCC, la petición se transfiere al servidor correspondiente.
Normalmente, las peticiones de escritura de las aplicaciones se ejecutan de forma asíncrona,
es decir, todas las peticiones de escritura se ponen en la cola de espera del administrador de
datos y se transmiten secuencialmente a la DLL de canal responsable.
El nuevo valor es válido en la memoria imagen de proceso del servidor responsable de la
petición si la DLL de canal confirma positivamente la petición de escritura. A continuación se
lleva a cabo la actualización en las estaciones WinCC conectadas con el bus de sistemas.
De ello resulta que a corto plazo puede haber diferentes valores para una variable en
diferentes estaciones.
Mensajes de error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Funciones relacionadas
Ejemplos
Encontrará ejemplos en la página de "DMGetValueExStr".
Utilización
La función modifica el valor de la variable descrita en lpdmVarKey por el valor indicado en
lpdmValue.
A diferencia de la función DMSetValue, sólo se modifica una variable. Si el valor de la variable
se ha modificado correctamente, se entrega un texto de aviso libremente definible.
Declaración
BOOL DMSetValueMessage (
LPDM_VARKEY lpdmVarKey,
LPVARIANT lpdmValue,
DWORD fFlags,
LPSTR lpszMessage,
LPCMN_ERROR lpdmError);
Parámetro
lpdmVarKey
Puntero a la estructura DM_VARKEY (Página 242) que identifica la variable que hay que
modificar.
En los proyectos multicliente a partir de la versión 5.0 de WinCC se indica, en caso necesario,
con un prefijo de servidor en lpdmVarKey->szName (véase tipos de proyecto y versiones).
lpdmValue
Puntero al nuevo valor de las variables que hay que modificar.
fFlags
Con fFlags se determina cómo se procesa el texto de aviso:
lpszMessage
Texto del aviso que se entrega.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Variable modificada.
FALSE
Error.
Comentario
Encontrará más información acerca de la modificación de valores de variable en la función
DMSetValue.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Consulte también
DM_VARKEY (Página 242)
DMSetValue (Página 386)
DMSetValueWait (Página 395)
DMSetValueWaitMessage (Página 401)
Declaración
BOOL DMSetValueMessageExStr (
LPVARIANT lpvdmVarKey,
LPVARIANT lpvdmValue,
DWORD fFlags,
LPTSTR lpszMessage,
LPCMN_ERROR lpdmError);
Descripción
La función cambia el valor de la variable descrita en "lpvdmVarKey" por el valor indicado en
"lpdmValue".
A diferencia de la función "DMSetValueExStr", solo puede modificarse una variable. Si el valor
de la variable se ha modificado correctamente, se señaliza un texto de aviso libremente
definible.
Parámetro
lpvdmVarKey
Puntero a VARIANT para la transferencia del nombre de variable, ID de variable o VARIANT
sencillo si solo se indica una variable que identifica las variables que hay que modificar.
En el elemento de lista correspondiente se introduce una ID de variable con el tipo "VT_I4" y
el nombre de variable con "VT_BSTR". También es posible "VT_LPSTR" (PROPVARIANT)
para la transferencia como cadena ASCII asignada a fin de, p. ej., transferir nombres
constantes del script. "VT_LPSTR" se convierte entonces internamente en el tipo solicitado
"VT_BSTR".
Si se indica una matriz con "VT_ARRAY | VT_VARIANT", solo se evalúa el primer elemento.
En proyectos multicliente a partir de la versión V5.0 de WinCC, aquí también debe indicarse,
dado el caso, un prefijo de servidor en el nombre (ver tipos de proyecto y versiones).
lpvdmValue
Puntero al nuevo valor de las variables que hay que modificar.
fFlags
Especifica cómo se procesa el texto de aviso:
lpszMessage
Texto del aviso que se entrega.
lpdmError
Puntero a los datos del aviso de error avanzado en la estructura "CMN_ERROR". En caso de
fallo, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Variables modificadas
FALSE
Error
Observación
Encontrará más información acerca de la modificación de valores de variable en la función
"DMSetValueExStr".
Mensajes de error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Funciones relacionadas
Utilización
La función modifica los valores de las variables descritas en lpdmVarKey por los valores
indicados en lpdmValue.
Declaración
BOOL DMSetValueWait (
LPDWORD pdwTAID,
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
LPVARIANT lpdmValue,
DWORD dwTimeOut,
DM_COMPLETITION_PROC lpfnCompletition,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Parámetro
pdwTAID
Puntero a una variable que, tras una correcta llamada de la función, contiene la ID de
transacción asignada por el administrador de datos.
lpdmVarKey
Puntero a la primera de las estructuras DM_VARKEY (Página 242) que identifican las variables
que hay que modificar.
dwItems
Número de estructuras transmitidas (equivale al número de variables por modificar).
lpdmValue
Puntero al primer valor nuevo de las variables que hay que modificar.
dwTimeout
Tiempo de espera máximo de la aplicación en ms. Si una vez transcurrido el tiempo de espera
no se han escrito todas las variables, la función Callback es llamada con los códigos de error
correspondientes.
lpfnCompletition
Puntero a la función Callback que se llama después de actualizar todas las variables
solicitadas o una vez transcurrido el tiempo de espera.
Si un programa inicia una rutina Notify, debe vaciar periódicamente su Message Queue. Los
mensajes no recogidos pueden bloquear las notificaciones de WinCC y, con ello, todo WinCC.
En algunos casos excepcionales puede incluso suceder que Notify ya se haya entregado
antes de que se devuelva la llamada de función.
lpvUser
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a la primera estructura de error dwItems del tipo CMN_ERROR. Si aparece un error
al escribir una variable, el sistema escribe la información de error en la estructura
correspondiente. No hay que olvidar reservar espacio para estas estructuras.
Valor de retorno
TRUE
Variables modificadas.
FALSE
El error ocurrido se puede identificar con la estructura de error.
Comentario
Encontrará más información acerca de la modificación de valores de variable en la función
DMSetValue.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Ejemplos
OnTestVariablenSetvaluewait (Página 512)"TESTCDoc.cpp"
Consulte también
DM_VARKEY (Página 242)
DMGetValueWait (Página 355)
DMGetValueWaitEx (Página 357)
DMSetValue (Página 386)
DMSetValueMessage (Página 392)
DMSetValueWaitMessage (Página 401)
DM_COMPLETITION_PROC (Página 406)
OnTestVariablenSetvaluewait (Página 512)
Declaración
BOOL DMSetValueWaitExStr (
LPDWORD pdwTAID,
LPVARIANT lpvdmVarKey,
DWORD dwItems,
LPVARIANT lpvdmValue,
LPDWORD lpdwState,
DWORD dwTimeOut,
DM_COMPLETITION_PROC lpfnCompletition,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Descripción
La función cambia los valores de las variables descritas en "lpvdmVarKey" por los valores
indicados en "lpvdmValue".
A diferencia de "DMSetValueExStr", "DMSetValueWaitExStr" da a la aplicación la posibilidad
de ser informada tras una actualización en el equipo local.
A diferencia de "DMSetValueWait", la lista de variables se transfiere como puntero a VARIANT
con "VT_ARRAY | VT_VARIANT". Con ello desaparece la limitación de la longitud de los
nombres de variable.
Parámetro
pdwTAID
Puntero a una variable que, tras una correcta llamada de la función, contiene la ID de
transacción asignada por el administrador de datos.
lpvdmVarKey
Puntero a VARIANT con "VT_ARRAY | VT_VARIANT" para la transferencia de la lista de
variables o VARIANT sencillo si solo se indica una variable que identifica las variables que
hay que modificar.
En el elemento de lista correspondiente se introduce una ID de variable con el tipo "VT_I4" y
el nombre de variable con "VT_BSTR". También es posible "VT_LPSTR" (PROPVARIANT)
para la transferencia como cadena ASCII asignada a fin de, p. ej., transferir nombres
constantes del script. "VT_LPSTR" se convierte entonces internamente en el tipo solicitado
"VT_BSTR".
En proyectos multicliente a partir de la versión V5.0 de WinCC, aquí también debe indicarse,
dado el caso, un prefijo de servidor en cada nombre (ver tipos de proyecto y versiones).
dwItems
Número de valores transferidos en "lpvdmValue" y estructuras de error en "lpdmError". El
número debe ser igual o superior a la matriz de entrada en "lpvdmVarKey".
Si el número es superior a la matriz de entrada, se ignoran los valores sobrantes y se ajustan
las respectivas estructuras de error con "DM_E_PARAM", puesto que no es posible la
asignación.
Si el número es inferior a la matriz de entrada, solo se devuelve el error "DM_E_PARAM" en
la primera estructura de error y no se escriben valores.
lpvdmValue
Puntero al primer valor nuevo de las variables que hay que modificar.
lpdwState
Puntero al primer lugar de la memoria en el que se almacena información si se ha podido
modificar correctamente el valor de las variables o se han producido errores.
Un 0 (OK) significa que se ha enviado/modificado correctamente y que como mínimo existe
una de las variables indicadas. Si no existe ninguna de las variables indicadas, se emite un
error con el estado DM_VARSTATE_INVALID_KEY.
dwTimeout
Tiempo de espera máximo de la aplicación en "ms". Si no se han escrito todas las variables
una vez transcurrido el tiempo de espera, se llama la función Callback con los códigos de
error correspondientes.
lpfnCompletition
Puntero a la función Callback que se llama después de actualizar todas las variables
solicitadas o una vez transcurrido el tiempo de espera.
Si un programa activa una rutina Notify, deberá vaciar periódicamente su cola de mensajes.
Los mensajes no recogidos pueden bloquear las notificaciones de WinCC y, con ello, todo
WinCC.
En algunos casos excepcionales puede ocurrir que se suministre Notify antes de que retorne
la llamada de función.
lpvUser
Puntero a datos específicos de la aplicación. El puntero no es evaluado por la función, sino
que vuelve a ponerse a disposición en la función Callback.
lpdmError
Puntero a la primera de las estructuras de error dwItems del tipo "CMN_ERROR". Si se
produce un error al escribir una variable, el sistema escribe la información de error en la
estructura correspondiente. Por ello, no hay que olvidar reservar espacio para estas
estructuras e inicializar.
Valor de retorno
TRUE
Variables modificadas
FALSE
El error ocurrido se puede identificar con la estructura de error.
Observación
Encontrará más información acerca de la modificación de valores de variable en la función
"DMSetValueExStr".
Mensajes de error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Funciones relacionadas
Ejemplos
Encontrará ejemplos en la página de "DMGetValueExStr".
Utilización
La función reúne las funciones de DMSetValueMessage y DMSetValueWait. A diferencia de
la función DMSetValueWait, sólo se puede modificar una variable.
El valor de las variables descritas en lpdmVarKey se modifica por el valor indicado en
lpdmValue. Si el valor de las variables se ha modificado correctamente, por una parte se
entrega un texto de aviso libremente definible y, por la otra, la aplicación tiene la posibilidad
de ser notificada de que la máquina local se ha actualizado correctamente.
Declaración
BOOL DMSetValueWaitMessage (
LPDWORD pdwTAID,
LPDM_VARKEY lpdmVarKey,
LPVARIANT lpdmValue,
DWORD dwTimeOut,
DM_COMPLETITION_PROC lpfnCompletition,
DWORD fFlags,
LPSTR lpszMessage,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Parámetro
pdwTAID
Puntero a una variable que, tras una correcta llamada de la función, contiene la ID de
transacción asignada por el administrador de datos.
lpdmVarKey
Puntero a las estructuras DM_VARKEY (Página 242) que identifican la variable que hay que
modificar.
lpdmValue
Puntero al nuevo valor de las variables que hay que modificar.
dwTimeOut
Tiempo de espera máximo de la aplicación en ms. Si una vez transcurrido el tiempo de espera
no se han escrito todas las variables, la función Callback es llamada con los códigos de error
correspondientes.
lpfnCompletition
Puntero a la función Callback que se llama después de actualizar todas las variables
solicitadas o una vez transcurrido el tiempo de espera.
Si un programa inicia una rutina Notify, debe vaciar periódicamente su Message Queue. Los
mensajes no recogidos pueden bloquear las notificaciones de WinCC y, con ello, todo WinCC.
En algunos casos excepcionales puede incluso suceder que Notify ya se haya entregado
antes de que se devuelva la llamada de función.
fFlags
Con fFlags se determina cómo se procesa el texto de aviso:
lpszMessage
Texto de aviso que se entrega.
lpvUser
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a la primera estructura de error dwItems del tipo CMN_ERROR. Si aparece un error
al escribir una variable, el sistema escribe la información de error en la estructura
correspondiente. No hay que olvidar reservar espacio para estas estructuras.
Valor de retorno
TRUE
Variables modificadas.
FALSE
Error.
Comentario
Encontrará más información acerca de la modificación de valores de variable en la función
DMSetValue.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Consulte también
DM_VARKEY (Página 242)
DMSetValue (Página 386)
DMSetValueMessage (Página 392)
DMSetValueWait (Página 395)
OnTestVariablenSetvaluewait (Página 512)
DM_COMPLETITION_PROC (Página 406)
Declaración
BOOL DMSetValueWaitMessageExStr (
LPDWORD pdwTAID,
LPVARIANT lpvdmVarKey,
LPVARIANT lpvdmValue,
DWORD dwTimeOut,
DM_COMPLETITION_PROC lpfnCompletition,
DWORD fFlags,
LPTSTR lpszMessage,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Descripción
La función combina las funcionalidades de "DMSetValueMessageExStr" y
"DMSetValueWaitExStr".
A diferencia de la función "DMSetValueWaitExStr", solo puede modificarse una variable.
El valor de la variable descrita en "lpvdmVarKey" se cambia por el valor indicado en
"lpvdmValue". Si el valor de la variable se ha modificado correctamente, se señaliza por un
lado un texto de aviso libremente definible. Por otro lado, la aplicación tiene la posibilidad de
ser informada si se efectúa una actualización en el equipo local.
A diferencia de "DMSetValueWaitMessage", la variable se transfiere como puntero a
VARIANT. Con ello desaparece la limitación de la longitud del nombre de variable.
Parámetro
pdwTAID
Puntero a una variable que, tras una correcta llamada de la función, contiene la ID de
transacción asignada por el administrador de datos.
lpvdmVarKey
Puntero a VARIANT para la transferencia del nombre de variable, ID de variable o VARIANT
sencillo si solo se indica una variable que identifica las variables que hay que modificar.
lpvdmValue
Puntero al nuevo valor de las variables que hay que modificar.
dwTimeOut
Tiempo de espera máximo de la aplicación en "ms". Si no se han escrito todas las variables
una vez transcurrido el tiempo de espera, se llama la función Callback con los códigos de
error correspondientes.
lpfnCompletition
Puntero a la función Callback que se llama después de actualizar todas las variables
solicitadas o una vez transcurrido el tiempo de espera.
Si un programa activa una rutina Notify, deberá vaciar periódicamente su cola de mensajes.
Los mensajes no recogidos pueden bloquear las notificaciones de WinCC y, con ello, todo
WinCC.
En algunos casos excepcionales puede ocurrir que se suministre Notify antes de que retorne
la llamada de función.
fFlags
Con fFlags se especifica cómo se procesa el texto de aviso:
lpszMessage
Texto del aviso que se entrega.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero no es evaluado por la función, sino
que se proporciona de nuevo en la función Callback.
lpdmError
Puntero a la primera de las estructuras de error dwItems del tipo "CMN_ERROR". Si se
produce un error al escribir una variable, el sistema escribe la información de error en la
estructura correspondiente. No hay que olvidar reservar espacio para estas estructuras.
Valor de retorno
TRUE
Variables modificadas
FALSE
Error
Observación
Encontrará más información acerca de la modificación de valores de variable en la función
"DMSetValueExStr".
Mensajes de error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Funciones relacionadas
Descripción
Para que la aplicación pueda ser notificada de la correcta modificación de los valores de
variables, es preciso facilitar una función Callback del tipo DM_COMPLETITION_PROC.
Declaración
BOOL ( * DM_COMPLETITION_PROC) (
DWORD dwTAID,
LPDWORD lpdmVarState,
DWORD dwItems,
LPVOID lpvUser);
Parámetro
dwTAID
ID de transacción que ha sido asignada por el administrador de datos a la función para
modificar los valores de variables.
lpdmVarState
Puntero al primer lugar de la memoria al que se agrega la información si el valor de la variable
se ha podido modificar correctamente o se han producido errores:
Un 0 (OK) significa que se ha enviado y modificado correctamente y que como mínimo existe
una de las variables indicadas. Si no existe ninguna de las variables indicadas, se recibe un
error con el estado DM_VARSTATE_INVALID_KEY.
dwItems
Número de modificaciones de variables cuyo estado se transmite en lpdmVarState.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
Los valores de retorno dependen de la implementación
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Si un programa activa una rutina Notify, deberá vaciar periódicamente su cola de mensajes.
Los mensajes no recogidos pueden bloquear las notificaciones de WinCC y, con ello, todo
WinCC.
En algunos casos excepcionales puede ocurrir que se devuelva Notify antes de que retorne
la llamada de función.
Archivos necesarios
dmclient.h
Funciones relacionadas
Consulte también
DMSetValueWait (Página 395)
DMSetValueWaitMessage (Página 401)
Declaración
BOOL DMShowVarPropertiesExStr (
LPCTSTR lpszProjectFile,
HWND hwndParent,
LPCTSTR lpszVariableName,
DWORD dwVariableID,
LPCMN_ERROR lpdmError);
Descripción
La función abre el cuadro de diálogo para editar las propiedades de variables.
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto con ruta y extensión.
El nombre del archivo de proyecto puede determinarse con "DMEnumOpenedProjects" o en
runtime con "DMGetRuntimeProject".
hwndParent
Handle en la ventana que se utiliza como ventana padre para el cuadro de diálogo.
lpszVariableName
Puntero al nombre de la variable cuyas propiedades se muestran.
SI "lpszVariableName" es "NULL", debe indicarse una "dwVariableID" válida. En caso
contrario, se emite el error "DM_E_PARAM".
dwVariableID
ID de la variable. No se utiliza si hay indicado un nombre en "lpszVariableName".
lpdmError
Puntero a los datos del aviso de error avanzado en la estructura "CMN_ERROR". En caso de
fallo, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Salir del cuadro de diálogo con "ACEPTAR".
FALSE
Salir del error o del diálogo con "Cancelar"
Mensajes de error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Ejemplos
Ejemplo de script "Button DMShowVarPropertiesExStr":
#include "apdefap.h"
void OnClick(char* lpszPictureName, char* lpszObjectName, char*
lpszPropertyName)
{
BOOL bRet = FALSE;
CHAR szProjectName[256];
CHAR szVariableName[256];
DWORD dwVariableID;
CMN_ERROR err;
HWND hwndParent;
szProjectName[0] = 0;
szVariableName[0] = 0;
dwVariableID = 0L;
memset(&err, 0, sizeof(err));
hwndParent = NULL;
memset(&err, 0, sizeof(err));
dwVariableID = GetTagDWord("dwVarKeyID_1");
printf("\r\n call DMShowVarPropertiesExStr with ID");
bRet = DMShowVarPropertiesExStr(szProjectName, hwndParent, NULL,
dwVariableID, &err);
if (!bRet)
{
printf("\r\n error DMShowVarPropertiesExStr: err=%ld,%ld,%ld,
%ld,%ld,[%s]",
err.dwError1, err.dwError2, err.dwError3, err.dwError4,
err.dwError5, err.szErrorText);
}
else
{
printf("\r\n DMShowVarPropertiesExStr OK!");
}
Utilización
La función abre el diálogo de selección de variables para el proyecto especificado. A diferencia
de ShowVarDatabaseMulti, sólo se selecciona una variable.
Declaración
BOOL DMShowVarDatabase (
LPCSTR lpszProjectFile,
HWND hwndParent,
LPDM_DLGOPTIONS lpdmOptions,
LPDM_VARFILTER lpdmFilter,
LPDM_VARKEY lpdmVarKey,
LPCMN_ERROR lpdmError);
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto, ruta y extensión incluidas.
hwndParent
Handle en la ventana que se utiliza como ventana padre para el cuadro de diálogo.
lpdmOptions
Puntero a la estructura DM_DLGOPTIONS (Página 219) con preajustes de cómo debe
comportarse el cuadro de diálogo. Si el puntero es NULL, se selecciona el cuadro de diálogo
estándar.
lpdmFilter
Puntero a la estructura de filtros DM_VARFILTER (Página 233). Si el puntero es NULL se
muestran todas las variables.
Sólo se soporta el filtrado por nombre de variable y tipo de variable. El filtrado de variables
por grupos y conexiones no está implementado.
lpdmVarKey
Puntero a la estructura DM_VARKEY (Página 242). Si deben mostrarse las propiedades de
una variable, lpdmVarKey contiene la clave de esta variable al salir del cuadro de diálogo.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Salir del cuadro de diálogo con "ACEPTAR".
FALSE
Error o salir del cuadro de diálogo con "CANCELAR".
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Consulte también
DM_VARKEY (Página 242)
DM_VARFILTER (Página 233)
DM_DLGOPTIONS (Página 219)
DMShowVarDatabaseMulti (Página 416)
Declaración
BOOL DMShowVarDatabaseExStr (
LPCTSTR lpszProjectFile,
HWND hwndParent,
LPDM_DLGOPTIONS lpdmOptions,
LPDM_VARFILTER lpdmFilter,
LPTSTR* lppszVariableName,
LPDWORD lpdwVarNameCharCount,
LPDWORD lpdwVariableID,
LPCMN_ERROR lpdmError);
Descripción
La función abre el cuadro de diálogo de selección de variables para el proyecto especificado.
A diferencia de "ShowVarDatabaseMultiExStr", solo puede seleccionarse una variable.
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto con ruta y extensión.
El nombre del archivo de proyecto puede determinarse con "DMEnumOpenedProjects" o en
runtime con "DMGetRuntimeProject".
hwndParent
Handle en la ventana que se utiliza como ventana padre para el cuadro de diálogo.
lpdmOptions
Puntero a la estructura "DM_DLGOPTIONS" con especificaciones de cómo debe comportarse
el cuadro de diálogo; con "NULL", se corresponde con el cuadro de diálogo estándar.
lpdmFilter
Puntero a la estructura de filtro "DM_VARFILTER". Con "NULL", se muestran todas las
variables.
Solo se admite el filtrado por nombre y tipo de variable. El filtrado de variables por grupos y
conexiones no está implementado.
lppszVariableName
Puntero a puntero del búfer de retorno para el nombre de variable.
Si está indicado "NULL", debe haber un puntero válido a "lpdwVariableID". Entonces se
suministrará solo la ID y no el nombre. "dwVarNameCharCount" no se tiene en cuenta. Si
ambos punteros son "NULL", se devuelve "DM_E_PARAM".
Si el puntero interno es "NULL", se asigna y se devuelve el búfer. El tamaño se devuelve en
"lpdwVarNameCharCount".
lpdwVarNameCharCount
Puntero a un "DWORD" en el que se guarda el tamaño del búfer de retorno. El tamaño
seleccionado debe ser suficiente para que pueda guardarse el nombre de variable con
terminación nula.
Si el búfer es demasiado pequeño, se guarda el nombre cortado y se devuelve el error
"DM_E_OOM".
lpdwVariableID
Puntero a un "DWORD" en el que se guarda la ID de variable.
Si está indicado "NULL", debe haber un puntero válido a "lpszVariableName" y un tamaño
válido en "dwVarNameCharCount". Entonces se devolverá solo el nombre de variable.
El retorno de la ID de variable ya no puede garantizarse (p. ej., variables Package,
determinadas variables S7, etc.). En estos casos se suministra "0".
Si es necesario, bajo ciertas condiciones puede completarse la información con una llamada
consecutiva de "DMGetVarInfoExStr".
lpdmError
Puntero a los datos del aviso de error avanzado en la estructura "CMN_ERROR". En caso de
fallo, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Salir del cuadro de diálogo con "ACEPTAR".
FALSE
Error o salir del cuadro de diálogo con "CANCELAR".
Mensajes de error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Funciones relacionadas
Ejemplos
Ejemplo de script "Button DMShowVarDatabaseExStr":
#include "apdefap.h"
void OnClick(char* lpszPictureName, char* lpszObjectName, char*
lpszPropertyName)
{
BOOL bRet = FALSE;
CMN_ERROR err;
CHAR szProjectName[256];
HWND hwndParent;
CHAR szVariableName[256];
LPSTR pszVariableName;
DWORD dwVarNamCharCount = 256;
DWORD dwVarID = 0L;
szProjectName[0] = 0;
szVariableName[0] = 0;
hwndParent = NULL;
pszVariableName= szVariableName;
memset(&err, 0, sizeof(err));
Utilización
La función abre el diálogo de selección de variables para el proyecto especificado. A diferencia
de ShowVarDatabase, se pueden seleccionar varias variables.
Declaración
BOOL DMShowVarDatabaseMulti (
LPCSTR lpszProjectFile,
HWND hwndParent,
LPDM_DLGOPTIONS lpdmOptions,
LPDM_VARFILTER lpdmFilter,
LPDWORD lpdwItems,
DM_NOTIFY_SELECT_VAR_PROC lpfnVariables,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto se determina con DMEnumOpenedProjects o en RT con
DMGetRuntimeProject.
hwndParent
Handle en la ventana que se utiliza como ventana padre para el cuadro de diálogo.
lpdmOptions
Puntero a la estructura DM_DLGOPTIONS (Página 219) con preajustes de cómo debe
comportarse el cuadro de diálogo. Si es NULL, se utiliza el cuadro de diálogo estándar.
lpdmFilter
Puntero a la estructura de filtros DM_VARFILTER (Página 233). En caso de NULL, se
muestran todas las variables.
Sólo se soporta el filtrado por nombre de variable y tipo de variable. El filtrado de variables
por grupos y conexiones no está implementado.
lpdwItems
Puntero a un búfer DWORD que incluye el número de variables seleccionadas.
lpfnVariables
Puntero a la función Callback que se llama para cada variable seleccionada.
lpvUser
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Salir del cuadro de diálogo con "ACEPTAR".
FALSE
Error o salir del cuadro de diálogo con "CANCELAR".
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Consulte también
DM_VARFILTER (Página 233)
DMShowVarDatabase (Página 411)
DM_DLGOPTIONS (Página 219)
DM_NOTIFY_SELECT_VAR_PROC (Página 422)
Declaración
BOOL DMShowVarDatabaseMultiExStr (
LPCTSTR lpszProjectFile,
HWND hwndParent,
LPDM_DLGOPTIONS lpdmOptions,
LPDM_VARFILTER lpdmFilter,
LPDWORD lpdwItems,
DM_NOTIFY_SELECT_VAR_PROC_EXSTR lpfnVariables,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Descripción
La función abre el cuadro de diálogo de selección de variables para el proyecto especificado.
A diferencia de "ShowVarDatabaseExStr", se pueden seleccionar varias variables.
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto con ruta y extensión.
El nombre del archivo de proyecto puede determinarse con "DMEnumOpenedProjects" o en
runtime con "DMGetRuntimeProject".
hwndParent
Handle en la ventana que se utiliza como ventana padre para el cuadro de diálogo.
lpdmOptions
Puntero a la estructura "DM_DLGOPTIONS" con especificaciones de cómo debe comportarse
el cuadro de diálogo; con "NULL", se corresponde con el cuadro de diálogo estándar.
lpdmFilter
Puntero a la estructura de filtro "DM_VARFILTER". Con "NULL", se muestran todas las
variables.
Solo se admite el filtrado por nombre y tipo de variable. El filtrado de variables por grupos y
conexiones no está implementado.
lpdwItems
Puntero a un búfer DWORD que incluye el número de variables seleccionadas en total.
lpfnVariables
Puntero a la función Callback que se llama para cada variable seleccionada.
lpvUser
Puntero a datos específicos de la aplicación. El puntero no es evaluado por la función, sino
que vuelve a ponerse a disposición en la función Callback.
lpdmError
Puntero a los datos del aviso de error avanzado en la estructura "CMN_ERROR". En caso de
fallo, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Salir del cuadro de diálogo con "ACEPTAR".
FALSE
Error o salir del cuadro de diálogo con "CANCELAR".
Mensajes de error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Funciones relacionadas
Ejemplos
Ejemplo de script "Button DMShowVarDatabaseMultiExStr":
#include "apdefap.h"
void OnClick(char* lpszPictureName, char* lpszObjectName, char*
lpszPropertyName)
{
extern BOOL DM_NotifySelectVarProcA(LPCSTR lpszVariableName, DWORD
dwVariableID, LPVOID lpvUser);
szProjectName[0] = 0;
hwndParent = NULL;
memset(&err, 0, sizeof(err));
dwItems = 0;
dwInxDecr = 4; /*for decrement index to save in DM tags from callback
set to lpvUser*/
}
else
{
printf("\r\n DMShowVarDatabaseExStrMulti OK!");
printf("\r\n [%ld] Var's selected", dwItems);
}
pdwInxDecr = (DWORD*)lpvUser;
return bRet;
}
Descripción
Para poder evaluar las variables seleccionadas en el diálogo de selección con la función
DMShowVarDatabaseMulti, es preciso facilitar una función Callback del tipo
DM_NOTIFY_SELECT_VAR_PROC.
Declaración
BOOL ( * DM_NOTIFY_SELECT_VAR_PROC) (
LPDM_VARKEY lpdmVarKey,
DWORD dwItem,
LPVOID lpvUser);
Parámetro
lpdmVarKey
Puntero a la primera de las estructuras del tipo DM_VARKEY (Página 242) con el nombre y
el identificador de una variable.
dwItem
Número de estructuras transmitidas en lpdmVarKey.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
La enumeración continúa.
FALSE
La enumeración se cancela.
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
dmclient.h
Funciones relacionadas
Consulte también
DM_VARKEY (Página 242)
DMShowVarDatabaseMulti (Página 416)
Utilización
Crea una variable o comprueba si existe una. Esta función sólo puede aplicarse a variables
temporales, variables $.
Declaración
BOOL GAPICreateNewVariable (
LPMCP_NEWVARIABLE_DATA pData,
LPCMN_ERROR lpdmError);
Parámetro
pData
Puntero a la estructura MCP_NEWVARIABLE_DATA (Página 245) con los datos de las
variables.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Variable creada.
Al comprobar: La variable no existe.
FALSE
Error.
Al comprobar con Errorcode1 = DM_E_ALREADY_EXIST: La variable existe
Comentario
Hay funciones más avanzadas.
GAPICreateNewVariable4
GAPICreateNewVariableEx4
GAPICreateNewVariable5
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Consulte también
MCP_NEWVARIABLE_DATA (Página 245)
GAPICreateNewVariable4 (Página 425)
Utilización
Crea una variable o comprueba si existe una. Esta función sólo puede aplicarse a variables
temporales, variables $.
Esta función se diferencia de GAPICreateNewVariable por la posible indicación de datos de
escala.
Declaración
BOOL GAPICreateNewVariable4 (
LPMCP_NEWVARIABLE_DATA_4 pData,
LPCMN_ERROR lpdmError);
Parámetro
pData
Puntero a la estructura MCP_NEWVARIABLE_DATA_4 (Página 248) con los datos de las
variables.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Variable creada.
Al comprobar: La variable no existe.
FALSE
Error.
Al comprobar con Errorcode1 = DM_E_ALREADY_EXIST: La variable existe.
Comentario
Hay funciones más avanzadas.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Consulte también
GAPICreateNewVariable (Página 423)
MCP_NEWVARIABLE_DATA_4 (Página 248)
GAPICreateNewVariable5 (Página 426)
GAPICreateNewVariableEx4 (Página 428)
Utilización
Crea una variable o comprueba si existe una. Esta función sólo puede aplicarse a variables
temporales, variables $.
Esta función se diferencia de GAPICreateNewVariable4 por la indicación del causante y
porque los valores iniciales y de sustitución también se pueden indicar para variables de texto.
Declaración
BOOL GAPICreateNewVariable5 (
DWORD dwCreatorID,
LPMCP_NEWVARIABLE_DATA_5 pData,
LPCMN_ERROR lpdmError);
Parámetro
dwCreatorID
La identificación del causante indica quién ha creado un objeto.
Los valores 0 – 10100 y 11000 - 11100 son internos o están reservados para determinados
sistemas.
pData
Puntero a la estructura MCP_NEWVARIABLE_DATA_5 (Página 250) con los datos de las
variables.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Variable creada.
Al comprobar: La variable no existe.
FALSE
Error.
Al comprobar con Errorcode1 = DM_E_ALREADY_EXIST: La variable existe.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Consulte también
GAPICreateNewVariable (Página 423)
GAPICreateNewVariable4 (Página 425)
MCP_NEWVARIABLE_DATA_5 (Página 250)
GAPICreateNewVariableEx4 (Página 428)
MCP_VARIABLE_LIMITS5 (Página 263)
Utilización
Crea una variable o comprueba si existe una. Esta función sólo puede aplicarse a variables
temporales, variables $.
Esta función se diferencia de GAPICreateNewVariable4 por la indicación del causante.
Declaración
BOOL GAPICreateNewVariableEx4 (
DWORD dwCreatorID,
LPMCP_NEWVARIABLE_DATA_4 pData,
LPCMN_ERROR lpdmError);
Parámetro
dwCreatorID
La identificación del causante indica quién ha creado un objeto.
Los valores 0 – 10100 y 11000 - 11100 son internos o están reservados para determinados
sistemas.
pData
Puntero a la estructura MCP_NEWVARIABLE_DATA_4 (Página 248) con los datos de las
variables.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Variable creada.
Al comprobar: La variable no existe.
FALSE
Error.
Al comprobar con Errorcode1 = DM_E_ALREADY_EXIST: La variable existe.
Comentario
Hay una función más avanzada.
GAPICreateNewVariable5
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Consulte también
GAPICreateNewVariable (Página 423)
GAPICreateNewVariable4 (Página 425)
MCP_NEWVARIABLE_DATA_4 (Página 248)
GAPICreateNewVariable5 (Página 426)
Utilización
La función proporciona los nombres de las variables pertenecientes a una variable
estructurada.
Declaración
BOOL GAPIEnumTypeMembers (
LPCSTR lpszProjectFile,
LPCSTR lpszTypeName,
DM_ENUM_TYPEMEMBERS_PROC lpfnCallback,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto se determina con DMEnumOpenedProjects o en runtime
con DMGetRuntimeProject.
Al indicar una cadena vacía se ejecuta un DMEnumOpenedProjects interno en el proyecto
que está abierto.
En runtime sólo puede especificarse el proyecto que está abierto. Las demás indicaciones se
rechazan con error (DM_E_NOT_CONNECTED).
lpszTypeName
Nombre del tipo de una variable estructurada cuyas variables deben listarse.
lpfnCallback
Puntero a la función Callback que se llama para cada variable.
lpvUser
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Listar variables de una variable estructurada.
FALSE
Error.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Consulte también
DM_ENUM_TYPEMEMBERS_PROC (Página 431)
GAPIEnumTypeMembersEx (Página 433)
GAPIEnumTypeMembersEx4 (Página 437)
Descripción
Para poder evaluar los nombres de variable listados en el sistema, es preciso facilitar una
función Callback del tipo DM_ENUM_TYPEMEMBERS_PROC.
Declaración
BOOL ( * DM_ENUM_TYPEMEMBERS_PROC) (
LPCSTR lpszMemberName,
LPVOID lpvUser);
Parámetro
lpszStructTypeName
Puntero al nombre de las variables pertenecientes a una variable estructurada.
lpvUser
Puntero a datos específicos de aplicación. Este puntero vuelve a estar disponible en la función
Callback.
Valor de retorno
TRUE
La enumeración continúa.
FALSE
La enumeración se interrumpirá.
Nota
A ser posible, sólo deben copiarse datos. Los siguientes tipos de llamadas de función dentro
de Callback pueden producir Deadlocks o Stackoverflow:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones ODK de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Consulte también
GAPIEnumTypeMembers (Página 430)
Utilización
La función proporciona una descripción que incluye todos los valores predeterminados de las
variables pertenecientes a una variable estructurada, pero sin los datos de escala.
Si también se quieren leer los datos de escala, se necesita la función
GAPIEnumTypeMembersEx4.
Declaración
BOOL GAPIEnumTypeMembersEx (
LPCSTR lpszProjectFile,
LPCSTR lpszTypeName,
DM_ENUM_TYPEMEMBERS_PROC_EX lpfnCallback,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto se determina con DMEnumOpenedProjects o en runtime
con DMGetRuntimeProject.
Al indicar una cadena vacía se ejecuta un DMEnumOpenedProjects interno en el proyecto
que está abierto.
En runtime sólo puede especificarse el proyecto que está abierto. Las demás indicaciones se
rechazan con error (DM_E_NOT_CONNECTED).
lpszTypeName
Nombre del tipo de una variable estructurada cuyas variables deben listarse.
En los clientes sólo pueden enumerarse tipos de variables locales.
lpfnCallback
Puntero a la función Callback que se llama para cada variable.
lpvUser
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Variables de una variable estructurada listadas.
FALSE
Error.
Comentario
Hay una función más avanzada: GAPIEnumTypeMembersEx4.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Consulte también
GAPIEnumTypeMembers (Página 430)
DM_ENUM_TYPEMEMBERS_PROC_EX (Página 436)
GAPIEnumTypeMembersEx4 (Página 437)
Declaración
BOOL GAPIEnumTypeMembersExStr (
LPCTSTR lpszProjectFile,
LPCTSTR lpszTypeName,
DM_ENUM_TYPEMEMBERS_PROC_EXSTR lpfnCallback,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Descripción
La función proporciona una descripción que incluye todos los valores predeterminados de las
variables pertenecientes a una variable estructurada, pero sin los datos de escala.
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto con ruta y extensión.
El nombre del archivo de proyecto puede determinarse con "DMEnumOpenedProjects" o en
runtime con "DMGetRuntimeProject".
A partir de la versión V5.0 SP2 de WinCC, al indicar una cadena vacía se ejecuta un
"DMEnumOpenedProjects" interno con el proyecto que está abierto.
En runtime solo debe indicarse el proyecto que está abierto. A partir de la versión V5.0 SP2
de WinCC, si se indica algo diferente, los datos se rechazarán con el error
"DM_E_NOT_CONNECTED".
lpszTypeName
Nombre del tipo de una variable estructurada cuyas variables se muestran listadas.
En multiclientes (V5) y clientes (V6) solo pueden enumerarse tipos de variables locales.
lpfnCallback
Puntero a la función Callback que se llama para cada variable.
lpvUser
Puntero a datos específicos de la aplicación. El puntero no es evaluado por la función, sino
que vuelve a ponerse a disposición en la función Callback.
lpdmError
Puntero a los datos del aviso de error avanzado en la estructura "CMN_ERROR". En caso de
fallo, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Variables de una variable estructurada listadas
FALSE
Error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Funciones relacionadas
Descripción
Para poder evaluar las descripciones de variable listadas en el sistema, es preciso facilitar
una función Callback del tipo DM_ENUM_TYPEMEMBERS_PROC_EX.
Declaración
BOOL ( * DM_ENUM_TYPEMEMBERS_PROC_EX) (
LPDM_VARKEY lpdmVarKey,
LPMCP_NEWVARIABLE_DATA_EX lpdmVarDataEx,
LPVOID lpvUser);
Parámetro
lpdmVarKey
Puntero a la primera de las estructuras del tipo AUTOHOTSPOT con las claves (ID y nombre)
de una variable
lpdmVarDataEx
Puntero a una estructura del tipo MCP_NEWVARIABLE_DATA_EX (Página 252) con la
descripción de una variable.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
La enumeración continúa.
FALSE
La enumeración se cancela.
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
dmclient.h
Funciones relacionadas
Consulte también
GAPIEnumTypeMembersEx (Página 433)
MCP_NEWVARIABLE_DATA_EX (Página 252)
Utilización
La función proporciona una descripción completa que incluye todos los valores
predeterminados de las variables pertenecientes a una variable estructurada.
Declaración
BOOL GAPIEnumTypeMembersEx4 (
LPCSTR lpszProjectFile,
LPCSTR lpszTypeName,
DM_ENUM_TYPEMEMBERS_PROC_EX4 lpfnCallback,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto se determina con DMEnumOpenedProjects o en runtime
con DMGetRuntimeProject.
Al indicar una cadena vacía se ejecuta un DMEnumOpenedProjects interno en el proyecto
que está abierto.
En runtime sólo puede especificarse el proyecto que está abierto. Las demás indicaciones se
rechazan (DM_E_NOT_CONNECTED).
lpszTypeName
Nombre del tipo de una variable estructurada cuyas variables deben listarse.
En los clientes sólo pueden enumerarse tipos de variables locales.
lpfnCallback
Puntero a la función Callback que se llama para cada variable.
lpvUser
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Variables de una variable estructurada listadas.
FALSE
Error.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Consulte también
GAPIEnumTypeMembers (Página 430)
GAPIEnumTypeMembersEx (Página 433)
DM_ENUM_TYPEMEMBERS_PROC_EX4 (Página 439)
Descripción
Para poder evaluar las descripciones de variable listadas en el sistema, es preciso facilitar
una función Callback del tipo DM_ENUM_TYPEMEMBERS_PROC_EX4. Se diferencia de
DM_ENUM_TYPEMEMBERS_PROC_EX por la salida adicional de los datos de escala.
Declaración
BOOL ( * DM_ENUM_TYPEMEMBERS_PROC_EX4) (
LPDM_VARKEY lpdmVarKey,
LPMCP_NEWVARIABLE_DATA_EX4 lpdmVarDataEx,
LPVOID lpvUser);
Parámetro
lpdmVarKey
Puntero a la primera de las estructuras del tipo DM_VARKEY (Página 242) con las claves (ID
y nombre) de una variable
lpdmVarDataEx
Puntero a una estructura del tipo MCP_NEWVARIABLE_DATA_EX4 (Página 254) con la
descripción de una variable.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
La enumeración continúa.
FALSE
La enumeración se cancela.
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
dmclient.h
Funciones relacionadas
Consulte también
GAPIEnumTypeMembersEx4 (Página 437)
DM_VARKEY (Página 242)
MCP_NEWVARIABLE_DATA_EX4 (Página 254)
Utilización
La función lista los nombres y números de ID de los tipos de variable estructurada configurados
Declaración
BOOL GAPIEnumTypes (
LPCSTR lpszProjectFile,
DM_ENUM_TYPES_PROC lpfnCallback,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto se determina con DMEnumOpenedProjects o en runtime
con DMGetRuntimeProject.
Al indicar una cadena vacía se ejecuta un DMEnumOpenedProjects interno en el proyecto
que está abierto.
En runtime sólo puede especificarse el proyecto que está abierto. Las demás indicaciones se
rechazan con error (DM_E_NOT_CONNECTED).
lpfnCallback
Puntero a la función Callback que recibe los datos de los tipos de variables.
lpvUser
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Tipos de variables estructuradas listados.
FALSE
Error.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Ejemplos
Enumerate all structured types (Página 484)"DM01.cpp"
Consulte también
DM_ENUM_TYPES_PROC (Página 442)
Enumerate all structured types (Página 484)
Descripción
Para poder evaluar los tipos de variables listados en el sistema, es preciso facilitar una función
Callback del tipo DM_ENUM_TYPES_PROC.
Declaración
BOOL ( * DM_ENUM_TYPES_PROC) (
LPCSTR lpszTypeName,
DWORD dwTypeID,
DWORD dwCreatorID,
LPVOID lpvUser);
Parámetro
lpszTypeName
Puntero al nombre del tipo de variable.
dwTypeID
dwTypeID equivale a la identificación que GAPICreateType ha asignado para el tipo de
variable.
dwCreatorID
La identificación del causante indica quién ha creado un objeto.
Los valores 0 – 10100 y 11000 - 11100 son internos o están reservados para determinados
sistemas.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
La enumeración continúa.
FALSE
La enumeración se cancela.
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
dmclient.h
Funciones relacionadas
Ejemplos
Enumerate all structured types (Página 484)"DM01.cpp"
Consulte también
GAPIEnumTypes (Página 440)
Enumerate all structured types (Página 484)
Utilización
La función determina los datos de una conexión lógica configurada.
Declaración
BOOL DMEnumConnectionData (
LPCSTR lpszProjectFile,
LPDM_CONNKEY lpdmConnKey,
DWORD dwItems,
DM_ENUM_CONNECTION_PROC lpfnCallback,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto, ruta y extensión incluidas.
El nombre del archivo de proyecto se determina con DMEnumOpenedProjects o en runtime
con DMGetRuntimeProject.
lpdmConnKey
Puntero a la primera de las estructuras del tipo DM_CONNKEY (Página 215). En estas
estructuras se especifican las conexiones lógicas cuyos datos se enumeran.
dwItems
Número de conexiones lógicas cuyos datos se listan.
Con el valor 0 se inicia una lista de todas las conexiones.
lpfnCallback
Puntero a la función Callback que recibe los datos de la conexión lógica.
lpvUser
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Datos listados.
FALSE
Error.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Ejemplos
Enumerate all connections (Página 486)"DM01.cpp"
OnTestEnumConnectionDataAll (Página 491)"TESTCDoc.cpp"
Consulte también
DM_CONNKEY (Página 215)
DM_ENUM_CONNECTION_PROC (Página 447)
Enumerate all connections (Página 486)
OnTestEnumConnectionDataAll (Página 491)
Declaración
BOOL DMEnumConnectionDataExStr (
LPCTSTR lpszProjectFile,
DM_ENUM_CONNECTION_PROC_EXSTR lpfnCallback,
LPVOID lpvUser,
LPDWORD lpdwConnectionCount,
LPCMN_ERROR lpdmError);
Descripción
Con la función se determinan todas las conexiones lógicas configuradas.
Parámetro
lpszProjectFile
Puntero al nombre del archivo de proyecto con ruta y extensión.
El nombre del archivo de proyecto puede determinarse con "DMEnumOpenedProjects" o en
runtime con "DMGetRuntimeProject".
lpfnCallback
Puntero a la función Callback que recibe los datos de la conexión lógica.
lpvUser
Puntero a datos específicos de la aplicación. El puntero no es evaluado por la función, sino
que vuelve a ponerse a disposición en la función Callback.
lpdwConnectionCount
Puntero a un "DWORD" en el que se devuelve el número de conexiones existentes.
Con "lpfnCallback = NULL", primero se determina cuánta memoria se necesita para las
conexiones.
lpdmError
Puntero a los datos del aviso de error avanzado en la estructura "CMN_ERROR". En caso de
fallo, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Datos listados
FALSE
Error
Mensajes de error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Funciones relacionadas
Descripción
Para poder evaluar los datos de una conexión lógica listados en el sistema, es preciso facilitar
una función Callback del tipo DM_ENUM_CONNECTION_PROC.
Declaración
BOOL ( * DM_ENUM_CONNECTION_PROC) (
LPDM_CONNECTION_DATA lpdmConData,
LPVOID lpvUser);
Parámetro
lpdmConData
Puntero a una estructura del tipo DM_CONNECTION_DATA (Página 214) en la que están
guardados los datos de una conexión lógica.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
La enumeración continúa.
FALSE
La enumeración se cancela.
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
dmclient.h
Funciones relacionadas
Ejemplos
Enumerate all connections (Página 486)"DM01.cpp"
Consulte también
DM_CONNECTION_DATA (Página 214)
DMEnumConnectionData (Página 444)
Enumerate all connections (Página 486)
Utilización
Determina el sistema operativo que se utiliza en el PC.
Declaración
DWORD DMGetOSVersion (
VOID);
Parámetro
Ninguno.
Valor de retorno
El valor de retorno identifica el sistema operativo utilizado:
DM_OS_CHICAGO 3 Windows 95
DM_OS_2000 4 Windows 2000
DM_OS_XP 5 Windows XP
DM_OS_2003 6 Windows 2003
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Utilización
Retorna el código del idioma de configuración que se está utilizando.
Declaración
BOOL DMGetSystemLocale (
LPDWORD lpdwLocaleID,
LPCMN_ERROR lpdmError);
Parámetro
lpdwLocaleID
Puntero al código del idioma ajustado actualmente.
Los posibles valores de retorno son los códigos de idioma de:
Alemán 0x0407
Inglés 0x0409
Francés 0x040C
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Idioma de configuración ajustado actualmente determinado.
FALSE
Error
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
OnTestSystemLocale (Página 497)"TESTCDoc.cpp"
Consulte también
OnTestSystemLocale (Página 497)
Utilización
Inicia el cambio del idioma de configuración.
Declaración
BOOL DMSetLanguage (
DWORD dwLocaleID,
LPCMN_ERROR lpdmError);
Parámetro
dwLocaleID
Puntero al código del idioma que debe ajustarse. Los posibles valores son los códigos de
idioma de:
Alemán 0x0407
Inglés 0x0409
Francés 0x040C
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Idioma cambiado.
FALSE
Error.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Utilización
La función abre un cuadro de diálogo para seleccionar el idioma.
Declaración
BOOL DMShowLanguageDialog (
HWND hwndParent,
DWORD dwFlags,
DWORD dwSetLocaleIDs[],
UINT uSetIDArraySize,
LPDWORD lpdwGetLocaleID,
LPCMN_ERROR lpdmError);
Parámetro
hwndParent
Handle en la ventana que se utiliza como ventana padre para el cuadro de diálogo.
dwFlags
dwFlags identifica los idiomas que se muestran en el cuadro de diálogo y que pueden
seleccionarse:
dwSetLocaleIDs
Matriz con las IDs de los idiomas que deben mostrarse en el cuadro de diálogo.
uSetIDArraySize
Tamaño de la matriz dwSetLocaleIDs.
lpdwGetLocaleID
Puntero a un DWORD en el que debe depositarse la ID de idioma seleccionada.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Salir del cuadro de diálogo con "ACEPTAR".
FALSE
Error o salir del cuadro de diálogo con "CANCELAR".
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Utilización
Iniciar solicitud de actualización. En esta función se asigna una ID de transacción que identifica
la transacción.
Declaración
BOOL DMBeginStartVarUpdate (
LPDWORD pdwTAID
LPCMN_ERROR lpdmError )
Parámetro
pdwTAID
Puntero a una variable que, tras una correcta llamada de la función, contiene la ID de
transacción asignada por el administrador de datos.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Asignar ID de transacción.
FALSE
Error.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
OnTestVariablenBeginstartvarupdate (Página 498)"TESTCDoc.cpp"
Consulte también
OnTestVariablenBeginstartvarupdate (Página 498)
DMEndStartVarUpdate (Página 454)
DMResumeVarUpdate (Página 455)
DMStartVarUpdate (Página 457)
DMStartVarUpdateEx (Página 461)
DMStopVarUpdate (Página 473)
DMSuspendVarUpdate (Página 474)
Utilización
Tras una llamada correcta de la función, el administrador de datos aplica la actualización de
la variable y, si es necesario, transmite los nuevos valores a la aplicación.
Declaración
BOOL DMEndStartVarUpdate (
DWORD dwTAID,
LPCMN_ERROR lpdmError);
Parámetro
dwTAID
dwTAID contiene la ID de transacción asignada al llamar la función DMBeginStartVarUpdate.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Actualización iniciada.
FALSE
Error.
Mensajes de error
Archivos necesarios
dmclient.h
Funciones utilizadas
Ejemplos
OnTestVariablenEndstartvarupdate (Página 499)"TESTCDoc.cpp"
Consulte también
OnTestVariablenEndstartvarupdate (Página 499)
DMBeginStartVarUpdate (Página 453)
DMStartVarUpdate (Página 457)
Utilización
Inicia la actualización de todas las variables definidas con la transacción si durante la llamada
el contador de referencias de la transacción alcanza el valor 0.
La función calcula el equivalente a DMSuspendVarUpdate y siempre debe ser llamada de dos
en dos con él.
Declaración
BOOL DMResumeVarUpdate (
DWORD dwTAID,
LPCMN_ERROR lpdmError);
Parámetro
dwTAID
dwTAID contiene la ID de transacción asignada al llamar la función DMBeginStartVarUpdate.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Continuar la actualización.
FALSE
Error.
Comentario
Las transacciones disponen de un contador de referencias que se incrementa en cada llamada
de la función DMSuspendVarUpdate. Si la actualización de las variables debe continuarse,
DMResumeVarUpdate debe ser llamado varias veces hasta que el contador de referencias
vuelva a 0.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Ejemplos
OnTestVariablenResumevarupdate (Página 510)"TESTCDoc.cpp"
Consulte también
DMBeginStartVarUpdate (Página 453)
DMSuspendVarUpdate (Página 474)
OnTestVariablenResumevarupdate (Página 510)
Utilización
La función sirve para ajustar las variables que tiene que actualizar el administrador de datos.
En la función Callback, el administrador de datos transfiere, en caso de actualización, los
nuevos valores de variables a la aplicación.
DMStartVarUpdateEx es una función más avanzada en la que en la estructura
DM_VAR_UPDATE_STRUCTEX en el Callback DM_NOTIFY_VARIABLEEX_PROC se
proporciona además el QualityCode.
Declaración
BOOL DMStartVarUpdate (
DWORD dwTAID,
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
DWORD dwCycle,
DM_NOTIFY_VARIABLE_PROC lpfnVariable,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Parámetro
dwTAID
dwTAID contiene la ID de transacción asignada al llamar la función DMBeginStartVarUpdate.
lpdmVarKey
Puntero a la primera de las estructuras del tipo DM_VARKEY (Página 242) en las que se
especifican las variables que hay que actualizar.
dwItems
Número de variables que hay que actualizar en las estructuras DM_VARKEY transmitidas.
dwCycle
El ciclo de actualización determinado en dwCycle es válido para todas las variables ajustadas
con lpdmVarKey. El ciclo de actualización se define con el índice de entradas de la lista de
ciclos de actualización.
lpfnVariable
Puntero a la función Callback DM_NOTIFY_VARIABLE_PROC para transmitir datos a través
del administrador de datos.
Si lpfnVariable == NULL, la actualización en la memoria imagen de proceso del administrador
de datos se realiza al menos en el ciclo solicitado, siempre que sea posible físicamente por
la carga momentánea del sistema, el rendimiento del equipo, el medio de acoplamiento, etc.
No obstante, la determinación del valor correspondiente debe realizarse de forma
independiente llamando la función DMGetValue a través de la aplicación.
Si un programa inicia una rutina Notify, debe vaciar periódicamente su Message Queue. Los
mensajes no recogidos pueden bloquear las notificaciones de WinCC y, con ello, todo WinCC.
En algunos casos excepcionales sucede que Notify ya se ha entregado antes de que se
devuelva la llamada de función.
lpvUser
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Variables de actualización definidas.
FALSE
Error.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Consulte también
DMEndStartVarUpdate (Página 454)
DM_VARKEY (Página 242)
DMBeginStartVarUpdate (Página 453)
DM_NOTIFY_VARIABLE_PROC (Página 459)
Descripción
Para poder evaluar los datos determinados en el sistema, es preciso facilitar una función
Callback del tipo DM_NOTIFY_VARIABLE_PROC.
Declaración
BOOL ( * DM_NOTIFY_VARIABLE_PROC) (
DWORD dwTAID,
LPDM_VAR_UPDATE_STRUCT lpdmvus,
DWORD dwItems,
LPVOID lpvUser);
Parámetro
dwTAID
IDs de transacción que el administrador de datos ha asignado a la función que realiza la
llamada.
lpdmvus
Puntero a la primera de las estructuras del tipo DM_VAR_UPDATE_STRUCT (Página 228)
que contienen los valores de las variables solicitadas.
dwItems
Número de estructuras transmitidas en lpdmvus (equivale al número de valores de variables
proporcionados).
lpvUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
Los valores de retorno dependen de la implementación
Observación
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Si un programa activa una rutina Notify, deberá vaciar periódicamente su cola de mensajes.
Los mensajes no recogidos pueden bloquear las notificaciones de WinCC y, con ello, todo
WinCC.
En algunos casos excepcionales puede ocurrir que se devuelva Notify antes de que retorne
la llamada de función.
Archivos necesarios
dmclient.h
Funciones relacionadas
DMGetValueWait (Página 355) Determinar los valores de las variables con actua‐
lización
DMStartVarUpdate (Página 457) Definir variables de actualización
Consulte también
DMStartVarUpdate (Página 457)
DM_VAR_UPDATE_STRUCT (Página 228)
DMGetValueWait (Página 355)
Utilización
La función sirve para ajustar las variables que tiene que actualizar el administrador de datos.
En la función Callback, el administrador de datos transfiere, en caso de actualización, los
nuevos valores de variables a la aplicación.
A diferencia de DMStartVarUpdate, en la estructura DM_VAR_UPDATE_STRUCTEX se
proporciona el Quality Code que se devuelve en el Callback
DM_NOTIFY_VARIABLEEX_PROC .
Declaración
BOOL DMStartVarUpdateEx (
DWORD dwTAID,
LPDM_VARKEY lpdmVarKey,
DWORD dwItems,
DWORD dwCycle,
DM_NOTIFY_VARIABLEEX_PROC lpfnVariable,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Parámetro
dwTAID
dwTAID contiene la ID de transacción asignada al llamar la función DMBeginStartVarUpdate.
lpdmVarKey
Puntero a la primera de las estructuras del tipo DM_VARKEY (Página 242) en las que se
especifican las variables que hay que actualizar.
dwItems
Número de variables que hay que actualizar en las estructuras DM_VARKEY transmitidas.
dwCycle
El ciclo de actualización determinado es válido para todas las variables ajustadas con
lpdmVarKey . El ciclo de actualización se define con el índice de entradas de la lista de ciclos
de actualización.
lpfnVariable
Puntero a la función Callback DM_NOTIFY_VARIABLEEX_PROC para transmitir datos a
través del administrador de datos.
Si lpfnVariable == NULL, la actualización en la memoria imagen de proceso del administrador
de datos se realiza al menos en el ciclo solicitado, siempre que sea posible físicamente por
la carga momentánea del sistema, el rendimiento del equipo, el medio de acoplamiento, etc.
No obstante, la determinación del valor correspondiente debe realizarse de forma
independiente llamando la función DMGetValue a través de la aplicación.
Si un programa inicia una rutina Notify, debe vaciar periódicamente su Message Queue. Los
mensajes no recogidos pueden bloquear las notificaciones de WinCC y, con ello, todo WinCC.
lpvUser
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Variables de actualización definidas.
FALSE
Error.
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Consulte también
DM_VARKEY (Página 242)
DMBeginStartVarUpdate (Página 453)
DM_NOTIFY_VARIABLEEX_PROC (Página 470)
Declaración
BOOL DMStartVarUpdateExStr (
DWORD dwTAID,
DWORD dwFlags,
LPVARIANT lpvdmVarKey,
LPVARIANT lpvCookie,
DWORD dwCycle,
DM_NOTIFY_VARIABLEEX_PROC_EXSTR lpfnVariable,
LPVOID lpvUser,
LPCMN_ERROR lpdmError);
Descripción
La función sirve para ajustar las variables que tiene que actualizar el administrador de datos.
En la función Callback, el administrador de datos transfiere, en caso de actualización, los
nuevos valores de variables a la aplicación.
Parámetro
dwTAID
Contiene la ID de transacción asignada al llamar la función "DMBeginStartVarUpdate".
dwFlags
Si se necesita un retorno del nombre de variable en el VARIANT de la estructura
"DM_VAR_UPDATE_STRUCT_EXSTR" de "DM_NOTIFY_VARIABLE_PROC_EXSTR" en
formato "VT_LPSTR", aquí puede especificarse el indicador
"DM_FLAG_RETURN_PROPVARIANT_VT_LPSTR".
lpvdmVarKey
Puntero a VARIANT con "VT_ARRAY | VT_VARIANT" para la transferencia de la lista de
variables que identifica las variables que hay que modificar.
En el elemento de lista correspondiente se introduce una ID de variable con el tipo "VT_I4" y
el nombre de variable con "VT_BSTR". También es posible "VT_LPSTR" (PROPVARIANT)
para la transferencia como cadena ASCII asignada a fin de, p. ej., transferir nombres
constantes del script. "VT_LPSTR" se convierte entonces internamente en el tipo solicitado
"VT_BSTR".
En proyectos multicliente a partir de la versión V5.0 de WinCC, aquí también debe indicarse,
dado el caso, un prefijo de servidor en cada nombre (ver tipos de proyecto y versiones).
lpvCookie
Puntero a un VARIANT para una lista adicional de datos específicos de usuario para cada
variable.
Está pensado para sustituir "lpvUserData" del anterior "DM_VARKEY" y se devuelve también
en la estructura "DM_VAR_UPDATE_STRUCT_EXSTR" para cada variable.
dwCycle
El ciclo de actualización especificado es válido para todas las variables definidas con
"lpvdmVarKey". El ciclo de actualización se define con el índice de las entradas de la lista de
ciclos de actualización.
lpfnVariable
Puntero a la función Callback "DM_NOTIFY_VARIABLEEX_PROC" para transferir datos a
través del administrador de datos.
Con "lpfnVariable" == "NULL", la actualización en la memoria imagen de proceso del
administrador de datos se ejecuta al menos en el ciclo solicitado siempre que sea posible
físicamente en función de la carga momentánea del sistema, el rendimiento del equipo, el
medio de transmisión, etc. No obstante, la determinación del correspondiente valor debe
efectuarse con una llamada de la función "DMGetValue" mediante la aplicación.
Si un programa activa una rutina Notify, deberá vaciar periódicamente su cola de mensajes.
Los mensajes no recogidos pueden bloquear las notificaciones de WinCC y, con ello, todo
WinCC.
lpvUser
Puntero a datos específicos de la aplicación. El puntero no es evaluado por la función, sino
que vuelve a ponerse a disposición en la función Callback.
lpdmError
Puntero a los datos del aviso de error avanzado en la estructura "CMN_ERROR". En caso de
fallo, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Variables de actualización definidas
FALSE
Error
Archivos necesarios
dmclient_exstr.h
dmclient.lib
dmclient.dll
Funciones relacionadas
Ejemplos
Ejemplo de script "Button DMStartVarUpdateExStr":
#include "apdefap.h"
void OnClick(char* lpszPictureName, char* lpszObjectName, char*
lpszPropertyName)
{
#pragma code ("OleAut32.dll")
//#include "OleAuto.h"
SAFEARRAY * SafeArrayCreateVector(VARTYPE vt, long lLbound, unsigned
int cElements );
HRESULT SafeArrayPtrOfIndex(SAFEARRAY FAR* psa, long FAR* rgIndices,
void HUGEP* FAR* ppvData );
HRESULT SafeArrayLock(SAFEARRAY FAR* psa);
HRESULT SafeArrayUnlock(SAFEARRAY FAR* psa);
#pragma code()
VARIANT vVarKey;
VARIANT* pvElem;
SAFEARRAY* parrayKeys;
HRESULT hr;
CMN_ERROR err;
BOOL bRet;
long lInx;
DWORD dwTAID;
DWORD dwFlags;
DWORD dwCycle;
memset(&err, 0, sizeof(err));
bRet = FALSE;
parrayKeys = NULL;
lInx = 0L;
dwFlags = DM_FLAG_RETURN_PROPVARIANT_VT_LPSTR;
//dwCycle = 3; /* 1sec*/
dwCycle = 0; /* on change*/
dwTAID = GetTagDWord("dwUpdTAID");
if (dwTAID)
{
printf("\r\nStartVarUpdate always running. Stop it before start
again!");
VariantInit(&vVarKey);
parrayKeys = SafeArrayCreateVector(VT_VARIANT, 0L, 4);
vVarKey.vt = VT_ARRAY | VT_VARIANT;
vVarKey.u.parray = parrayKeys;
SafeArrayLock(parrayKeys);
lInx = 0L;
hr = SafeArrayPtrOfIndex(parrayKeys, &lInx, &pvElem);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = "dwVal_1";
lInx = 1L;
hr = SafeArrayPtrOfIndex(parrayKeys, &lInx, &pvElem);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = "dwVal_2";
lInx = 2L;
hr = SafeArrayPtrOfIndex(parrayKeys, &lInx, &pvElem);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = "dwVal_3";
lInx = 3L;
hr = SafeArrayPtrOfIndex(parrayKeys, &lInx, &pvElem);
pvElem->vt = VT_LPSTR;
pvElem->u.pbVal = "dwVal_4";
SafeArrayUnlock(parrayKeys);
memset(&err, 0, sizeof(err));
bRet = DMStartVarUpdateExStr(dwTAID, dwFlags, &vVarKey, dwCycle,
DM_NotifyVariableProcExStr_VarUpdate,
NULL, &err);
if (FALSE == bRet)
{
memset(&err, 0, sizeof(err));
bRet = DMEndStartVarUpdate(dwTAID, &err);
if (FALSE == bRet)
{
printf("\r\n error DMEndStartVarUpdate (dwTAID=%ld): err=
%ld,%ld,%ld,%ld,%ld,[%s]",
dwTAID, err.dwError1, err.dwError2, err.dwError3,
err.dwError4, err.dwError5, err.szErrorText);
}
else
{
printf("\r\n DMEndStartVarUpdate (dwTAID=%ld) OK.", dwTAID);
}
}
else
{
printf("\r\n dwTAID == 0L ???");
}
BOOL DM_NotifyVariableProcExStr_VarUpdate(
DWORD dwTAID,
LPDM_VAR_UPDATE_STRUCT_EXSTRA lpdmvus,
DWORD dwItems,
LPVOID lpvUser)
{
BOOL bRet = FALSE;
int i = 0;
HRESULT hr = 0L;
#include "apdefap.h"
dwTAID = GetTagDWord("dwUpdTAID");
memset(&err, 0, sizeof(err));
bRet = FALSE;
if (dwTAID)
{
bRet = DMStopVarUpdate(dwTAID, &err);
if (FALSE == bRet)
{
printf("\r\n!!! error DMStopVarUpdate (dwTAID=%ld): err=%ld,
%ld,%ld,%ld,%ld,[%s] !!!\r\n",
dwTAID, err.dwError1, err.dwError2, err.dwError3,
err.dwError4, err.dwError5, err.szErrorText);
memset(&err, 0, sizeof(err));
bRet = DMStopAllUpdates(&err);
if (FALSE == bRet)
{
printf("\r\n!!! error DMStopAllUpdates (dwTAID=%ld):
err=%ld,%ld,%ld,%ld,%ld,[%s] !!!\r\n",
dwTAID, err.dwError1, err.dwError2, err.dwError3,
err.dwError4, err.dwError5, err.szErrorText);
}
else
{
printf("\r\n DMStopAllUpdates OK.");
}
}
else
{
printf("\r\n DMStopVarUpdate (dwTAID=%ld) OK.", dwTAID);
}
}
dwTAID = 0L;
SetTagDWord("dwUpdTAID",dwTAID);
}
Descripción
Para poder evaluar los datos determinados en el sistema, es preciso facilitar una función
Callback del tipo DM_NOTIFY_VARIABLEEX_PROC.
Declaración
BOOL ( * DM_NOTIFY_VARIABLEEX_PROC) (
DWORD dwTAID,
LPDM_VAR_UPDATE_STRUCTEX lpdmvus,
DWORD dwItems,
LPVOID lpvUser);
Parámetro
dwTAID
IDs de transacción que el administrador de datos ha asignado a la función que realiza la
llamada.
lpdmvus
Puntero a la primera de las estructuras del tipo DM_VAR_UPDATE_STRUCTEX
(Página 230) que contienen los valores de las variables solicitadas.
dwItems
Número de estructuras transmitidas en lpdmvus (equivale al número de valores de variables
proporcionados).
lpvUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
Los valores de retorno dependen de la implementación
Observación
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Si un programa activa una rutina Notify, deberá vaciar periódicamente su cola de mensajes.
Los mensajes no recogidos pueden bloquear las notificaciones de WinCC y, con ello, todo
WinCC.
En algunos casos excepcionales puede ocurrir que se devuelva Notify antes de que retorne
la llamada de función.
Archivos necesarios
dmclient.h
Funciones relacionadas
DMGetValueWaitEx (Página 357) Determinar los valores de las variables con actua‐
lización
DMStartVarUpdateEx (Página 461) Definir variables de actualización
Consulte también
DMStartVarUpdateEx (Página 461)
DM_VAR_UPDATE_STRUCTEX (Página 230)
DMGetValueWaitEx (Página 357)
Utilización
Finaliza todas las actualizaciones de variables solicitadas por la aplicación. Es preferible
llamar esta función al finalizar el módulo correspondiente.
Declaración
BOOL DMStopAllUpdates (
LPCMN_ERROR lpdmError);
Parámetro
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Actualización de variables finalizada.
FALSE
Error.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Ejemplos
OnTestVariablenStopallupdates (Página 513)"TESTCDoc.cpp"
Consulte también
OnTestVariablenStopallupdates (Página 513)
Utilización
Finaliza la actualización de variables de una transacción determinada.
Declaración
BOOL DMStopVarUpdate (
DWORD dwTAID,
LPCMN_ERROR lpdmError);
Parámetro
dwTAID
dwTAID contiene la ID de transacción asignada al llamar la función DMBeginStartVarUpdate.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Actualización de las variables finalizada.
FALSE
Error.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Ejemplos
OnTestVariablenStopvarupdate (Página 513)"TESTCDoc.cpp"
Consulte también
OnTestVariablenStopvarupdate (Página 513)
DMBeginStartVarUpdate (Página 453)
Utilización
Interrumpe la actualización de todas las variables definidas con la transacción.
Las variables se siguen actualizando dentro de la memoria imagen de proceso del
administrador de datos. No obstante, los valores actuales ya no se transfieren a la aplicación.
Declaración
BOOL DMSuspendVarUpdate (
DWORD dwTAID,
LPCMN_ERROR lpdmError);
Parámetro
dwTAID
dwTAID contiene la ID de transacción asignada al llamar la función DMBeginStartVarUpdate.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Actualización interrumpida.
FALSE
Error.
Comentario
Las transacciones disponen de un contador de referencias de manera que la función
DMSuspendVarUpdate pueda ser llamada varias veces para una transacción. Si la
transacción ya tiene el estado "SUSPENDED", sólo se incrementa el contador de referencias.
Para seguir actualizando, DMResumeVarUpdate debe ser llamado varias veces hasta que el
contador de referencias vuelva a 0.
Mensajes de error
Archivos necesarios
dmclient.h
dmclient.lib
dmclient.dll
Funciones utilizadas
Ejemplos
OnTestVariablenSuspendvarupdate (Página 514)"TESTCDoc.cpp"
Consulte también
DMResumeVarUpdate (Página 455)
DMBeginStartVarUpdate (Página 453)
OnTestVariablenSuspendvarupdate (Página 514)
Ejemplo
// =====================================================================
// =====================================================================
// Desc. : Modul with examples for Data-Manager
// *********************************************************************
#include "stdafx.h" // if MFC classes
// #include "odkapi.h" // if console application
#include <time.h>
TCHAR g_szProjectFile[255] = {0};
TCHAR g_szDSNName[255] = {0};
#include "DM01.h"
//{{ODK_EXAMPLE}Connection to DM (MCP)}
//{{FUNCTION}DMGetConnectionState (MCP)}
//{{FUNCTION}DMConnect (MCP)}
//{{FUNCTION}DM_NOTIFY_PROC (MCP)}
//{{FUNCTION}DMDisConnect (MCP)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyDMConnect(void) ODK DM CS
// =====================================================================
BOOL MyDMConnect(void)
{
CMN_ERROR Error;
BOOL ret = FALSE;
TCHAR szText[255];
TCHAR szAppName[255];
VOID* pvUser = AfxGetApp();
_tcsncpy_s(szAppName, _countof(szAppName), _T("MyODKApp_23"), _TRUNCATE);
memset(&Error, 0,sizeof(CMN_ERROR));
ret = DMGetConnectionState(&Error);
if(FALSE == ret) // not connected
{
memset(&Error, 0,sizeof(CMN_ERROR));
ret = DMConnect(szAppName, MyDMNotifyCallback, pvUser, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in DMConnect: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("DMConnect"));
}
ODKTrace(szText);
}
// IMPLEMENTATION
// =====================================================================
// Function: MyDMGetConnectionState(void) ODK DM CS
// =====================================================================
BOOL MyDMGetConnectionState(void)
{
CMN_ERROR Error;
BOOL ret = FALSE;
TCHAR szText[255];
TCHAR szAppName[255];
VOID* pvUser = AfxGetApp();
_tcsncpy_s(szAppName, _countof(szAppName), _T("MyODKApp_23"), _TRUNCATE);
memset(&Error, 0,sizeof(CMN_ERROR));
ret = DMGetConnectionState(&Error);
if(FALSE == ret) // not connected
{
memset(&Error, 0,sizeof(CMN_ERROR));
ret = DMConnect(szAppName, MyDMNotifyCallback, pvUser, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in DMConnect: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("DMConnect"));
}
ODKTrace(szText);
//printf("%s\r\n",szText);
}
else // already connected
{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("DMGetConnectionState: OK"));
ODKTrace(szText);
}
return(ret);
}
// =====================================================================
// Function: MyDMDisConnect(void) ODK DM CS
// =====================================================================
BOOL MyDMDisConnect(void)
{
CMN_ERROR Error;
BOOL ret = FALSE;
TCHAR szText[255];
memset(&Error, 0, sizeof(CMN_ERROR));
ret = DMDisConnect(&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in DMConnect: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("DMDisconnect"));
}
ODKTrace(szText);
return(ret);
}
// =====================================================================
// Function: MyDMNotifyCallback
// =====================================================================
BOOL MyDMNotifyCallback(DWORD dwNotifyClass, DWORD dwNotifyCode, LPBYTE lpbyData,
DWORD dwItems, LPVOID lpvUser)
{
lpvUser;
lpbyData;
TCHAR szText[255];
_sntprintf_s(szText ,_countof(szText), _TRUNCATE, _T("**DMNotifyCallback**"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" NotifyClass = 0x
%08X"),dwNotifyClass);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" NotifyCode = 0x%08X"),
dwNotifyCode);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" Items = %d"), dwItems);
ODKTrace(szText);
//printf("%s\r\n",szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("********************"));
ODKTrace(szText);
return(TRUE);
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMConnect (Página 279)
DMDisconnect (Página 286)
DMGetConnectionState (Página 298)
Ejemplo
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMEnumVarData4 (Página 330)
DM_ENUM_VARIABLE_PROC4 (Página 332)
Ejemplo
BOOL MyDMEnumOpenedProjects(void)
{
CMN_ERROR Error;
BOOL ret= FALSE;
DWORD dwItems;
TCHAR szText[255];
VOID* pvUser = AfxGetApp();
memset(&Error, 0, sizeof(CMN_ERROR));
ret = MyDMConnect();
if(TRUE == ret)
{
ret = DMEnumOpenedProjects(&dwItems, MyDMEnumOpenProjectsCallback, pvUser, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
DMEnumOpenedProjects: E1= 0x%08lx ; E2= 0x%08lx ; %s"), %s",
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("DMEnumOpenedProjects"));
}
ODKTrace(szText);
}
return(ret);
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMEnumOpenedProjects (Página 306)
DM_ENUM_OPENED_PROJECTS_PROC (Página 307)
Ejemplo
void MyGAPIEnumTypes()
{
// #define PROJ_PATH "C:\\siemens\\odk\\samples\\projects\\demo\\odk.mcp"
CMN_ERROR Error;
BOOL ret = FALSE;
TCHAR szText[255];
TCHAR szProjectFile[255];
VOID* pvUser = NULL;
ret = FALSE;
memset(&Error,0,sizeof(CMN_ERROR));
ret = MyDMGetConnectionState(); //check the connection state to DM
if(FALSE != ret)
{
MyDMEnumOpenedProjects(); // open the DM and set the g_szProjectFile
_tcsncpy_s(szProjectFile, _countof(szProjectFile), /*PROJ_PATH*/g_szProjectFile,
_TRUNCATE);
memset(&Error,0,sizeof(CMN_ERROR));
ret = GAPIEnumTypes(szProjectFile,
MyDMEnumTypeCallback,
pvUser,
&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in DMEnumTypes: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Consulte también
GAPIEnumTypes (Página 440)
DM_ENUM_TYPES_PROC (Página 442)
Ejemplo
void MyDMEnumConnectionData()
{
// #define PROJ_PATH "C:\\siemens\\odk\\samples\\projects\\demo\\odk.mcp"
BOOL ret = FALSE;
CMN_ERROR Error;
TCHAR szText[255];
DWORD dwItems = 0;
TCHAR szProjectFile[255];
DM_CONNKEY ConnKey;
memset(&ConnKey,0,sizeof(ConnKey));
memset(&Error,0,sizeof(Error));
ret = MyDMGetConnectionState();
if(FALSE != ret)
{
MyDMEnumOpenedProjects(); // open the DM and set the g_szProjectFile
_tcsncpy_s(szProjectFile, _countof(szProjectFile), /*PROJ_PATH*/g_szProjectFile,
_TRUNCATE);
ret = DMEnumConnectionData(szProjectFile,
&ConnKey,
dwItems,
MyDMEnumConnectionCallback,
NULL,
&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
DMEnumConnectionData: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("DMEnumConnectionData"));
}
ODKTrace(szText);
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMEnumConnectionData (Página 444)
DM_ENUM_CONNECTION_PROC (Página 447)
Ejemplo
}
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMGetProjectInformation (Página 310)
Ejemplo
//{{ODK_EXAMPLE}OnTestDeactivateRuntimeProject (MCP)}
//{{FUNCTION}DMDeactivateRTProject (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestDeactivateRuntimeProject()
{
CCmnError cmnError;
if(!::DMDeactivateRTProject(cmnError))
{
cmnError.Show(__T("DMDeactivateRTProject failed\n"));
}
}
//{{ODK_EXAMPLE}(END)}
Ejemplo
//{{ODK_EXAMPLE}OnTestEnumGroupsAll (MCP)}
//{{FUNCTION}DMEnumVarGrpData (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestEnumGroupsAll()
{
CCmnError cmnError;
if(!::DMEnumVarGrpData((LPSTR)(LPCTSTR) m_strProject, NULL, 0, EnumVarGrpProc, this,
cmnError))
{
cmnError.Show(__T("DMEnumVarGrpData failed\n"));
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMEnumVarGrpData (Página 334)
Ejemplo
//{{ODK_EXAMPLE}OnTestEnumVariables (MCP)}
//{{FUNCTION}DMEnumVariables (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestEnumVariables()
{
DM_VARFILTER dmVarFilter;
memset( &dmVarFilter, 0, sizeof(DM_VARFILTER) );
//--------------------------------------------------
// Inicialización del filtro //
//--------------------------------------------------
// //
dmVarFilter.dwFlags = DM_VARFILTER_TYPE;
dmVarFilter.dwNumTypes = 3;
DWORD dwFilterTypes[3];
dwFilterTypes[0] = DM_VARTYPE_BIT;
dwFilterTypes[1] = DM_VARTYPE_DWORD;
dwFilterTypes[2] = DM_VARTYPE_DOUBLE;
dmVarFilter.pdwTypes = dwFilterTypes;
dmVarFilter.lpszName = __T("VAR_1_BIT");
dmVarFilter.lpszGroup = __T("VARGROUP_1");
dmVarFilter.lpszConn = __T("TF_CONN_1");
// //
//--------------------------------------------------
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if(!DMEnumVariables((LPSTR)(LPCTSTR) m_strProject, NULL/*&dmVarFilter*/,
EnumVariablesProc, this, &Error))
{
Error.Show(__T("DMEnumVariables failed\n"));
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMEnumVariables (Página 338)
Ejemplo
//{{ODK_EXAMPLE}OnTestEnumConnectionDataAll (MCP)}
//{{FUNCTION}DMEnumConnectionData (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestEnumConnectionDataAll()
{
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if( !::DMEnumConnectionData( m_strProject, NULL, 0, EnumConnectionDataProc, this,
&Error))
{
Error.Show(__T("DMEnumConnectionData failed\n"));
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMEnumConnectionData (Página 444)
Ejemplo
//{{ODK_EXAMPLE}OnTestMachines (MCP)}
//{{FUNCTION}DMGetMachineTable (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestMachines()
{
CMN_ERROR Error;
memset(&Error,0,sizeof(CMN_ERROR));
DM_MACHINE_TABLE dmMachineTable;
memset(&dmMachineTable, 0, sizeof(dmMachineTable));
if(!DMGetMachineTable(m_strProject, &dmMachineTable, &Error))
{
// Error.Show(__TEXT("DMGetMachineTable failed\n"));
// AfxMessageBox( strError );
}
else
{
for( int i = 0; i < dmmachinetable.nNumMachines; i++ )
{
CString strData;
strData.Format( _T( "equipo : %s, tipo : %s, ubicación : %s" ),
dmMachineTable.tm[i].szMachineName,
dmMachineTable.tm[i].fServer ? _T( "Server" ) : _T( "Cliente o ES" ),
dmMachineTable.tm[i].fLocal ? _T( "local" ) : _T( "remote" ));
PutStr( strData);
}
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMGetMachineTable (Página 302)
Ejemplo
//{{ODK_EXAMPLE}OnTestProjectInfo (MCP)}
//{{FUNCTION}DMGetProjectInformation (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestProjectInfo()
{
CCmnError cmnError;
DM_PROJECT_INFO ProjectInfo;
memset(&ProjectInfo, 0, sizeof(DM_PROJECT_INFO));
if(!DMGetProjectInformation(m_strProject, &ProjectInfo,
cmnError))
{
cmnError.Show(__TEXT("DMGetProjectInformation failed\n"));
}
else
{
CString strData;
strData.Format(_T("Projekt : %s, Data Source : %s,
DataLocale : %08X"),
ProjectInfo.szProjectFile,
ProjectInfo.szDSNName,
ProjectInfo.dwDataLocale );
PutStr(strData);
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMGetProjectInformation (Página 310)
Ejemplo
//{{ODK_EXAMPLE}OnTestProjectPaths (MCP)}
//{{FUNCTION}DMGetProjectDirectory (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestProjectPaths()
{
DM_DIRECTORY_INFO dmDirInfo;
CCmnError Error;
memset(&dmDirInfo, 0, sizeof(DM_DIRECTORY_INFO));
memset(&Error,0,sizeof(CCmnError));
if(!DMGetProjectDirectory(m_strAppName, m_strProject,
&dmDirInfo, &Error))
{
Error.Show(__TEXT("DMGetProjectDirectory failed\n"));
}
else
{
CString strData;
strData.Format(_T("szProjectDir = %s"), dmDirInfo.szProjectDir);
PutStr(strData);
strData.Format(_T("szProjectAppDir = %s"), dmDirInfo.szProjectAppDir);
PutStr(strData);
strData.Format(_T("szProjectGlobalLibDir = %s"), dmDirInfo.szGlobalLibDir);
PutStr(strData);
strData.Format(_T("szProjectLibDir = %s"), dmDirInfo.szProjectLibDir);
PutStr(strData);
strData.Format(_T("szLokalProjectAppDir = %s"), dmDirInfo.szLokalProjectAppDir);
PutStr(strData);
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMGetProjectDirectory (Página 309)
Ejemplo
//{{ODK_EXAMPLE}OnTestOpenProject (MCP)}
//{{FUNCTION}DMOpenProject (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestOpenProject()
{
#define PROJ_PATH "C:\\siemens\\odk\\samples\\projects\\demo\\odk.mcp"
TCHAR szProject[_MAX_PATH + 1];
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
CTestCliView* pView = GetFirstView();
memset(szProject,0, sizeof(szProject)); // Delete projectname to call dialog
// Or set fixed projectname
strcpy( szProject, _T(PROJ_PATH) );
if(!DMOpenProject(pView->GetSafeHwnd(),
szProject, NELEM(szProject), &Error))
{
Error.Show(__TEXT("DMOpenProject failed.\n"));
}
else
{
AfxMessageBox(szProject);
m_strProject = szProject;
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMOpenProjectPlus (Página 314)
Ejemplo
//{{ODK_EXAMPLE}OnTestOpenProjects (MCP)}
//{{FUNCTION}DMEnumOpenedProjects (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestOpenProjects()
{
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if(!DMEnumOpenedProjects(NULL, OpenProjectsProc, this, &Error))
{
Error.Show(__TEXT("DMEnumOpenedProjects failed\n"));
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMEnumOpenedProjects (Página 306)
Ejemplo
//{{ODK_EXAMPLE}OnTestRuntimeProject (MCP)}
//{{FUNCTION}DMGetRuntimeProject (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestRuntimeProject()
{
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
TCHAR szBuffer[_MAX_PATH + 1];
if(!DMGetRuntimeProject(szBuffer, NELEM(szBuffer), &Error))
{
Error.Show(__TEXT("DMGetRuntimeProject failed\n"));
}
else
{
PutStr(szBuffer);
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMGetRuntimeProject (Página 312)
Ejemplo
//{{ODK_EXAMPLE}OnTestSystemLocale (MCP)}
//{{FUNCTION}DMGetSystemLocale (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestSystemLocale()
{
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
DWORD dwLocaleID = 0;
if(!DMGetSystemLocale(&dwLocaleID, &Error))
{
Error.Show(__TEXT("DMGetSystemLocale failed\n"));
}
else
{
CString strData;
strData.Format(_T("Systemlocale : %08X"), dwLocaleID);
PutStr(strData);
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMGetSystemLocale (Página 449)
Ejemplo
//{{ODK_EXAMPLE}OnTestUpdateCycles (MCP)}
//{{FUNCTION}DMEnumUpdateCycles (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestUpdateCycles()
{
DWORD dwNumCalls = 0;
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if( !DMEnumUpdateCycles(m_strProject, &dwNumCalls,
EnumCyclesProc, this, &Error))
{
Error.Show(__TEXT("DMEnumUpdateCycles failed\n"));
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMEnumUpdateCycles (Página 290)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariblenBeginstartvarupdate (MCP)}
//{{FUNCTION}DMBeginStartVarUpdate (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenBeginstartvarupdate()
{
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if(!DMBeginStartVarUpdate(&m_dwTAID, &Error))
{
Error.Show(_T("DMBeginStartVarUpdate failed\n"));
}
else
{
CString strData;
strData.Format(_T("DMBeginStartVarUpdate: TAID:%lu."), m_dwTAID);
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMBeginStartVarUpdate (Página 453)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariablenEndstartvarupdate (MCP)}
//{{FUNCTION}DMEndStartVarUpdate (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenEndstartvarupdate()
{
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if( !DMEndStartVarUpdate(m_dwTAID, &Error))
{
Error.Show(_T("DMEndStartVarUpdate failed\n"));
}
else
{
CString strData;
strData.Format(_T("DMEndStartVarUpdate: TAID:%lu."), m_dwTAID);
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMEndStartVarUpdate (Página 454)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariablenGetvalue (MCP)}
//{{FUNCTION}DMGetValue (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenGetvalue()
{
int nNum = GetVarCount();
LPDM_VARKEY lpdmVarKey = GetVarKeys();
CCmnError Error;
memset(&Error, 0, sizeof(CCmnError));
// clear the given VARIANT's in every array element, because a VT_BSTR's can be
present
// do not only delete the array later without clearing the Variants here because
of memory leak's
VariantClear(&(lpdmvus2->dmValue));
}
}
delete []lpdmVarKey;
delete []lpdmvus;
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMGetValue (Página 342)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariablenGetvaluewait (MCP)}
//{{FUNCTION}DMGetValueWait (MCP)}
//{{FUNCTION}(END)}
//-----< Notification-Callback para GetValueWait >-----------------------------
BOOL GetValueWaitNotify(DWORD dwTAID,
LPDM_VAR_UPDATE_STRUCT lpdmvus,
DWORD dwItems,
LPVOID lpvUser)
{
dwTAID;
CTestCliDoc* pDoc = (CTestCliDoc*)lpvUser;
for(DWORD i=0; i <dwitems; i++)
{
LPDM_VAR_UPDATE_STRUCT lpdmvus2 = &lpdmvus[i];
CString strData;
switch(lpdmvus2->dmTypeRef.dwType)
{
case DM_VARTYPE_BIT:
if (lpdmvus2->dmValue.boolVal)
{
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tValor = TRUE,
Estado=%04x"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dwState);
}
else
{
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tValor = FALSE,
Estado=%04x"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dwState);
}
break;
case DM_VARTYPE_BYTE:
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tValor = %u, Estado=
%04x"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.bVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_SBYTE:
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tValor = %d, Estado=
%04x"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.bVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_WORD:
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tValor = %u, Estado=
%04x"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.iVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_SWORD:
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tValor = %d, Estado=
%04x"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.iVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_DWORD:
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tValor = %u, Estado=
%04x"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.lVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_SDWORD:
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tValor = %d, Estado=
%04x"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.lVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_FLOAT:
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tValor = %f, Estado=
%04x"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.fltVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_DOUBLE:
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tValor = %f, Estado=
%04x"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.dblVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_TEXT_8:
strData.Format(_T("GetValueWait: Variable: %s\t( ID = %d ):\tValor = %s, Estado=
%04x"),
lpdmvus2->dmVarKey.szName,
lpdmvus2->dmVarKey.dwID,
lpdmvus2->dmValue.bstrVal,
lpdmvus2->dwState);
break;
case DM_VARTYPE_RAW:
{
LPBYTE pArray;
HRESULT hr;
hr = SafeArrayAccessData(lpdmvus2->dmValue.parray, (VOID **) &pArray);
if (! FAILED(hr))
{
strData.Format(_T("Var:%s: Type:Dato sin formato\nValues:%02x %02x %02x %02x
\n"),
lpdmvus2->dmVarKey.szName,
pArray[0],
pArray[1],
pArray[2],
pArray[3]);
SafeArrayUnaccessData(lpdmvus2->dmValue.parray);
}
else
{
strData.Format(_T("Error de SafeArrayAccessData\n"));
}
break;
}
default:
strData.Format(_T("GetValueWait: Tipo de variable desconocido"));
}
pDoc->PutStr(strData);
}
return(TRUE);
}
Consulte también
DMGetValueWait (Página 355)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariblenGetVarInfo (MCP)}
//{{FUNCTION}DMGetVarInfo (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenGetVarInfo()
{
int nNum = GetVarCount();
LPDM_VARKEY lpdmVarKey = GetVarKeys();
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if(!::DMGetVarInfo(m_strProject, lpdmVarKey, nNum, &Error))
{
Error.Show(_T("DMGetVarInfo failed\n"));
}
else
{
CString strData;
for(int i=0; i<nnum; i++)
{
strData.Format(_T("DMGetVarInfo: Nombre de variable: %s, VarID:%lu."),
lpdmVarKey[i].szName,
lpdmVarKey[i].dwID);
PutStr(strData);
}
}
delete []lpdmVarKey;
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMGetVarInfo (Página 361)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariblenGetvarlimits (MCP)}
//{{FUNCTION}DMGetVarLimits (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenGetvarlimits()
{
int nNum = GetVarCount();
LPDM_VARLIMIT lpdmVarLimit = new DM_VARLIMIT[nNum];
memset(lpdmVarLimit, 0, sizeof(DM_VARLIMIT) * nNum);
LPDM_VARKEY lpdmVarKey = GetVarKeys();
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if(!::DMGetVarLimits(m_strProject, lpdmVarKey, nNum,
lpdmVarLimit, &Error))
{
Error.Show(__T("DMGetVarLimits failed\n"));
}
else
{
CString strData;
for(int i=0; i<nnum; i++)
{
strData.Format(_T("DMGetVarLimits: Var:%s, MaxRange:%lf, MinRange:%lf, MinLimit:
%lf, MaxLimit:%lf."),
lpdmVarKey[i].szName,
lpdmVarLimit[i].dmMaxRange.dblVal,
lpdmVarLimit[i].dmMinRange.dblVal,
lpdmVarLimit[i].dmMaxLimit.dblVal,
lpdmVarLimit[i].dmMinLimit.dblVal);
PutStr(strData);
}
}
delete []lpdmVarLimit;
delete []lpdmVarKey;
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMGetVarLimits (Página 373)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariblenGetvartype (MCP)}
//{{FUNCTION}DMGetVarType (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenGetvartype()
{
int nNum = GetVarCount();
LPDM_TYPEREF lpdmTypeRef = new DM_TYPEREF[nNum];
memset(lpdmTypeRef, 0, sizeof(DM_TYPEREF) * nNum);
LPDM_VARKEY lpdmVarKey = GetVarKeys();
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if(!::DMGetVarType(m_strProject, lpdmVarKey, nNum,
lpdmTypeRef, &Error))
{
Error.Show(_T("DMGetVarType failed\n"));
}
else
{
CString strData;
for(int i=0; i<nnum; i++)
{
strData.Format(_T("DMGetVarType: Var:%s, Size:%lu, Name:%s."),
lpdmVarKey[i].szName,
lpdmVarKey[i].dwID);
PutStr(strData);
}
}
delete []lpdmVarKey;
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMGetVarType (Página 379)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariblenResumevarupdate (MCP)}
//{{FUNCTION}DMResumeVarUpdate (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenResumevarupdate()
{
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if(!DMResumeVarUpdate(m_dwTAID, &Error))
{
Error.Show(_T("DMResumeVarUpdate failed.\n"));
}
else
{
CString strData;
strData.Format(_T("DMResumeVarUpdate ok."));
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMResumeVarUpdate (Página 455)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariablenSetvalue (MCP)}
//{{FUNCTION}DMSetValue (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenSetvalue()
{
int nNum = GetVarCount();
LPDM_VARKEY lpdmVarKey = GetVarKeys();
LPDWORD lpdmVarState = new DWORD[nNum];
INT i;
CString strData;
CCmnError cmnError;
for (i = 0; i < 1; i++)</p>
{
DWORD dwStart = GetTickCount();
DWORD dwEnd;
if (! DMSetValue(lpdmVarKey, nNum, m_varValues, lpdmVarState, cmnError))
{
break;
}
dwEnd = GetTickCount();
strData.Format("DMSetValue OK, Dauer %d ms", dwEnd - dwStart);
PutStr(strData);
}
delete []lpdmVarKey;
delete []lpdmVarState;
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMSetValue (Página 386)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariablenSetvaluewait (MCP)}
//{{FUNCTION}DMSetValueWait (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenSetvaluewait()
{
int nNum = GetVarCount();
LPDM_VARKEY lpdmVarKey = GetVarKeys();
LPDWORD lpdmVarState = new DWORD[nNum];
DWORD dwTimeOut = 1000L;
CCmnError cmnError;
if(!::DMSetValueWait(&m_dwTAID, lpdmVarKey,nNum, m_varValues,dwTimeOut,
CompletionProc, this, cmnError))
{
cmnError.Show(_T("DMSetValueWait failed\n"));
}
else
{
CString strData;
strData.Format(_T("DMSetValueWait ok."));
}
delete []lpdmVarKey;
delete []lpdmVarState;
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMSetValueWaitMessage (Página 401)
DMSetValueWait (Página 395)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariablenStopallupdates (MCP)}
//{{FUNCTION}DMStopAllUpdates (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenStopallupdates()
{
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if(!DMStopAllUpdates(&Error))
{
Error.Show(_T("DMStopAllUpdates failed\n"));
}
else
{
CString strData;
strData.Format(_T("DMStopAllUpdates ok."));
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMStopAllUpdates (Página 472)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariablenStopvarupdate (MCP)}
//{{FUNCTION}DMStopVarUpdate (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenStopvarupdate()
{
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if( !DMStopVarUpdate(m_dwTAID, &Error))
{
Error.Show(_T("DMStopVarUpdate failed\n"));
}
else
{
CString strData;
strData.Format(_T("DMStopVarUpdate: TAID:%lu."), m_dwTAID);
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMStopVarUpdate (Página 473)
Ejemplo
//{{ODK_EXAMPLE}OnTestVariablenSuspendvarupdate (MCP)}
//{{FUNCTION}DMSuspendVarUpdate (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestVariablenSuspendvarupdate()
{
CCmnError Error;
memset(&Error,0,sizeof(CCmnError));
if(!DMSuspendVarUpdate(m_dwTAID, &Error))
{
Error.Show(_T("DMSuspendVarUpdate failed\n"));
}
else
{
CString strData;
strData.Format(_T("DMSuspendVarUpdate ok."));
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMSuspendVarUpdate (Página 474)
Ejemplo
//{{ODK_EXAMPLE}OnTestWinCCShutdown (MCP)}
//{{FUNCTION}DMExitWinCC (MCP)}
//{{FUNCTION}(END)}
void CTestCliDoc::OnTestWinCCShutdown()
{
DMExitWinCC();
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMExitWinCC (Página 293)
Ejemplo
Consulte también
DMOpenProjectPlus (Página 314)
Ejemplo
// =====================================================================
// =====================================================================
// short : Modul with examples to DataManager-API
// RUNTIME
// SC: PO = Projekt opened PG= Projekt closed
// *********************************************************************
#include "stdafx.h" // if MFC classes
//#include "odkapi.h" // if console application
#include <time.h>
#include "dm02.h"
// =====================================================================
// 2.1 Interface IMPORT
// =====================================================================
//extern void ODKTrace(LPCTSTR);
extern BOOL MyDMConnect (void); // Connect
extern BOOL MyDMGetConnectionState(void);
// =====================================================================
// 2.2 Interface EXPORT
// =====================================================================
// =====================================================================
// 2.3 Interface LOCAL
// =====================================================================
// =====================================================================
// 3. Definitions
// =====================================================================
DM_VAR_UPDATE_STRUCT VarUp[nNum];
memset(&VarUp, 0, sizeof(DM_VAR_UPDATE_STRUCT) * nNum);
// the included VARIANT's in the DM_VAR_UPDATE_STRUCT's then initialized to VT_EMPTY
with the memset,
// don't do this later again, because VT_BSTR's can be present after DMGetValue(...)!
iOut, VarUp[iOut].dmVarKey.szName,
VarUp[iOut].dmVarKey.dwID,
VarUp[iOut].dmValue.bVal);
break;
}
case DM_VARTYPE_SBYTE: //vt = 2 VT_I2 = 2
{
sprintf(szText, "Index=%d Name=%s ID=%d Value=%d",
iOut, VarUp[iOut].dmVarKey.szName,
VarUp[iOut].dmVarKey.dwID,
VarUp[iOut].dmValue.iVal);
break;
}
case DM_VARTYPE_WORD: //vt = 3 VT_I4 = 3
{
sprintf(szText, "Index=%d Name=%s ID=%d Value=%d",
iOut, VarUp[iOut].dmVarKey.szName,
VarUp[iOut].dmVarKey.dwID,
VarUp[iOut].dmValue.lVal);
break;
}
case DM_VARTYPE_SWORD: //vt = 2 VT_I2 = 2
{
sprintf(szText, "Index=%d Name=%s ID=%d Value=%d",
iOut, VarUp[iOut].dmVarKey.szName,
VarUp[iOut].dmVarKey.dwID,
VarUp[iOut].dmValue.iVal);
break;
}
case DM_VARTYPE_DWORD: //vt = 5 VT_R8 = 5
{
sprintf(szText, "Index=%d Name=%s ID=%d Value=%d",
iOut, VarUp[iOut].dmVarKey.szName,
VarUp[iOut].dmVarKey.dwID,
VarUp[iOut].dmValue.dblVal);
break;
}
case DM_VARTYPE_SDWORD: //vt = 3 VT_I4 = 3
{
sprintf(szText, "Index=%d Name=%s ID=%d Value=%d",
iOut, VarUp[iOut].dmVarKey.szName,
VarUp[iOut].dmVarKey.dwID,
VarUp[iOut].dmValue.lVal);
break;
}
case DM_VARTYPE_FLOAT: //vt = 4 VT_R4 = 4
{
sprintf(szText, "Index=%d Name=%s ID=%d Value=%f",
iOut, VarUp[iOut].dmVarKey.szName,
VarUp[iOut].dmVarKey.dwID,
VarUp[iOut].dmValue.fltVal);
break;
}
case DM_VARTYPE_DOUBLE: //vt = 5 VT_R8 = 5
{
sprintf(szText, "Index=%d Name=%s ID=%d Value=%f",
iOut, VarUp[iOut].dmVarKey.szName,
VarUp[iOut].dmVarKey.dwID,
VarUp[iOut].dmValue.dblVal);
break;
}
case DM_VARTYPE_TEXT_8: //vt = 8 VT_BSTR = 8
{
ret = WideCharToMultiByte( CP_ACP,
(DWORD)0,VarUp[iOut].dmValue.bstrVal,
-1,(LPSTR)&BstrValue[0],128,NULL,NULL);
sprintf(szText, "Index=%d Name=%s ID=%d StrValue=%s",
iOut, VarUp[iOut].dmVarKey.szName,
VarUp[iOut].dmVarKey.dwID,BstrValue);
break;
}
case DM_VARTYPE_TEXT_16: // vt = 8 VT_BSTR = 8
{
ret = WideCharToMultiByte( CP_ACP,
(DWORD)0,VarUp[iOut].dmValue.bstrVal,
-1,(LPSTR)&BstrValue[0],128,NULL,NULL);
sprintf(szText, "Index=%d Name=%s ID=%d StrValue=%s",
iOut, VarUp[iOut].dmVarKey.szName,
VarUp[iOut].dmVarKey.dwID,BstrValue);
break;
}
default:
break;
}// end switch case
ODKTrace(szText);
//printf("%s\r\n",szText);
VariantClear( &VarUp[iOut].dmValue );
}//end for
}
else
{
sprintf(szText, "Error in DMGetValue: E1= 0x%08lx ; E2= 0x%08lx ; %s",
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
//printf("%s\r\n",szText);
}
}
else
{
sprintf(szText, "Error in DMGetRuntimeProject: E1= 0x%08lx ; E2= 0x%08lx ; %s",
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
//printf("%s\r\n",szText);
}
}
else
{
sprintf(szText, "Error in MyDMGetConnectionState: E1= 0x%08lx ; E2= 0x%08lx ; %s",
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
//printf("%s\r\n",szText);
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
DMGetRuntimeProject (Página 312)
DMGetValue (Página 342)
Ejemplo
Consulte también
DMGetRuntimeProject (Página 312)
DMSetValue (Página 386)
Sinopsis
Sinopsis
Sinopsis
Las funciones API pueden devolver los siguientes avisos de error en la estructura de error
CMN_ERROR:
Configuración
Runtime
Modo de direccionamiento
PDLRTInquireFreeArea
Ciclos de actualización
Nombre Índice
"Al cambiar" 0
"250 ms" 1
"500 ms" 2
"1 s" 3
"2 s" 4
"5 s" 5
"10 s" 6
"1 min" 7
"5 min" 8
"10 min" 9
"1 h" 10
"Ciclo de usuario 1" 11
"Ciclo de usuario 2" 12
"Ciclo de usuario 3" 13
"Ciclo de usuario 4" 14
"Ciclo de usuario 5" 15
"Ciclo de ventana" 235
"Ciclo de imagen" 255
2.3.1.5 Lista de las propiedades de objeto (A-K) (Graphics Designer) (RT Professional)
Resumen
Nota
En muchas funciones API del Graphics Designer es necesario asignar el parámetro
lpszPropName. En ese caso, hay que indicar el nombre inglés de una propiedad de objeto.
Las propiedades del tipo VT_USERDEFINED no pueden editarse con las funciones Get/Set-
Property.
No debe utilizarse VT_DISPATCH ni otras referencias, solo los tipos normales y como máximo
un VT_VARIANT para una propiedad de matriz de tipos simples.
"FillColor" VT_I4 Fill Pattern Co‐ Color de patrón Botón, elipse, segmen‐
lor de relleno to de elipse, círculo,
segmento circular, po‐
lígono, rectángulo, rec‐
tángulo redondeado,
texto estático, campo
E/S, barra, objeto grá‐
fico, lista de textos, ca‐
silla de verificación, bo‐
tón de opción, botón
redondo, objeto desli‐
zante,
"Filling" VT_BOO Dynamic Filling Relleno dinámico Botón, elipse, segmen‐
L to de elipse, círculo,
segmento circular, po‐
lígono, rectángulo, rec‐
tángulo redondeado,
texto estático, objeto
gráfico, casilla de veri‐
ficación, botón de op‐
ción, botón redondo,
"FillingIndex VT_I4 Fill Level Nivel de llenado Botón, elipse, segmen‐
to de elipse, círculo,
segmento circular, po‐
lígono, rectángulo, rec‐
tángulo redondeado,
texto estático, objeto
gráfico, casilla de veri‐
ficación, botón de op‐
ción, botón redondo,
objeto deslizante
"FillStyle" VT_UI4 Fill Pattern Patrón de relleno Botón, elipse, segmen‐
to de elipse, círculo,
segmento circular, po‐
lígono, rectángulo, rec‐
tángulo redondeado,
texto estático, campo
E/S, barra, objeto grá‐
fico, lista de textos, ca‐
silla de verificación, bo‐
tón de opción, botón
redondo, objeto desli‐
zante,
"FillStyle2" VT_UI4 Bar Pattern Patrón de barra Barra,
2.3.1.6 Lista de las propiedades de objeto (L-Z) (Graphics Designer) (RT Professional)
Resumen
Nota
En muchas funciones API del Graphics Designer es necesario asignar el parámetro
lpszPropName. En ese caso, hay que indicar el nombre inglés de una propiedad de objeto.
Las propiedades del tipo VT_USERDEFINED no pueden editarse con las funciones Get/Set-
Property.
No debe utilizarse VT_DISPATCH ni otras referencias, solo los tipos normales y como máximo
un VT_VARIANT para una propiedad de matriz de tipos simples.
"PictureObject‐
Path"
"PictureThumb" VT_USER PictureThumb PictureThumb SliderCtrl,
DEFINED
"PictureUp" VT_BSTR Picture Status Imagen estado Botón, botón redondo,
Off desactivada
"PicUpReferen‐ VT_BOOL Picture Off Re‐ Imagen desac‐ Botón redondo,
ced" ferenced tivada referen‐
ciada
"PicUpTranspa‐ VT_I4 Picture Off Imagen desac‐ Botón redondo,
rent" Transparent tivada color
Color transparente
"PicUpUse‐ VT_BOOL Picture Off Imagen desac‐ Botón redondo,
TransColor" Transparent tivada color
Color On transparente
activado
"PicUseTrans‐ VT_BOOL Picture Trans‐ Color transpa‐ Objeto gráfico,
Color" parent Color rente activado
On
"PointCount" VT_I4 Number of Cor‐ Número de es‐ Polígono, polilínea,
ners quinas
"Position" VT_I4 OCX Positions Posición SliderCtrl,
"PredefinedAn‐ VT_I4 BPC Angle Settings Ajustes de án‐ Barra 3D
gles" gulo
"Pressed" VT_BOOL Pressed Pulsado Botón redondo,
"Process" VT_R8 Process Driver Conexión de Barra 3D, objeto deslizan‐
Connection proceso te, barra,
"Process" VT_R8 Selected Bo‐ Campos selec‐ Casilla de verificación, bo‐
xes cionados tón de opción
"ProfileName"
"ProjectName"
"ProjectPath" VT_BSTR OCX ProjectPath ProjectPath CCAlgWinCtrl,
"Radius" VT_I4 Radio Radio Círculo, arco circular, seg‐
mento circular, botón re‐
dondo,
"RadiusHeight" VT_I4 Radio Y Radio Y Elipse, arco elíptico, seg‐
mento elíptico,
"RadiusWidth" VT_I4 Radio X Radio X Elipse, arco elíptico, seg‐
mento elíptico,
"RangeMax" VT_I4 OCX RangeMax RangeMax SliderCtrl,
"RangeMin" VT_I4 OCX RangeMin RangeMin SliderCtrl,
"ReferenceMo‐
veLeft"
"ReferenceMo‐
veTop"
"ReferenceRota‐ VT_I4 Rotation Refe‐ Referencia de Línea, polígono, polilínea,
tionLeft" rence X rotación X
"ReferenceRota‐ VT_I4 Rotation Refe‐ Referencia de Línea, polígono, polilínea,
tionTop" rence Y rotación Y
Sinopsis
API ha sido desarrollado para aplicaciones que funcionan dentro de aplicaciones propias. No
obstante, las llamadas de API en OCX integradas en imágenes Graphics pueden causar
problemas e incluso interbloqueos (deadlocks).
Declaración
typedef struct {
LINKTYPE LinkType;
DWORD dwCycle;
TCHAR szLinkName[256];
}
LINKINFO;
Miembros
LinkType
Para el tipo LINKTYPE deben utilizarse los valores definidos en el archivo "trigger.h" para
enum LinkType.
Nota
En futuras ampliaciones de la definición enum LinkType en trigger.h siempre deben agregarse
nuevas constantes detrás ya que, de lo contrario, se modifica la valencia listada arriba. Por
eso en las enumeraciones siempre debe utilizarse la definición y no el valor.
dwCycle
Tiempo de ciclo de la actualización. dwCycle identifica el orden dentro de la lista de ciclos de
actualización.
szLinkName
Nombre de la conexión de variable
Archivos necesarios
pdlrtapi.h
trigger.h
Funciones API
Consulte también
PDLRTGetLink (Página 592)
PDLRTSetLink (Página 594)
Declaración
typedef struct {
DWORD wArraySize;
LPMULTILINKINFO pLinkArray;
}
MULTILINK;
Miembros
wArraySize
Número de enlaces (número de estructuras del tipo MULTILINKINFO).
pLinkArray
Puntero a la primera de las estructuras wArraySize del tipo MULTILINKINFO (Página 557)
con información sobre el enlace entre una propiedad de objeto y una variable.
Archivos necesarios
pdlrtapi.h
Funciones API
PDLRTSetMultiLink (Página 596) Definir enlace entre propiedad de objeto y variable (varias va‐
riables)
Consulte también
PDLRTSetMultiLink (Página 596)
MULTILINKINFO (Página 557)
Declaración
typedef struct {
char* pszObjectName,
char* pszPropertyName,
LINKTYPE LinkType;
DWORD dwCycle;
char* pszLinkName;
}
MULTILINKINFO;
Miembros
IpszObjectName
Puntero al nombre del objeto.
IpszPropertyName
Puntero al nombre de la propiedad de objeto que hay que enlazar.
LinkType
Identifica el tipo de conexión.
dwCycle
Tiempo de ciclo de la actualización. dwCycle identifica el orden dentro de la lista de ciclos de
actualización.
pszLinkName
Puntero al nombre de la conexión
Observaciones
La estructura MULTILINKINFO forma parte de la estructura MULTILINK (Página 556).
Archivos necesarios
pdlrtapi.h
Consulte también
MULTILINK (Página 556)
Descripción
En la estructura se especifica qué objeto de una imagen tiene el cursor de runtime.
Declaración
typedef struct {
WCHAR szPicture[256];
WCHAR szObject[256];
}
FOCUSINFO;
Miembros
szPicture
Nombre de imagen
szObject
Nombre de objeto
Funciones API
Consulte también
PDLRTGetFocus (Página 575)
Utilización
Cierra una imagen en modo runtime.
Declaración
BOOL PDLRTClosePicture(
ADRMODE adrMode,
LPCSTR lpszPictureName,
LPCSTR lpszWName,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
PCMN_ERROR pError );
Parámetro
adrMode
El parámetro está reservado para posteriores ampliaciones y debe estar ocupado por defecto
por 0.
lpszPictureName
Puntero al nombre configurado de la imagen, sin ruta ni extensión.
Se diferencia entre mayúsculas y minúsculas.
lpszWName
Nombre del objeto de ventana que se cierra.
pfn
Puntero a la función Callback. Es llamado para informar al usuario de si la petición es correcta
o no.
Si se transmite pfn = NULL , la llamada es síncrona. La aplicación que realiza la llamada se
mantiene en espera hasta que PDLRT indica un error o un éxito. Este tipo de llamada debe
utilizarse preferiblemente para secuencias de llamadas interdependientes.
Si las siguientes llamadas API dependen de que esta función haya finalizado y se utilice de
forma asíncrona con Callback, las llamadas API deben sincronizarse con semáforos.
Es conveniente utilizar una función Callback propia para cada función API.
pvUser
Puntero a datos específicos de la aplicación que se pasan a la función Callback. Este puntero
no es evaluado por la función, sino que vuelve a estar disponible en la función Callback.
pError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Imagen cerrada.
FALSE
Error.
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Funciones utilizadas
Consulte también
PDLRT_CALLBACK (Página 571)
Sinopsis de las funciones (Página 523)
Utilización
Bloquea el cierre de una imagen en modo runtime. Se pueden realizar llamadas múltiples. La
imagen sólo puede volver a cerrarse si también se han hecho muchas llamadas de la función
PDLRTEnableClosePicture.
Declaración
BOOL PDLRTDisableClosePicture(
ADRMODE adrMode,
LPCSTR lpszPictureName,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
PCMN_ERROR pError );
Parámetro
adrMode
El parámetro está reservado para posteriores ampliaciones y debe estar ocupado por defecto
por 0.
lpszPictureName
Puntero al nombre configurado de la imagen, sin ruta ni extensión.
pfn
Puntero a la función Callback. Es llamado para informar al usuario de si la petición es correcta
o no.
Si se transmite pfn = NULL , la llamada es síncrona. La aplicación que realiza la llamada se
mantiene en espera hasta que PDLRT indica un error o un éxito. Este tipo de llamada debe
utilizarse preferiblemente para secuencias de llamadas interdependientes.
Si las siguientes llamadas API dependen de que esta función haya finalizado y se utilice de
forma asíncrona con Callback, las llamadas API deben sincronizarse con semáforos.
Es conveniente utilizar una función Callback propia para cada función API.
pvUser
Puntero a datos específicos de la aplicación que se pasan a la función Callback. Este puntero
no es evaluado por la función, sino que vuelve a estar disponible en la función Callback.
pError
Puntero a los datos de los mensajes de error ampliados en la estructura CMN_ERROR. En
caso de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Función finalizada correctamente.
FALSE
Error.
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Funciones utilizadas
Consulte también
PDLRT_CALLBACK (Página 571)
Sinopsis de las funciones (Página 523)
Utilización
Autoriza el cierre de una imagen en modo runtime.
No obstante, la imagen sólo puede volver a cerrarse si también se han hecho muchas llamadas
de la función PDLRTEnableClosePicture, como previamente de la función
PDLRTDisableClosePicture.
Un PDLRTClosePicture que antes ha sido correcto se reserva y después se recupera tras el
último PDLRTEnableClosePicture.
Declaración
BOOL PDLRTEnableClosePicture(
ADRMODE adrMode,
LPCSTR lpszPictureName,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
PCMN_ERROR pError );
Parámetro
adrMode
El parámetro está reservado para posteriores ampliaciones y debe estar ocupado por defecto
por 0.
lpszPictureName
Puntero al nombre configurado de la imagen, sin ruta ni extensión.
Se diferencia entre mayúsculas y minúsculas.
pfn
Puntero a la función Callback. Es llamado para informar al usuario de si la petición es correcta
o no.
Si se transmite pfn = NULL , la llamada es síncrona. La aplicación que realiza la llamada se
mantiene en espera hasta que PDLRT indica un error o un éxito. Este tipo de llamada debe
utilizarse preferiblemente para secuencias de llamadas interdependientes.
Si las siguientes llamadas API dependen de que esta función haya finalizado y se utilice de
forma asíncrona con Callback, las llamadas API deben sincronizarse con semáforos.
Es conveniente utilizar una función Callback propia para cada función API.
pvUser
Puntero a datos específicos de la aplicación que se pasan a la función Callback. Este puntero
no es evaluado por la función, sino que vuelve a estar disponible en la función Callback.
pError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Función finalizada correctamente.
FALSE
Error.
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Funciones utilizadas
Consulte también
PDLRT_CALLBACK (Página 571)
Sinopsis de las funciones (Página 523)
Utilización
Carga la imagen indicada.
Declaración
BOOL PDLRTGotoPicture (
PDLRTGotoPict nextPict,
PCMN_ERROR pError );
Parámetro
nextPict
El parámetro controla la función de este método. Se permiten los siguientes valores:
pError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Cargar imagen.
FALSE
Error.
Mensajes de error
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Funciones utilizadas
Consulte también
PDLRTPictureNavigation (Página 569)
Sinopsis de las funciones (Página 523)
Utilización
Determina si se puede colocar un rectángulo predeterminado en la pantalla sin tapar un ‘’área
protegida‘’. "Áreas protegidas" son, por ejemplo, otras imágenes en primer plano.
Declaración
BOOL PDLRTInquireFreeArea(
LPRECT lpScreenRect,
DWORD dwModus,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
PCMN_ERROR pError );
Parámetro
IpScreenRect
Puntero a una estructura específica de Windows del tipo RECT.
dwModus
Modo de consulta: Se ofrecen varias posibilidades de consulta que pueden combinarse
logicamente con cualquier operación O:
pfn
Puntero a la función Callback. Es llamado para informar al usuario de si la petición es correcta
o no.
Si se transmite pfn = NULL , la llamada es síncrona. La aplicación que realiza la llamada se
mantiene en espera hasta que PDLRT indica un error o un éxito. Este tipo de llamada debe
utilizarse preferiblemente para secuencias de llamadas interdependientes.
Si las siguientes llamadas API dependen de que esta función haya finalizado y se utilice de
forma asíncrona con Callback, las llamadas API deben sincronizarse con semáforos.
Es conveniente utilizar una función Callback propia para cada función API.
pvUser
Puntero a datos específicos de la aplicación que se pasan a la función Callback. Este puntero
no es evaluado por la función, sino que vuelve a estar disponible en la función Callback.
pError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
El área de la ventana es libre.
FALSE
Error.
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Funciones utilizadas
Consulte también
PDLRT_CALLBACK (Página 571)
Sinopsis de las funciones (Página 523)
Utilización
La función ejecuta un cambio de imagen básica en runtime.
Declaración
BOOL PDLRTOpenPicture(
ADRMODE adrMode,
LPCSTR lpszPictureName,
LPCSTR lpszWName,
LPCSTR lpszPictureFileName,
DWORD dwWinStyle,
LONG lxPos,
LONG lyPos,
LONG lWitdh,
LONG lHeight,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
PCMN_ERROR pError );
Parámetro
adrMode
Puntero al nombre configurado de la imagen, sin ruta ni extensión.
Se diferencia entre mayúsculas y minúsculas.
lpszWName
El parámetro debe proporcionarse actualmente con el nombre de la imagen.
lpszPictureFileName
El parámetro debe proporcionarse actualmente con el nombre de la imagen.
dwWinStyle
El parámetro está reservado para posteriores ampliaciones y debe estar ocupado por defecto
por 0.
lxPos
El parámetro está reservado para posteriores ampliaciones y debe estar ocupado por defecto
por 0.
lyPos
El parámetro está reservado para posteriores ampliaciones y debe estar ocupado por defecto
por 0.
lWidth
El parámetro está reservado para posteriores ampliaciones y debe estar ocupado por defecto
por 0.
lHeigth
El parámetro está reservado para posteriores ampliaciones y debe estar ocupado por defecto
por 0.
pfn
Puntero a la función Callback. Es llamado para informar al usuario de si la petición es correcta
o no.
Si se transmite pfn = NULL , la llamada es síncrona. La aplicación que realiza la llamada se
mantiene en espera hasta que PDLRT indica un error o un éxito. Este tipo de llamada debe
utilizarse preferiblemente para secuencias de llamadas interdependientes.
Si las siguientes llamadas API dependen de que esta función haya finalizado y se utilice de
forma asíncrona con Callback, las llamadas API deben sincronizarse con semáforos.
Es conveniente utilizar una función Callback propia para cada función API.
pvUser
Puntero a datos específicos de la aplicación que se pasan a la función Callback. Este puntero
no es evaluado por la función, sino que vuelve a estar disponible en la función Callback.
pError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Cambio de imagen básica ejecutado.
FALSE
Error.
Mensajes de error
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Funciones utilizadas
Consulte también
PDLRT_CALLBACK (Página 571)
Sinopsis de las funciones (Página 523)
Utilización
Activa y desactiva la navegación por imágenes. Cuando está desactivada, al cambiar de
imagen no se incluyen más imágenes en la pila, sino que se congela el estado anterior.
Declaración
BOOL PDLRTPictureNavigation (
PDLRT_PNFLAGS flags,
PCMN_ERROR pError );
Parámetro
flags
El parámetro controla la función. Se permiten los siguientes valores:
pError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Función finalizada correctamente.
FALSE
Error.
Causa: La navegación por imágenes ya está activada o desactivada.
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Funciones utilizadas
Consulte también
PDLRTGotoPicture (Página 563)
Sinopsis de las funciones (Página 523)
Utilización
Con la función, la ventana de runtime puesta en segundo plano pasa a la superficie del
escritorio.
Declaración
BOOL PDLRTShowApp (
PDLRT_CALLBACK pfn,
LPVOID pvUser,
PCMN_ERROR pError );
Parámetro
pfn
Puntero a la función Callback. Es llamado para informar al usuario de si la petición es correcta
o no.
Si se transmite pfn = NULL , la llamada es síncrona. La aplicación que realiza la llamada se
mantiene en espera hasta que PDLRT indica un error o un éxito. Este tipo de llamada debe
utilizarse preferiblemente para secuencias de llamadas interdependientes.
Si las siguientes llamadas API dependen de que esta función haya finalizado y se utilice de
forma asíncrona con Callback, las llamadas API deben sincronizarse con semáforos.
Es conveniente utilizar una función Callback propia para cada función API.
pvUser
Puntero a datos específicos de la aplicación que se pasan a la función Callback. Este puntero
no es evaluado por la función, sino que vuelve a estar disponible en la función Callback.
pError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Ventana de runtime en primer plano.
FALSE
Error.
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Funciones utilizadas
Consulte también
PDLRT_CALLBACK (Página 571)
Sinopsis de las funciones (Página 523)
Descripción
Si su aplicación en runtime debe ser informada asíncronamente de la ejecución de funciones
AP, deberá poner a disposición funciones Callback del tipo PDLRT_CALLBACK.
Esta función es utilizada por todas las funciones del PDLRT como función Callback.
Declaración
void ( * PDLRT_CALLBACK ) (
LPVOID pvUser,
PCMN_ERROR pError );
Parámetro
pvUser
Puntero a datos específicos de la aplicación. Este puntero está disponible como parámetro
de la función API y en este caso se devuelve sin cambios.
pError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
El Callback no tiene valor de retorno.
Observaciones
Si la función API se llama sin Callback, por tanto con pfn = NULL , la llamada es síncrona. La
aplicación que realiza la llamada se mantiene en espera hasta que PDLRT indica un error o
un éxito. Este tipo de llamada debe utilizarse preferiblemente para secuencias de llamadas
interdependientes.
Si las siguientes llamadas API dependen de que esta función haya finalizado y se utilice de
forma asíncrona con Callback, las llamadas API deben sincronizarse con semáforos. Sin
sincronización también existe el riesgo de que la función asíncrona escriba datos en el puntero
de datos que ya no es válido, si el procesamiento que llama ya ha finalizado o ha dejado el
ámbito de validez, lo que lleva al tratamiento de excepciones.
Es conveniente utilizar una función Callback propia para cada función API.
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
En algunos casos excepcionales puede ocurrir que se devuelva la función Callback antes de
que retorne la llamada de función.
Archivos necesarios
pdlrtapi.h
Consulte también
PDLRTClosePicture (Página 558)
PDLRTDisableClosePicture (Página 560)
PDLRTEnableClosePicture (Página 562)
Utilización
Con la función se consultan las teclas de control del cursor que se han activado con
PDLRTSetCursorKeys.
Declaración
BOOL PDLRTGetCursorKeys (
long* pKeyUp,
long* pKeyDown,
long* pKeyLeft,
long* pKeyRight,
long* pKeyState,
long* pTabMode,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
PCMN_ERROR pError );
Parámetro
KeyUp
Este puntero suministra el código de tecla virtual (VK_...) de la tecla que desplaza el cursor
hacia arriba.
pKeyDown
Este puntero suministra el código de tecla virtual (VK_...) de la tecla que desplaza el cursor
hacia abajo.
pKeyLeft
Este puntero suministra el código de tecla virtual (VK_...) de la tecla que desplaza el cursor
hacia la izquierda.
pKeyRight
Este puntero suministra el código de tecla virtual (VK_...) de la tecla que desplaza el cursor
hacia la derecha.
pKeyState
El puntero suministra los estados del teclado:
pTabMode
Con este puntero, TabMode suministra a qué objeto se salta la siguiente vez que se pulsa
una de las teclas de control del cursor:
O: xxBildxx
1: xxBildxx
10: xxBildxx
xxBildxx
pfn
Puntero a la función Callback. Es llamado para informar al usuario de si la petición es correcta
o no.
Si se transmite pfn = NULL , la llamada es síncrona. La aplicación que realiza la llamada se
mantiene en espera hasta que PDLRT indica un error o un éxito. Este tipo de llamada debe
utilizarse preferiblemente para secuencias de llamadas interdependientes.
Si las siguientes llamadas API dependen de que esta función haya finalizado y se utilice de
forma asíncrona con Callback, las llamadas API deben sincronizarse con semáforos.
Es conveniente utilizar una función Callback propia para cada función API.
pvUser
Puntero a datos específicos de la aplicación que se pasan a la función Callback. Este puntero
no es evaluado por la función, sino que vuelve a estar disponible en la función Callback.
pError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Teclas de control del cursor determinadas.
FALSE
Error.
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Funciones utilizadas
Consulte también
PDLRTSetCursorKeys (Página 577)
PDLRT_CALLBACK (Página 571)
Sinopsis de las funciones (Página 523)
Utilización
La función proporciona la imagen y el nombre del objeto que tiene el foco de entrada.
Declaración
BOOL PDLRTGetFocus(
ADRMODE adrMode,
LPFOCUSINFO pFocusInfo,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
PCMN_ERROR pError );
Parámetro
adrMode
Con el parámetro adrMode se determina el modo de direccionamiento de la imagen que hay
que editar.
pFocusInfo
Puntero a la estructura FOCUSINFO (Página 558), en la que se depositan los resultados.
pfn
Puntero a la función Callback. Es llamado para informar al usuario de si la petición es correcta
o no.
Si se transmite pfn = NULL , la llamada es síncrona. La aplicación que realiza la llamada se
mantiene en espera hasta que PDLRT indica un error o un éxito. Este tipo de llamada debe
utilizarse preferiblemente para secuencias de llamadas interdependientes.
Si las siguientes llamadas API dependen de que esta función haya finalizado y se utilice de
forma asíncrona con Callback, las llamadas API deben sincronizarse con semáforos.
Es conveniente utilizar una función Callback propia para cada función API.
pvUser
Puntero a datos específicos de la aplicación que se pasan a la función Callback. Este puntero
no es evaluado por la función, sino que vuelve a estar disponible en la función Callback.
pError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Foco de entrada determinado.
FALSE
Error.
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Funciones utilizadas
Consulte también
FOCUSINFO (Página 558)
PDLRTSetFocus (Página 579)
PDLRT_CALLBACK (Página 571)
Sinopsis de las funciones (Página 523)
Utilización
Con la función se definen las teclas para controlar el cursor.
Declaración
BOOL PDLRTSetCursorKeys (
long KeyUp,
long KeyDown,
long KeyLeft,
long KeyRight,
long KeyState,
long TabMode,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
PCMN_ERROR pError );
Parámetro
KeyUp
El código de tecla virtual (VK_...) de la tecla que mueve el cursor hacia arriba.
KeyDown
El código de tecla virtual (VK_...) de la tecla que mueve el cursor hacia abajo.
KeyLeft
El código de tecla virtual (VK_...) de la tecla que mueve el cursor hacia la izquierda.
KeyRight
El código de tecla virtual (VK_...) de la tecla que mueve el cursor hacia la derecha.
KeyState
KeyState devuelve el estado del teclado:
TabMode
Con TabMode se define a qué objeto se salta la siguiente vez que se pulsa una de las teclas
de control del cursor:
0: xxBildxx
1: xxBildxx
10: xxBildxx
xxBildxx
pfn
Puntero a la función Callback. Es llamado para informar al usuario de si la petición es correcta
o no.
Si se transmite pfn = NULL , la llamada es síncrona. La aplicación que realiza la llamada se
mantiene en espera hasta que PDLRT indica un error o un éxito. Este tipo de llamada debe
utilizarse preferiblemente para secuencias de llamadas interdependientes.
Si las siguientes llamadas API dependen de que esta función haya finalizado y se utilice de
forma asíncrona con Callback, las llamadas API deben sincronizarse con semáforos.
Es conveniente utilizar una función Callback propia para cada función API.
pvUser
Puntero a datos específicos de la aplicación que se pasan a la función Callback. Este puntero
no es evaluado por la función, sino que vuelve a estar disponible en la función Callback.
pError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Teclas de control del cursor definidas.
FALSE
Error.
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Funciones utilizadas
Consulte también
PDLRTGetCursorKeys (Página 573)
PDLRT_CALLBACK (Página 571)
Sinopsis de las funciones (Página 523)
Utilización
Con la función se establece el foco de entrada. El objeto se determina con lpszPictureName
y lpszObjectName.
Declaración
BOOL PDLRTSetFocus (
ADRMODE adrMode,
LPCSTR lpszPictureName,
LPCSTR lpszObjectName,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
PCMN_ERROR pError );
Parámetro
adrMode
Con el parámetro adrMode se determina el modo de direccionamiento de la imagen que hay
que editar.
IpszPictureName
Puntero al nombre de imagen configurado de acuerdo con el modo de direccionamiento
definido con adrMode, sin extensión. Se diferencia entre mayúsculas y minúsculas.
lpszObjectName
Puntero al nombre de objeto configurado de acuerdo con el modo de direccionamiento definido
con adrMode.
pfn
Puntero a la función Callback. Es llamado para informar al usuario de si la petición es correcta
o no.
Si se transmite pfn = NULL , la llamada es síncrona. La aplicación que realiza la llamada se
mantiene en espera hasta que PDLRT indica un error o un éxito. Este tipo de llamada debe
utilizarse preferiblemente para secuencias de llamadas interdependientes.
Si las siguientes llamadas API dependen de que esta función haya finalizado y se utilice de
forma asíncrona con Callback, las llamadas API deben sincronizarse con semáforos.
Es conveniente utilizar una función Callback propia para cada función API.
pvUser
Puntero a datos específicos de la aplicación que se pasan a la función Callback. Este puntero
no es evaluado por la función, sino que vuelve a estar disponible en la función Callback.
pError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Foco de entrada activado
FALSE
Error
Mensajes de error
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Funciones utilizadas
Consulte también
PDLRTGetFocus (Página 575)
PDLRT_CALLBACK (Página 571)
Sinopsis de las funciones (Página 523)
Utilización
Solicitar un valor de propiedad predeterminado. Si el tipo de datos solicitado no coincide con
el tipo de datos de las propiedades, el valor se convierte, si es posible, al formato solicitado
al transferirlo al búfer de usuario pvProp.
Declaración
BOOL PDLRTGetDefPropEx(
ADRMODE adrMode,
LPCSTR lpszPictureName,
LPCSTR lpszObjectName,
LPCSTR lpszPropName,
VARTYPE vt,
LPVOID pvProp,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
DWORD dwFlags,
LPVOID pData,
PCMN_ERROR pError );
Parámetro
adrMode
Con el parámetro adrMode se determina el modo de direccionamiento de la imagen que hay
que editar.
lpszPictureName
Puntero al nombre de imagen configurado de acuerdo con el modo de direccionamiento
definido con adrMode. Se diferencia entre mayúsculas y minúsculas.
lpszObjectName
Puntero al nombre de objeto configurado de acuerdo con el modo de direccionamiento
definidoconadrMode .
lpszPropName
Puntero al nombre de la propiedad del objeto configurado.
vt
Tipo de datos del valor transmitido con pvProp. Los tipos permitidos son definidos en los
archivos de inclusión "oaidl.h" y "wtypes.h" pertenecientes al compilador. Para scripts se
puede utilizar el archivo de inclusión de WinCC APLIB\Defines.h .
pvProp
Puntero a una variable en la que se almacena el valor de la propiedad. El tipo de datos del
valor se determina con vt:
vt pvProp
VT_BSTR BSTR*
VT_LPSTR LPSTR*
VT_LPWSTR LPWSTR*
VT_UI4 LONG*
VT_xxxx pvProp debe apuntar a un búfer
En los tipos con búfer (p. ej., BSTR) el búfer es asignado por la función y debe volver a ser
liberado por la aplicación que realiza la llamada.
pfn
Puntero a la función Callback. Es llamado para informar al usuario de si la petición es correcta
o no.
Si se transmite pfn = NULL , la llamada es síncrona. La aplicación que realiza la llamada se
mantiene en espera hasta que PDLRT indica un error o un éxito. Este tipo de llamada debe
utilizarse preferiblemente para secuencias de llamadas interdependientes.
Si las siguientes llamadas API dependen de que esta función haya finalizado y se utilice de
forma asíncrona con Callback, las llamadas API deben sincronizarse con semáforos.
Es conveniente utilizar una función Callback propia para cada función API.
pvUser
Puntero a datos específicos de la aplicación que se pasan a la función Callback. Este puntero
no es evaluado por la función, sino que vuelve a estar disponible en la función Callback.
dwFlags
El parámetro está reservado para posteriores ampliaciones y debe estar ocupado por defecto
por 0.
pData
El parámetro está reservado para posteriores ampliaciones y debe estar ocupado por defecto
por NULL.
pError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Valores predeterminados de la propiedad del objeto determinados.
FALSE
Error.
Observaciones
Para volver a liberar áreas de memoria asignadas, utilice en el caso de VT_BSTR la función
API de Windows SysFreeString(...) y en el caso de VT_LPSTR y VT_LPWSTR la función API
de Windows LocalFree(...).
Mensajes de error
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Funciones utilizadas
Consulte también
PDLRT_CALLBACK (Página 571)
Sinopsis de las funciones (Página 523)
Utilización
Solicitan una valor actual de la propiedad. El origen se determina con lpszPictureName,
lpszObjectName y lpszPropName.
Si el tipo de datos solicitado no coincide con el tipo de datos de la propiedad, el valor se
convierte, si es posible, al formato solicitado al transferirlo al búfer de usuario pvProp.
Declaración
BOOL PDLRTGetPropEx(
ADRMODE adrMode,
LPCSTR lpszPictureName,
LPCSTR lpszObjectName,
LPCSTR lpszPropName,
VARTYPE vt,
LPVOID pvProp,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
DWORD dwFlags,
LPVOID pData,
PCMN_ERROR pError );
Parámetro
adrMode
Con el parámetro adrMode se determina el modo de direccionamiento de la imagen que hay
que editar.
lpszPictureName
Puntero al nombre de imagen configurado de acuerdo con el modo de direccionamiento
definido con adrMode. Se diferencia entre mayúsculas y minúsculas.
lpszObjectName
Puntero al nombre de objeto configurado de acuerdo con el modo de direccionamiento definido
con adrMode.
lpszPropName
Puntero al nombre de la propiedad del objeto configurado.
vt
Tipo de datos del valor transmitido con pvProp. Los tipos permitidos son definidos en los
archivos de inclusión "oaidl.h" y "wtypes.h" pertenecientes al compilador. Para scripts se
puede utilizar el archivo de inclusión de WinCC APLIB\Defines.h .
pvProp
Puntero a una variable en la que se almacena el valor de la propiedad. El tipo de datos del
valor se determina con vt:
vt pvProp
VT_BSTR BSTR*
VT_LPSTR LPSTR*
VT_LPWSTR LPWSTR*
VT_UI4 LONG*
VT_xxxx pvProp debe apuntar a un búfer
En los tipos con búfer (p. ej., BSTR) el búfer es asignado por la función y debe volver a ser
liberado por la aplicación que realiza la llamada.
pfn
Puntero a la función Callback. Es llamado para informar al usuario de si la petición es correcta
o no.
Si se transmite pfn = NULL , la llamada es síncrona. La aplicación que realiza la llamada se
mantiene en espera hasta que PDLRT indica un error o un éxito. Este tipo de llamada debe
utilizarse preferiblemente para secuencias de llamadas interdependientes.
Si las siguientes llamadas API dependen de que esta función haya finalizado y se utilice de
forma asíncrona con Callback, las llamadas API deben sincronizarse con semáforos.
Es conveniente utilizar una función Callback propia para cada función API.
pvUser
Puntero a datos específicos de la aplicación que se pasan a la función Callback. Este puntero
no es evaluado por la función, sino que vuelve a estar disponible en la función Callback.
dwFlags
El parámetro está reservado para posteriores ampliaciones y debe estar ocupado por defecto
por 0.
pData
El parámetro está reservado para posteriores ampliaciones y debe estar ocupado por defecto
por NULL.
pError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Propiedades de objeto determinadas.
FALSE
Error.
Observaciones
Para volver a liberar áreas de memoria asignadas, utilice en el caso de VT_BSTR la función
API de Windows SysFreeString(...) y en el caso de VT_LPSTR y VT_LPWSTR la función API
de Windows LocalFree(...).
No deben utilizarse VT_DISPATCH ni otras referencias, sólo los tipos normales y, como
máximo, un VT_VARIANT para una propiedad de matriz de tipo simple.
Mensajes de error
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Funciones utilizadas
Consulte también
PDLRT_CALLBACK (Página 571)
PDLRTSetPropEx (Página 587)
Sinopsis de las funciones (Página 523)
Utilización
Ajustan una propiedad. El punto de destino se determina con lpszPictureName,
lpszObjectName y lpszPropName. Si el tipo de datos transmitido no coincide con el tipo de
datos de la propiedad, el valor se convierte, si es posible, al transferirlo a la propiedad.
Sólo se pueden establecer propiedades que también sean dinamizables.
Declaración
BOOL PDLRTSetPropEx(
ADRMODE adrMode,
LPCSTR lpszPictureName,
LPCSTR lpszObjectName,
LPCSTR lpszPropName,
VARTYPE vt,
LPVOID pvProp,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
DWORD dwFlags,
LPVOID pData,
PCMN_ERROR pError );
Parámetro
adrMode
Con el parámetro adrMode se determina el modo de direccionamiento de la imagen que hay
que editar.
lpszPictureName
Puntero al nombre de imagen configurado de acuerdo con el modo de direccionamiento
definido con adrMode. Se diferencia entre mayúsculas y minúsculas.
lpszObjectName
Puntero al nombre de objeto configurado de acuerdo con el modo de direccionamiento definido
con adrMode.
lpszPropName
Puntero al nombre de la propiedad del objeto configurado.
vt
Tipo de datos del valor transmitido con pvProp. Los tipos permitidos son definidos en los
archivos de inclusión "oaidl.h" y "wtypes.h" pertenecientes al compilador. Para scripts se
puede utilizar el archivo de inclusión de WinCC APLIB\Defines.h .
pvProp
Puntero a un búfer en el que está almacenado el nuevo valor de la propiedad. El tipo de datos
del valor se determina con vt:
vt pvProp
VT_BSTR BSTR*
VT_LPSTR LPSTR*
VT_LPWSTR LPWSTR*
VT_UI4 LONG*
VT_xxxx pvProp debe apuntar a un búfer
pfn
Puntero a la función Callback. Es llamado para informar al usuario de si la petición es correcta
o no.
Si se transmite pfn = NULL , la llamada es síncrona. La aplicación que realiza la llamada se
mantiene en espera hasta que PDLRT indica un error o un éxito. Este tipo de llamada debe
utilizarse preferiblemente para secuencias de llamadas interdependientes.
Si las siguientes llamadas API dependen de que esta función haya finalizado y se utilice de
forma asíncrona con Callback, las llamadas API deben sincronizarse con semáforos.
Es conveniente utilizar una función Callback propia para cada función API.
pvUser
Puntero a datos específicos de la aplicación que se pasan a la función Callback. Este puntero
no es evaluado por la función, sino que vuelve a estar disponible en la función Callback.
dwFlags
El parámetro está reservado para posteriores ampliaciones y debe estar ocupado por defecto
por 0.
pData
El parámetro está reservado para posteriores ampliaciones y debe estar ocupado por defecto
por NULL.
pError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Propiedades de objeto activadas.
FALSE
Error.
Observaciones
No deben utilizarse VT_DISPATCH ni otras referencias, sólo los tipos normales y, como
máximo, un VT_VARIANT para una propiedad de matriz de tipo simple.
Mensajes de error
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Funciones utilizadas
Ejemplo
#pragma code("pdlrtapi.dll")
#include "apdefap.h"
#define CP_ACP 0
#define MB_PRECOMPOSED 1
bRet = DMGetRuntimeProject
(&szProjectFile[0],sizeof(szProjectFile),&error);
printf("DMGetRuntimeProject: %s\r\n", szProjectFile);
bRet = PDLRTOpenPicture(0,"Start.PDL",NULL,NULL,0,0,0,0,0,NULL,NULL,
&error);
printf("PDLRTOpenPicture: %s,%ld, %s\r\n", bRet?"TRUE":"FALSE",
error.dwError1,error.szErrorText);
SysFreeString( bstrval );
printf("SysFreeString done\r\n");
}
Consulte también
PDLRT_CALLBACK (Página 571)
PDLRTGetPropEx (Página 584)
Sinopsis de las funciones (Página 523)
Utilización
Pregunta a un enlace de una propiedad. Si la propiedad tiene una conexión de variable
indirecta, ésta se devuelve. Si en una conexión de variable indirecta se desea la conexión
directa actual, se puede solicitar indicando
LinkType = BUBRT_LT_VARIABLE_DIRECT en la estructura LINKINFO.
Declaración
BOOL PDLRTGetLink (
ADRMODE adrMode,
LPCSTR lpszPictureName,
LPCSTR lpszObjectName,
LPCSTR lpszPropName,
LPLINKINFO pLink,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
PCMN_ERROR pError );
Parámetro
adrMode
Con el parámetro adrMode se determina el modo de direccionamiento de la imagen que hay
que editar.
lpszPictureName
Puntero al nombre de imagen configurado de acuerdo con el modo de direccionamiento
definido con adrMode, sin extensión. Se diferencia entre mayúsculas y minúsculas.
lpszObjectName
Puntero al nombre de objeto configurado de acuerdo con el modo de direccionamiento definido
con adrMode.
lpszPropName
Puntero al nombre de la propiedad del objeto.
pLink
Puntero a la estructura LINKINFO (Página 554), en la que se almacena la información del
enlace.
pfn
Puntero a la función Callback. Es llamado para informar al usuario de si la petición es correcta
o no.
Si se transmite pfn = NULL , la llamada es síncrona. La aplicación que realiza la llamada se
mantiene en espera hasta que PDLRT indica un error o un éxito. Este tipo de llamada debe
utilizarse preferiblemente para secuencias de llamadas interdependientes.
Si las siguientes llamadas API dependen de que esta función haya finalizado y se utilice de
forma asíncrona con Callback, las llamadas API deben sincronizarse con semáforos.
Es conveniente utilizar una función Callback propia para cada función API.
pvUser
Puntero a datos específicos de la aplicación que se pasan a la función Callback. Este puntero
no es evaluado por la función, sino que vuelve a estar disponible en la función Callback.
pError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Enlace determinado.
FALSE
Error.
Mensajes de error
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Funciones utilizadas
Consulte también
PDLRTSetLink (Página 594)
PDLRT_CALLBACK (Página 571)
LINKINFO (Página 554)
Sinopsis de las funciones (Página 523)
Utilización
Establece un enlace entre una propiedad y una variable.
Declaración
BOOL PDLRTSetLink (
ADRMODE adrMode,
LPCSTR lpszPictureName,
LPCSTR lpszObjectName,
LPCSTR lpszPropName,
LPLINKINFO pLink,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
PCMN_ERROR pError );
Parámetro
adrMode
Con el parámetro adrMode se determina el modo de direccionamiento de la imagen que hay
que editar.
lpszPictureName
Puntero al nombre de imagen configurado de acuerdo con el modo de direccionamiento
definido con adrMode, sin extensión. Se diferencia entre mayúsculas y minúsculas.
lpszObjectName
Puntero al nombre de objeto configurado de acuerdo con el modo de direccionamiento definido
con adrMode.
lpszPropName
Puntero al nombre de la propiedad del objeto.
pLink
Puntero a la estructura LINKINFO (Página 554), en la que está almacenada la información
del enlace.
En LinkType sólo deben utilizarse BUBRT_LT_VARIABLE_DIRECT y
BUBRT_LT_VARIABLE_INDIRECT , ya que sólo se permiten enlaces con variables.
pfn
Puntero a la función Callback. Es llamado para informar al usuario de si la petición es correcta
o no.
Si se transmite pfn = NULL , la llamada es síncrona. La aplicación que realiza la llamada se
mantiene en espera hasta que PDLRT indica un error o un éxito. Este tipo de llamada debe
utilizarse preferiblemente para secuencias de llamadas interdependientes.
Si las siguientes llamadas API dependen de que esta función haya finalizado y se utilice de
forma asíncrona con Callback, las llamadas API deben sincronizarse con semáforos.
Es conveniente utilizar una función Callback propia para cada función API.
pvUser
Puntero a datos específicos de la aplicación que se pasan a la función Callback. Este puntero
no es evaluado por la función, sino que vuelve a estar disponible en la función Callback.
pError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Enlace activado
FALSE
Error
Mensajes de error
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Funciones utilizadas
Consulte también
PDLRTGetLink (Página 592)
PDLRTSetMultiLink (Página 596)
PDLRT_CALLBACK (Página 571)
LINKINFO (Página 554)
Sinopsis de las funciones (Página 523)
Utilización
Establece varios enlaces entre una propiedad y variables.
Declaración
BOOL PDLRTSetMultiLink (
ADRMODE adrMode,
LPCSTR lpszPictureName,
LPMULTILINK pMultiLink,
PDLRT_CALLBACK pfn,
LPVOID pvUser,
PCMN_ERROR pError );
Parámetro
adrMode
Con el parámetro adrMode se determina el modo de direccionamiento de la imagen que hay
que editar.
lpszPictureName
Puntero al nombre de imagen configurado de acuerdo con el modo de direccionamiento
definido con adrMode, sin extensión. Se diferencia entre mayúsculas y minúsculas.
pMultiLink
Puntero a la estructura MULTILINK (Página 556), en la que está almacenado un campo con
información del enlace.
pfn
Puntero a la función Callback. Es llamado para informar al usuario de si la petición es correcta
o no.
Si se transmite pfn = NULL , la llamada es síncrona. La aplicación que realiza la llamada se
mantiene en espera hasta que PDLRT indica un error o un éxito. Este tipo de llamada debe
utilizarse preferiblemente para secuencias de llamadas interdependientes.
Si las siguientes llamadas API dependen de que esta función haya finalizado y se utilice de
forma asíncrona con Callback, las llamadas API deben sincronizarse con semáforos.
Es conveniente utilizar una función Callback propia para cada función API.
pvUser
Puntero a datos específicos de la aplicación que se pasan a la función Callback. Este puntero
no es evaluado por la función, sino que vuelve a estar disponible en la función Callback.
Valor de retorno
TRUE
El valor de retorno TRUE sólo se proporciona si todos los enlaces han podido establecerse
correctamente. Si no ha podido establecerse sólo un enlace, se proporciona FALSE.
FALSE
Error.
Mensajes de error
Archivos necesarios
pdlrtapi.h
pdlrt_s.lib
pdlrtapi.dll
Funciones utilizadas
Consulte también
PDLRTSetLink (Página 594)
PDLRT_CALLBACK (Página 571)
MULTILINK (Página 556)
Sinopsis de las funciones (Página 523)
Sinopsis
Sinopsis
Sinopsis
Las funciones API pueden devolver los siguientes mensajes de error en la estructura de error
CMN_ERROR:
Error
que pueden producirse al ejecutar una acción
Avisos
del intérprete de acciones
Notify Codes
Valores límite
Tipos de encabezados
Tipos de disparadores
Tipos de ciclos
AP_TRIG_CYCLE 1 Cíclico
AP_TRIG_NCYCLE 2 Acíclico
Tiempos de ciclo
Declaración
typedef struct {
DWORD dwKeyType;
DWORD dwID;
CHAR szActionName[AP_MAX_ACTION_NAME + 1];
DWORD dwCycle;
VARIANT *pVariant;
DWORD dwVariantItem;
DWORD dwerror;
LPVOID lpvUser;
} AP_ACT_KEY ;
Members
dwKeyType
El tipo de clave determina si la acción se direcciona a través de un nombre (szActionName)
o un ID (dwID).
dwID
La acción se inicia con dwID en combinación con dwKeyType = AP_ID_TYPE.
El Id de la acción se otorga al llamar la función APTransAct. Al llamar la función APTransAct
se debe preasignar dwID con 0.
szActionName
La acción se inicia mediante szActionName en combinación con dwKeyType =
AP_NAME_TYPE.
Se puede emplear al iniciar una acción con APStart.
dwCycle
Inicio cíclico de la acción cuando se direcciona por nombre. El ciclo de actualización se define
con el índice de las entradas de la lista de ciclos de actualización.
pVariant
Puntero al campo del tipo de datos VARIANT que describe los parámetros de la acción. Se
soportan los siguientes tipos de datos como VARTYPES :
Las descripciones de parámetros de las acciones y del resultado de retorno sólo son posibles
en la forma del tipo de datos VARIANT.
No se permite una entrega como referencia.
dwVariantItem
Cantidad de tipos de datos VARIANT que la acción contiene a modo de parámetros.
dwerror
Número de error que puede surgir en el APTransAct.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
Descripción
La estructura AP_ACT_KEY identifica la acción de manera unívoca. Con la llamada API
APTransAct se otorga esta clave como ID. La acción se inicia con esta clave.
Archivos necesarios
ap_def.h
Funciones API
Consulte también
APActive (Página 625)
APInactive (Página 630)
APStart (Página 632)
APTransact (Página 634)
Declaración
typedef struct {
VARIANT *ap_result;
AP_ACT_KEY apActKey;
CMN_ERROR error;
DWORD dwreserved;
} AP_ACT_RESULT_STRUCT ;
Members
*ap_result
Resultado de retorno de la acción en forma de un tipo de datos VARIANT.
apActKey
Clave de la acción para identificación. AP_ACT_KEY representa la clave con la que se ha
iniciado la acción.
error
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
dwreserved
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
Archivos requeridos
ap_def.h
Funciones API
Consulte también
APFreeResultStruct (Página 629)
APStart (Página 632)
Declaración
typedef struct {
char* pszStartDir;
char* pszHeaderFileName;
BOOL bShowDlg;
char* pszWindowText;
} CREATE_USER_HEADER_FILE ;
Members
pszStartDir
Puntero en el directorio de inicio, a partir del cual se buscan las funciones de usuario con
terminación "\"
pszHeaderFileName
Puntero en el nombre del Header-File.
bShowDlg
Mostrar diálogo con indicación de progreso
pszWindowText
Puntero en la rotulación del diálogo. Default:BROWSER
Archivos requeridos
capigsc.h
Funciones API
Consulte también
GSCGenCompileUserFunctions (Página 623)
Declaración
typedef struct {
char* pszProjectName;
LPACTION pAction;
} GENERATE_COMPILE ;
Members
pszProjectName
Puntero en el nombre del proyecto
pAction
Puntero en stream de acción válido con source code
Archivos requeridos
capigsc.h
Funciones relacionadas
Consulte también
GSCGenCompile (Página 622)
Declaración
typedef struct {
char* pszPathName;
DWORD dwType;
} GET_ACTION_STREAM, *LPGET_ACTION_STREAM ;
Members
pszPathName
nombre completo del archivo de la función o acción.
dwType
tipos admitidos:
Archivos requeridos
capigsc.h
Funciones API
Consulte también
GSCGenGetActionStream (Página 624)
Descripción
La función notifica una aplicación en el control de la acción. Si se especifica en fpAppBack
una función callback, ésta se ejecuta de manera asíncrona, en fpAppBack == NULL la función
se ejecuta de manera sincrónica.
Declaración
BOOL APConnect (
LPCSTR lpszAppName,
AP_RT_PROC fpAppBack,
PDWORD pdwOrderId,
LPCVOID lpvUser,
PCMN_ERROR pError )
Parámetro
lpszAppName
Nombre de la aplicación con la que se ha registrado en DMConnect. Por ello, no se requiere
un DMConnect previo. APConnect se ejecuta únicamente de manera sincrónica.
Si se llaman funciones de la programación script en acciones, se debe especificar para
lpszAppName el valor "AktSteu" (la sintaxis debe ser exacta), porque la tarea WinCC ha
ejecutado DMConnect con este nombre.
fpAppBack
Su función Callback, la cual recibe las notificaciones. Por ejemplo, la notificación de
finalización del controlador de la acción se notifica a través de esta función.
Si un programa notifica una rutina Notify, deberá vaciar periódicamente su Message Queue.
Los mensajes no recogidos pueden bloquear notificaciones WinCC y, con ello, todo el WinCC.
pdwOrderId
Número de petición otorgado al llamar la función APTransAct. En una llamada sincrónica
pdwOrderID no es relevante, en una petición asíncrona se suministra el número de petición
en la función Callback.
lpvUser
Puntero en datos específicos de la aplicación. Este puntero no es evaluado por la función,
sino que se pone nuevamente a disposición en la función Callback.
Si no se utiliza lpvUser se deberá ocupar con NULL.
pError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Aplicación registrada
FALSE
Error
Mensajes de error
Archivos requeridos
ap_def.h
apcli_S.lib
apclient.dll
Funciones relacionadas
Ejemplos
Establish connection to script programming (Página 636)"AP01.cpp"
Consulte también
DMConnect (Página 279)
APTransact (Página 634)
AP_RT_PROC (Página 614)
APDisconnect (Página 611)
Establish connection to script programming (Página 636)
Sinopsis de las funciones (Página 598)
Descripción
La función da de baja una aplicación en el control de la acción.
Declaración
BOOL APDisconnect (
AP_RT_PROC fpAppBack,
PDWORD pdwOrderId,
LPCVOID lpvUser,
PCMN_ERROR pError )
Parámetro
fpAppBack
Su función Callback, la cual recibe las notificaciones. Cuando se utiliza una función Callback,
la petición se realiza de forma asíncrona. Con fpAppBack == NULL se realizar de forma
sincrónica.
Si un programa registra una rutina Notify, deberá vaciar periódicamente su Message Queue.
Los mensajes no recogidos pueden bloquear notificaciones WinCC y, con ello, todo el WinCC.
pdwOrderId
Número de petición otorgado al llamar la función APTransAct. En una llamada sincrónica,
pdwOrderID no es relevante, en una petición asíncrona se suministra el número de petición
en la función Callback.
lpvUser
Puntero en datos específicos de la aplicación. Este puntero no es evaluado por la función,
sino que se pone nuevamente a disposición en la función Callback.
pError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Aplicación dada de baja.
FALSE
Error
Observación
Nota
No se debe utilizar la llamada en el destructor de una aplicación (EXE, DLL, OCX, ...). Debido
a los mecanismos específicos de Microsoft puede producirse eventualmente un bloqueo de
la llamada y, en consecuencia, del programa.
Mensajes de error
Archivos requeridos
ap_def.h
apcli_S.lib
apclient.dll
Funciones relacionadas
Ejemplos
Establish connection to script programming (Página 636)"AP01.cpp"
Consulte también
APTransact (Página 634)
APConnect (Página 609)
AP_RT_PROC (Página 614)
Establish connection to script programming (Página 636)
Sinopsis de las funciones (Página 598)
Descripción
Esta función permite predeterminar el idioma en que se emiten los textos de error.
Declaración
BOOL APSetLanguage (
const DWORD dwLanguageID )
Parámetro
dwLanguageID
ID del idioma conforme al ajuste de idioma de Windows. Los textos de error se devuelven
conforme al idioma nuevamente ajustado. Si no se soporta el idioma se utilizará un idioma
por defecto.
Valor de retorno
TRUE
Idioma de los textos de error modificado
FALSE
Error
Archivos requeridos
ap_def.h
apcli_S.lib
apclient.dll
Consulte también
Sinopsis de las funciones (Página 598)
Descripción
Si se debe informar asíncronamente a su aplicación en Runtime acerca de la ejecución de
funciones AP, debe preparar funciones Callback del tipo AP_RT_PROC.
Esta función es utilizada por todas las funciones de la programación de acciones a modo de
función Callback.
Declaración
BOOL ( * AP_RT_PROC) (
DWORD dwAP_Notify,
WORD dwAP_NotifyCode,
DWORD dwError,
LPVOID lpvData,
DWORD dwItems,
DWORD dwOrderId,
LPVOID lpvUser );
Parámetro
dwAP_Notify
Describe el tipo de la función Callback. Valores posibles son AP_NOTIFY_ERROR y
AP_NOTIFY_DATA.
dwAP_NotifyCode
Si dwAP_Notify == AP_NOTIFY_ERROR, entonces lpvData señala a una estructura de tipo
CMN_ERROR con la descripción de error, y dwAP_NotifyCode es NULL.
dwError
Número de error
lpvData
Puntero a datos puestos a disposición. La estructura de datos depende de dwAP_Notify y
dwAP_NotifyCode.
dwItems
Número de entradas en lpvData.
dwOrderId
Número de petición otorgado al llamar la función API.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
Valor de retorno
TRUE
Función ejecutada con éxito
FALSE
Error
Observación
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
En algunos casos excepcionales puede ocurrir que se devuelva la función Callback antes de
que retorne la llamada de función.
Archivos necesarios
ap_def.h
Funciones relacionadas
Ejemplos
Establish connection to script programming (Página 636)"AP01.cpp"
Consulte también
APConnect (Página 609)
APDisconnect (Página 611)
APActive (Página 625)
APEndAct (Página 627)
APInactive (Página 630)
APStart (Página 632)
APTransact (Página 634)
Descripción
Se compila un código fuente guardado en lpvScode y se guarda como P-Code en lpvPcode.
La aplicación debe proporcionar la memoria para el P-Code.
Declaración
BOOL APCompile (
LPCSTR szProjectName,
PDWORD pdwOrderId,
LPCSTR lpvScode,
const DWORD dwScodeSize,
LPVOID *lpvPcode,
PDWORD dwPcodeSize,
const HWND hwndLog,
const DWORD dwDebugFlag,
PDWORD nErrors,
PDWORD nWarnings,
LPCVOID lpvUser,
PCMN_ERROR pError )
Parámetro
szProjectName
Cadena de caracteres que contiene una ruta de proyecto válida. A través de la ruta de proyecto
se decide qué Include y Precompiled Header deben utilizarse para la compilación.
pdwOrderId
Número de petición otorgado al llamar la función APTransAct. El número de petición debe ser
proporcionado por la instancia llamante.
lpvScode
Puntero en el código fuente a compilar.
dwScodeSize
Tamaño del código fuente en bytes
lpvPcode
Dirección de un puntero que contiene el P-Code tras una compilación realizada con éxito. La
memoria es creada por la función APCompile y debe ser habilitada de nuevo por la instancia
llamante con la función APFreePCode.
dwPcodeSize
Después de la compilación contiene el tamaño del P-Code en bytes.
hwndLog
Handle de ventana, a través del cual se pueden emitir los mensajes de error. El handle de
ventana también puede ser NULL. Cuando se utiliza una ventana para salidas, se emite un
mensaje a través de la función de Windows WM_COPYDATA.
dwDebugFlag
Este Flag establece si el P-Code debe suministrar informaciones Debug (Bit1 = 1 ) o si no se
debe suministrar ninguna información Debug (Bit1 = 0 ). Normalmente se debe seleccionar
"0" por cuestiones de rendimiento.
Bit2 = 1: Utilizar los ajustes del servidor para Includes
Bit2 = 0: Utilizar ajustes locales para Includes
nErrors
Cantidad de errores producidos. En nErrors > 0 no se devuelve ningún P-Code.
nWarnings
Cantidad de advertencias producidas. En nWarnings > 0 también se genera el P-Code.
lpvUser
Puntero en datos específicos de la aplicación. Este puntero no es evaluado por la función,
sino que se pone nuevamente a disposición en la función Callback.
pError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Código fuente compilado con éxito
FALSE
Error
Archivos requeridos
ap_def.h
apcli_S.lib
apclient.dll
Funciones relacionadas
Consulte también
APCompileEx (Página 619)
Sinopsis de las funciones (Página 598)
Descripción
A diferencia de lo que ocurre con la función APCompile, el código fuente a compilar se
encuentra subdividido en secciones.
En el código fuente void function {instrucciones} se subdivide en
Declaración
BOOL APCompileEx (
LPCSTR szProjectName,
PDWORD pdwOrderId,
LPCSTR lpvScodeProlog,
const DWORD dwScodePrologSize,
LPCSTR lpvScodeBase,
const DWORD dwScodeBaseSize,
LPCSTR lpvScodeEpilog,
const DWORD dwScodeEpilogSize,
LPVOID *lpvPcode,
PDWORD dwPcodeSize,
const HWND hwndLog,
const DWORD dwDebugFlag,
PDWORD nErrors,
PDWORD nWarnings,
LPCVOID lpvUser,
PCMN_ERROR pError )
Parámetro
szProjectName
Cadena de caracteres que contiene una ruta de proyecto válida. A través de la ruta de proyecto
se decide qué Include y Precompiled Header deben utilizarse para la compilación.
pdwOrderId
Número de petición otorgado al llamar la función APTransAct. El número de petición debe ser
proporcionado por la instancia llamante.
szProjectName
Cadena de caracteres que contiene una ruta de proyecto válida. A través de la ruta de proyecto
se decide qué Include y Precompiled Header deben utilizarse para la compilación.
pdwOrderId
Número de petición otorgado al llamar la función APTransAct. El número de petición debe ser
proporcionado por la instancia llamante.
lpvScodeProlog
Puntero al Prolog del código fuente que se va a compilar.
dwScodePrologSize
Tamaño del Prolog en bytes
lpvScodeBase
Puntero al tronco del código fuente que se va a compilar.
dwScodeBaseSize
Tamaño del tronco en bytes.
lpvScodeEpilog
Puntero al Epilog del código fuente que se va a compilar.
dwScodeEpilogSize
Tamaño del Epilog en bytes
lpvPcode
Dirección de un puntero que contiene el P-Code tras una compilación realizada con éxito. La
memoria es creada por la función APCompile y debe ser habilitada de nuevo por la instancia
llamante con la función APFreePCode.
dwPcodeSize
Después de la compilación contiene el tamaño del P-Code en bytes.
hwndLog
Handle de ventana, a través del cual se pueden emitir los mensajes de error. El handle de
ventana también puede ser NULL. Cuando se utiliza una ventana para salidas, se emite un
mensaje a través de la función de Windows WM_COPYDATA.
dwDebugFlag
Este Flag establece si el P-Code debe suministrar informaciones Debug (Bit1 = 1 ) o si no se
debe suministrar ninguna información Debug (Bit1 = 0 ). Normalmente se debe seleccionar
"0" por cuestiones de rendimiento.
Bit2 = 1: Utilizar los ajustes del servidor para Includes
Bit2 = 0: Utilizar ajustes locales para Includes
nErrors
Cantidad de errores producidos. En nErrors > 0 no se devuelve ningún P-Code.
nWarnings
Cantidad de advertencias producidas. En nWarnings > 0 también se genera el P-Code.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
pError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Código fuente compilado con éxito
FALSE
Error
Archivos necesarios
ap_def.h
apcli_S.lib
apclient.dll
Funciones relacionadas
Consulte también
APCompile (Página 617)
Sinopsis de las funciones (Página 598)
Descripción
La función compila una acción.
Declaración
LPACTION GSCGenCompile(
LPGENERATE_COMPILE lpGenCompile,
HWND hWndParent,
unsigned long* plErrors,
unsigned long* plWarnings,
AllocAppMem lpfnAllocAppMem,
LPCMN_ERROR lpdmError)
Parámetro
lpGenCompile
Puntero en la estructura GENERATE_COMPILE (Página 607).
hWndParent
Handle en la ventana donde se ejecutarán las salidas de estado.
plErrors
Puntero en la variable para retorno del número de errores
plWarnings
Puntero en la variable para retorno del número de advertencias
lpfnAllocAppMem
Puntero en una función con la cual se asigna memoria en la aplicación llamante.
lpdmError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
Puntero en el stream de acción compilado. También se genera un stream de acción si la
compilación es defectuosa. La realización de la llamada se debe verificar a través del número
de errores y advertencias.
Observación
La acción compilada está disponible después de iniciar nuevamente Runtime.
Archivos requeridos
capigsc.h
gscgr_s.lib
gscgen.dll
Consulte también
GENERATE_COMPILE (Página 607)
Sinopsis de las funciones (Página 598)
Descripción
La función compila nuevamente todas las funciones especiales de usuario.
Declaración
BOOL GSCGenCompileUserFunctions (
LPCREATE_USER_HEADER_FILE pGenCUHF,
HWND hWndParent,
LPCMN_ERROR lpdmError)
Parámetro
pGenCUHF
Puntero en la estructura CREATE_USER_HEADER_FILE (Página 606).
hWndParent
Handle en la ventana donde se ejecutarán las salidas de estado.
lpdmError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Funciones de usuario compiladas
FALSE
Error
Observación
Por motivos internos, esta función siempre devuelve FALSE sin mensaje de error, a pesar de
que se generan las funciones.
Las funciones de usuario compiladas están disponible después de iniciar nuevamente
Runtime.
Archivos requeridos
capigsc.h
gscgr_s.lib
gscgen.dll
Consulte también
CREATE_USER_HEADER_FILE (Página 606)
Sinopsis de las funciones (Página 598)
Descripción
La función determina el stream de acción para una función de proyecto, una función estándar
o una acción.
Declaración
LPACTION GSCGenGetActionStream(
LPGET_ACTION_STREAM pGenGAS,
AllocAppMem lpfnAllocAppMem,
LPCMN_ERROR lpdmError)
Parámetro
pGenGAS
Puntero en una estructura tipo GET_ACTION_STREAM (Página 608), a través de la cual se
especifica la función o acción.
lpfnAllocAppMem
Puntero en una función con la cual se asigna memoria en la aplicación llamante.
lpdmError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
Puntero en el stream de acción.
Archivos requeridos
capigsc.h
gscgr_s.lib
gscgen.dll
Consulte también
GET_ACTION_STREAM (Página 608)
Sinopsis de las funciones (Página 598)
Descripción
Las acciones desactivadas con APInactive se pueden volver a activar con esta función, es
decir, los disparadores correspondientes se vuelven a supervisar o se pueden volver a iniciar
con APStart.
Declaración
BOOL APActive (
PAP_ACT_KEY lpapActKey,
const DWORD dwItems,
AP_RT_PROC fpAppBack,
PDWORD pdwOrderId,
LPCVOID lpvUser,
PCMN_ERROR pError )
Parámetro
lpapActKey
Puntero en una estructura de datos con la siguiente estructura:
$3B$&7B.(<
$3B$&7B.(<
$3B$&7B.(<Q
$FWLRQVWUHDP
$FWLRQVWUHDP
$FWLRQVWUHDPQ
dwItems
Número de acciones, es decir, de AP_ACT_KEY (Página 603).
fpAppBack
Su función Callback para la llamada asíncrona. Cuando se utiliza con NULL, la llamada se
ejecuta de forma sincrónica.
Si un programa notifica una rutina Notify, deberá vaciar periódicamente su Message Queue.
Los mensajes no recogidos pueden bloquear notificaciones WinCC y, con ello, todo el WinCC.
pdwOrderId
Número de petición otorgado al llamar la función APTransAct. En una llamada sincrónica
pdwOrderID no es relevante, en una petición asíncrona se suministra el número de petición
en la función Callback.
lpvUser
Puntero en datos específicos de la aplicación. Este puntero no es evaluado por la función,
sino que se pone nuevamente a disposición en la función Callback.
pError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Acción activada.
FALSE
Error.
Archivos requeridos
ap_def.h
apcli_S.lib
apclient.dll
Funciones relacionadas
Consulte también
AP_RT_PROC (Página 614)
AP_ACT_KEY (Página 603)
APInactive (Página 630)
APTransact (Página 634)
Sinopsis de las funciones (Página 598)
Descripción
La acción registrada para su ejecución se da de baja en el controlador de acción.
Declaración
BOOL APEndAct (
AP_RT_PROC fpAppBack,
PDWORD pdwOrderId,
const PDWORD pdwOrderEnd,
LPCVOID lpvUser,
PCMN_ERROR pError )
Parámetro
fpAppBack
Su función Callback para la llamada asíncrona. Cuando se utiliza con NULL, la llamada se
ejecuta de forma sincrónica.
Si un programa notifica una rutina Notify, deberá vaciar periódicamente su Message Queue.
Los mensajes no recogidos pueden bloquear notificaciones WinCC y, con ello, todo el WinCC.
pdwOrderId
Número de petición otorgado al llamar la función APTransAct. En una llamada sincrónica
pdwOrderID no es relevante, en una petición asíncrona se suministra el número de petición
en la función Callback.
pdwOrderEnd
Número de petición de la transacción que se debe finalizar.
lpvUser
Puntero en datos específicos de la aplicación. Este puntero no es evaluado por la función,
sino que se pone nuevamente a disposición en la función Callback.
pError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Acción dada de baja.
FALSE
Error.
Archivos requeridos
ap_def.h
apcli_S.lib
apclient.dll
Funciones relacionadas
Consulte también
AP_RT_PROC (Página 614)
APTransact (Página 634)
Sinopsis de las funciones (Página 598)
Descripción
En la llamada sincrónica de la función APStart los resultados de acción se asignan en forma
de Array de estructuras tipo AP_ACT_RESULT_STRUCT. La memoria asignada por APStart
se debe habilitar nuevamente con la funciónAPFreeResultStruct.
Declaración
BOOL APFreeResultStruct (
PAP_ACT_RESULT_STRUCT *lpapars,
const DWORD dwItems )
Parámetro
lpvPcode
Puntero en la primera de las estructuras dwItem del tipo AP_ACT_RESULT_STRUCT
(Página 605).
dwItems
Número de estructuras AP_ACT_RESULT_STRUCT.
Valor de retorno
TRUE
Memoria habilitada.
FALSE
Error.
Archivos requeridos
ap_def.h
apcli_S.lib
apclient.dll
Funciones relacionadas
Consulte también
APStart (Página 632)
AP_ACT_RESULT_STRUCT (Página 605)
Sinopsis de las funciones (Página 598)
Descripción
Las acciones registradas con APTransAct se pueden desactivar con APInactive. Los
disparadores correspondientes se dejan de supervisar y las acciones no se pueden iniciar con
APStart. Las acciones se pueden activar nuevamente con APActive.
Declaración
BOOL APInactive (
PAP_ACT_KEY lpActKey,
const DWORD dwItems,
AP_RT_PROC fpAppBack,
PDWORD pdwOrderId,
LPCVOID lpvUser,
PCMN_ERROR pError )
Parámetro
lpapActKey
Puntero en una estructura de datos con la siguiente estructura:
$3B$&7B.(<
$3B$&7B.(<
$3B$&7B.(<Q
$FWLRQVWUHDP
$FWLRQVWUHDP
$FWLRQVWUHDPQ
dwItems
Número de acciones, es decir, de AP_ACT_KEY (Página 603).
fpAppBack
Su función Callback para la llamada asíncrona. Cuando se utiliza con NULL, la llamada se
ejecuta de forma sincrónica.
Si un programa notifica una rutina Notify, deberá vaciar periódicamente su Message Queue.
Los mensajes no recogidos pueden bloquear notificaciones WinCC y, con ello, todo el WinCC.
pdwOrderId
Número de petición otorgado al llamar la función APTransAct. En una llamada sincrónica
pdwOrderID no es relevante, en una petición asíncrona se suministra el número de petición
en la función Callback.
lpvUser
Puntero en datos específicos de la aplicación. Este puntero no es evaluado por la función,
sino que se pone nuevamente a disposición en la función Callback.
pError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Acción desactivada.
FALSE
Error.
Archivos requeridos
ap_def.h
apcli_S.lib
apclient.dll
Funciones relacionadas
Consulte también
AP_RT_PROC (Página 614)
APActive (Página 625)
AP_ACT_KEY (Página 603)
APTransact (Página 634)
Sinopsis de las funciones (Página 598)
Descripción
Las acciones se inician para su ejecución. Es posible ejecutar varias acciones
simultáneamente. Las acciones se describen en la estructura AP_ACT_KEY.
Declaración
BOOL APStart (
AP_ACT_KEY lpapActKey,
const DWORD dwItems,
AP_RT_PROC fpAppBack,
AP_RT_PROC fpAppResult,
PDWORD pdwOrderId,
PAP_ACT_RESULT_STRUCT *lpapars,
LPCVOID lpUser,
PCMN_ERROR pError )
Parámetro
lpapActKey
Puntero en una estructura de datos con la siguiente estructura:
$3B$&7B.(<
$3B$&7B.(<
$3B$&7B.(<Q
$FWLRQVWUHDP
$FWLRQVWUHDP
$FWLRQVWUHDPQ
dwItems
Número de acciones, es decir, de AP_ACT_KEY (Página 603).
fpAppBack
Su función Callback para la llamada asíncrona. Cuando se utiliza con NULL, la llamada se
ejecuta de forma sincrónica.
Si un programa notifica una rutina Notify, deberá vaciar periódicamente su Message Queue.
Los mensajes no recogidos pueden bloquear notificaciones WinCC y, con ello, todo el WinCC.
fAppResult
Su función Callback para resultados de acción de ejecución cíclica. En la función Callback se
suministran las estructuras del tipo AP_ACT_RESULT_STRUCT (Página 605). En una
llamada sincrónica, lpapars se ocupa con el resultado.
pdwOrderId
Número de petición otorgado al llamar la función APTransAct. En una llamada sincrónica
pdwOrderID no es relevante, en una petición asíncrona se suministra el número de petición
en la función Callback.
lpapars
Puntero en el resultado de acción en una llamada sincrónica. Conforme al número de acciones
iniciadas se devuelve un Array de estructuras del tipo AP_ACT_RESULT_STRUCT
(Página 605). La memoria es asignada por la función y se debe habilitar nuevamente con
APFreeResultStruct.
En una utilización asíncrona es lpapars = NULL
lpvUser
Puntero en datos específicos de la aplicación. Este puntero no es evaluado por la función,
sino que se pone nuevamente a disposición en la función Callback.
pError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Acción iniciada
FALSE
Error.
Observación
Con APStart se pueden iniciar únicamente acciones no desactivadas previamente con
APInactive.
Archivos requeridos
ap_def.h
apcli_S.lib
apclient.dll
Funciones relacionadas
Consulte también
AP_RT_PROC (Página 614)
APFreeResultStruct (Página 629)
AP_ACT_KEY (Página 603)
AP_ACT_RESULT_STRUCT (Página 605)
Sinopsis de las funciones (Página 598)
Utilización
Declaración
Parámetro
xxx
xxx
lpdmError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
.
FALSE
Error.
Observación
Archivos requeridos
ap_def.h
apcli_S.lib
apclient.dll
Funciones relacionadas
Ejemplos
Auto-Hotspot "DM01.cpp"
Consulte también
APConnect (Página 609)
APDisconnect (Página 611)
AP_RT_PROC (Página 614)
APActive (Página 625)
APEndAct (Página 627)
APInactive (Página 630)
AP_ACT_KEY (Página 603)
Sinopsis de las funciones (Página 598)
Sinopsis
//
====================================================================
=
// Filename:.......... ap01.c
//
====================================================================
=
// : Modul with examples of AP_API
//
********************************************************************
*
// Copyright (C) 1995/96 SIEMENS AG, AUT 913 All rights reserved
//
********************************************************************
*
#include "stdafx.h"
#include "ap01.h" // if console application
void MyApConnect(void)
{
TCHAR szText[255];
CMN_ERROR Error;
BOOL ret= FALSE;
DWORD dwOrderID = 0;
TCHAR szApp[255];
VOID* pUser = NULL;
_tcsncpy_s(szApp, _countof(szApp), _T("MyODKApp_23"),
_TRUNCATE); // must be the same AppName as by DMConnect
memset(&Error, 0, sizeof(CMN_ERROR));
ret = APConnect(szApp, MyAPRTCallback, &dwOrderID, pUser, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error
in APConnect: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2,
Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE,
_T("APConnect"));
}
ODKTrace(szText);
//printf("%s\r\n"szText);
void MyAPDisconnect()
VOID* pUser = NULL;
CMN_ERROR Error;
TCHAR szText[255];
BOOL ret = FALSE;
DWORD dwOrderID = 0;
memset(&Error, 0, sizeof(CMN_ERROR));
ret = APDisconnect(NULL, &dwOrderID, pUser, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error
in APDisconnect: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2,
Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE,
_T("APDisconnect"));
}
ODKTrace(szText);
}
//
--------------------------------------------------------------------
//{{ODK_EXAMPLE}(END)}
Consulte también
APConnect (Página 609)
APDisconnect (Página 611)
AP_RT_PROC (Página 614)
Sinopsis
Sinopsis
Sinopsis
Las funciones API pueden devolver los siguientes mensajes de error en la estructura de error
CMN_ERROR:
MAX_LOGIN 25
MAX_PASS 25
MAX_LEVEL 70
Declaración
typedef struct {
TCHAR name[MAX_LOGIN];
int expiration_time;
}
PWGEN_GROUPINFO;
Miembros
name
Nombre del grupo de usuarios
expiration_time
Tiempo de cierre de sesión automático en minutos
Archivos necesarios
usegenap.h
Funciones API
Consulte también
PWGEN_ENUM_GROUPS_CALLBACK (Página 660)
Declaración
typedef struct {
int levelNumber;
DWORD dwTextID;
}
PWGEN_LEVELINFO;
Miembros
levelNumber
Número de la autorización
dwTextID
ID con la que se identifica la descripción de la autorización.
Archivos necesarios
usegenap.h
Funciones API
Consulte también
PWGEN_ENUM_LEVELS_CALLBACK (Página 666)
Declaración
typedef struct {
TCHAR login[MAX_LOGIN];
TCHAR group[MAX_LOGIN];
int expiration_time;
}
PWGEN_USERINFO;
Miembros
login
Nombre de inicio de sesión del usuario
group
Nombre del grupo al que pertenece el usuario
expiration_time
Tiempo de cierre de sesión automático en minutos
Archivos necesarios
usegenap.h
Funciones API
Consulte también
PWGEN_ENUM_USERS_CALLBACK (Página 655)
Descripción
La función registra la conexión con la base de datos del proyecto abierto actualmente.
Declaración
BOOL PWGENConnect (
LPCTSTR DSNName,
LPCMN_ERROR err)
Parámetro
DSNName
Nombre de fuente de datos del proyecto. El parámetro DSNName no se evaluará. Se puede
transmitir una cadena vacía, pero no CERO. Se utiliza siempre la base de datos del proyecto
abierto actualmente.
err
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Conexión registrada
FALSE
Errores
Comentario
Cada aplicación sólo puede ejecutar un Connect. En el caso de un Connect repetido se
devuelve el mensaje de error PWGEN_API_IS_CONNECTED.
Mensajes de error
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
Funciones similares
Consulte también
PWGENDisconnect (Página 645)
Sinopsis de las funciones (Página 638)
Descripción
La conexión con la base de datos del proyecto abierto actualmente se deshace de nuevo.
Declaración
BOOL PWGENDisconnect (
LPCMN_ERROR err)
Parámetro
err
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Conexión deshecha
FALSE
Errores
Comentario
Antes de cerrar la aplicación se debe realizar un PWGENDisconnect, de lo contrario no se
autorizan más las interfaces UserAdminASO utilizadas internamente.
Nota
La llamada no se debe usar en el destructor de una aplicación (EXE, DLL, OCX, ...). Debido
a mecanismos específicos de Microsoft esto puede llevar, si se diera el caso, al bloqueo de
la llamada y con ello al del programa.
Mensajes de error
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
Funciones similares
Consulte también
PWGENConnect (Página 643)
Sinopsis de las funciones (Página 638)
Descripción
La función crea un nuevo usuario incluyendo una matriz de autorización de usuario vacía. Con
la función PWGENAddUserEx se pueden transmitir las autorizaciones del grupo al usuario
que va a crearse.
Declaración
BOOL PWGENAddUser (
LPCTSTR username,
LPCTSTR password,
LPCTSTR group,
int expiration_time,
LPCMN_ERROR error)
Parámetro
username
Nombre de inicio de sesión del nuevo usuario
password
Contraseña del usuario
group
Grupo en el que se debe añadir al usuario
expiration_time
Tiempo de cierre de sesión automático en minutos Si el expiration_time seleccionado está
fuera del rango admisible, se le asignará un 0.
error
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Usuario creado
FALSE
Errores
Mensajes de error
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
Funciones similares
Consulte también
PWGENAddUserEx (Página 648)
Sinopsis de las funciones (Página 638)
Descripción
La función crea un nuevo usuario. En función del parámetro copy_group_protection se pueden
transmitir las autorizaciones del grupo al usuario que va a crearse.
Declaración
BOOL PWGENAddUserEx (
LPCTSTR username,
LPCTSTR password,
LPCTSTR group,
int expiration_time,
BOOL copy_group_permissions,
LPCMN_ERROR error)
Parámetro
username
Nombre de inicio de sesión del nuevo usuario
password
Contraseña del usuario
group
Grupo en el que se debe añadir al usuario
expiration_time
Tiempo de cierre de sesión automático en minutos Si el expiration_time seleccionado está
fuera del rango admisible, se le asignará un 0.
copy_group_permissions
Si copy_group_permission = TRUE, se transmitirán las autorizaciones de usuario del grupo
al nuevo usuario que va a crearse.
error
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Usuario creado
FALSE
Errores
Mensajes de error
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
Funciones similares
Consulte también
PWGENAddUser (Página 646)
Sinopsis de las funciones (Página 638)
Descripción
Con esta función se puede modificar la contraseña del usuario especificado con username.
Declaración
BOOL PWGENChangePassword (
LPCTSTR username,
LPCTSTR oldpassword,
LPCTSTR newpassword,
LPCMN_ERROR error)
Parámetro
username
Nombre de inicio de sesión del usuario
oldpassword
Contraseña antigua del usuario
newpassword
Contraseña nueva del usuario
error
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Contraseña modificada
FALSE
Errores
Mensajes de error
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
Consulte también
Sinopsis de las funciones (Página 638)
Descripción
Se comprueba si el usuario indicado existe en el proyecto WinCC actual y si la contraseña
facilitada es correcta.
Declaración
BOOL PWGENCheckUser (
LPCTSTR username,
LPCTSTR password,
LPCMN_ERROR error)
Parámetro
username
Nombre del usuario.
password
La contraseña que pertenece al usuario indicado.
error
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
El usuario existe y la contraseña es correcta.
FALSE
Errores
Mensajes de error
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
Consulte también
Sinopsis de las funciones (Página 638)
Descripción
El usuario o grupo de usuarios indicado se borra incluyendo los datos de autorización.
Declaración
BOOL PWGENDeleteUser (
LPCTSTR username,
BOOL is_user,
LPCMN_ERROR error)
Parámetro
username
Nombre del usuario que debe borrarse.
is_user
El parámetro is_user sirve para diferenciar si debe borrarse un usuario o un grupo de usuarios.
error
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Usuario o grupo de usuarios borrado
FALSE
Errores
Comentario
Cuando se intenta borrar el administrador, la función envía el error
PWGEN_API_EXIST_USER.
Mensajes de error
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
Consulte también
Sinopsis de las funciones (Página 638)
Descripción
La función lee los usuarios configurados, para cada usuario llama a la función Callback y
devuelve el número de usuarios en dwCount.
Declaración
BOOL PWGENEnumUsers (
LPDWORD dwCount,
PWGEN_ENUM_USERS_CALLBACK cfn,
PVOID userdata,
LPCMN_ERROR error)
Parámetro
dwCount
Puntero en el lugar de memoria en el que se debe almacenar el número de usuarios.
cfn
Su función Callback que acepta la información. Cuando cfn == NULL, sólo se cuentan los
usuarios.
userdata
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
error
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Listado de los usuarios
FALSE
Errores
Mensajes de error
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
Funciones similares
Consulte también
PWGEN_ENUM_USERS_CALLBACK (Página 655)
Sinopsis de las funciones (Página 638)
Descripción
Para poder evaluar la información de usuario listada por el sistema, es necesario preparar
una función Callback del tipo PWGEN_ENUM_USERS_CALLBACK.
Declaración
BOOL ( * PWGEN_ENUM_USERS_CALLBACK) (
LPWGEN_USERINFO lpUserInfo,
PVOID lpUser);
Parámetro
lpUserInfo
Puntero hacia una estructura del tipo PWGEN_USERINFO (Página 642) con los datos de un
usuario.
lpUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
Listado de los usuarios
FALSE
Error
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
usegenap.h
Funciones relacionadas
Consulte también
PWGENEnumUsers (Página 654)
PWGEN_USERINFO (Página 642)
Sinopsis de las funciones (Página 638)
Descripción
La función crea un nuevo grupo de usuarios incluyendo una matriz de autorización de usuario
vacía.
Declaración
BOOL PWGENAddGroup (
LPCTSTR username,
int expiration_time,
LPCMN_ERROR error)
Parámetro
username
Nombre del grupo que va a crearse
expiration_time
Tiempo de cierre de sesión automático. Si el expiration_time seleccionado está fuera del rango
admisible, se le asignará un 0.
error
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Grupo de usuarios creado
FALSE
El grupo de usuarios ya existe
Comentario
Para borrar un grupo de usuarios existente, utilice la función PWGENDeleteUser.
Mensajes de error
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
Funciones similares
Consulte también
PWGENDeleteUser (Página 652)
Sinopsis de las funciones (Página 638)
Descripción
La función lee los grupos de usuarios configurados, para cada grupo llama a la función
Callback y devuelve el número de grupos en dwCount.
Declaración
BOOL PWGENEnumGroups (
LPDWORD dwCount,
PWGEN_ENUM_GROUPS_CALLBACK cfn,
PVOID userdata,
LPCMN_ERROR error)
Parámetro
dwCount
Puntero en el lugar de memoria en el que se debe almacenar el número de grupos de usuarios.
cfn
Su función Callback que acepta la información. Cuando cfn == NULL, sólo se cuentan los
grupos de usuarios.
userdata
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
error
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Listado de los grupos de usuarios
FALSE
Errores
Mensajes de error
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
Funciones similares
Consulte también
PWGEN_ENUM_GROUPS_CALLBACK (Página 660)
Sinopsis de las funciones (Página 638)
Descripción
Para poder evaluar la información de grupos de usuarios listada por el sistema, es necesario
preparar una función Callback del tipo PWGEN_ENUM_GROUPS_CALLBACK.
Declaración
BOOL ( * PWGEN_ENUM_GROUPS_CALLBACK) (
LPWGEN_GROUPINFO lpGroupInfo,
PVOID lpUser);
Parámetro
lpUserInfo
Puntero hacia una estructura del tipo PWGEN_GROUPINFO (Página 641) con los datos de
un grupo de usuarios.
lpUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
Listado de los grupos de usuarios
FALSE
Error
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
usegenap.h
Funciones relacionadas
Consulte también
PWGENEnumGroups (Página 658)
PWGEN_GROUPINFO (Página 641)
Sinopsis de las funciones (Página 638)
Descripción
Crea una nueva autorización para todos los usuarios.
Declaración
BOOL PWGENAddPermLevel (
DWORD txtID,
int number,
LPCMN_ERROR error)
Parámetro
txtID
ID del texto para la autorización.
number
Número de la autorización que va a crearse
error
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Nivel de autorización creado
FALSE
Errores
Mensajes de error
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
Consulte también
Sinopsis de las funciones (Página 638)
Descripción
Con esta función se comprueba si el usuario posee las autorizaciones de uso para el nivel de
autorización indicado.
Declaración
BOOL PWGENCheckPermission(
LPCTSTR username,
DWORD permlevel,
LPCMN_ERROR error)
Parámetro
username
Nombre del usuario
permlevel
Número de la autorización que hay que comprobar
error
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
La autorización de uso para el nivel de autorización del usuario existe.
FALSE
Errores
Mensajes de error
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
Consulte también
Sinopsis de las funciones (Página 638)
Descripción
Borra de las matrices de autorización de usuario el nivel de autorización especificado con
levelNumber.
Declaración
BOOL PWGENDeletePermLevel (
int levelNumber,
LPCMN_ERROR error)
Parámetro
levelNumber
Número de la autorización que hay que borrar
error
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Nivel de autorización borrado
FALSE
Errores
Mensajes de error
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
Consulte también
Sinopsis de las funciones (Página 638)
Descripción
La función lee los niveles de autorización configurados, llama a la función Callback para cada
nivel y devuelve el número de niveles de autorización en dwCount.
Declaración
BOOL PWGENEnumPermLevels (
LPDWORD dwCount,
PWGEN_ENUM_LEVELS_CALLBACK cfn,
PVOID userdata,
LPCMN_ERROR error)
Parámetro
dwCount
Puntero en el lugar de memoria en el que se almacena el número de niveles de autorizaciones.
cfn
Su función Callback que acepta la información. Cuando cfn == NULL, sólo se cuentan las
autorizaciones.
userdata
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
error
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Listado de niveles de autorización
FALSE
Errores
Mensajes de error
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
Funciones similares
Consulte también
PWGEN_ENUM_LEVELS_CALLBACK (Página 666)
Sinopsis de las funciones (Página 638)
Descripción
Para poder evaluar los niveles de autorización listados por el sistema, es necesario preparar
una función Callback del tipo PWGEN_ENUM_LEVELS_CALLBACK.
Declaración
BOOL ( * PWGEN_ENUM_LEVELS_CALLBACK) (
LPWGEN_LEVELINFO lpLevelInfo,
PVOID lpUser);
Parámetro
lpLevelInfo
Puntero hacia una estructura del tipo PWGEN_LEVELINFO (Página 642) con los datos del
nivel de autorización.
lpUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
Listado de niveles de autorización
FALSE
Error
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
usegenap.h
Funciones relacionadas
Consulte también
PWGENEnumPermLevels (Página 665)
PWGEN_LEVELINFO (Página 642)
Sinopsis de las funciones (Página 638)
Descripción
Con esta función se determinan las áreas para las que un usuario necesita autorizaciones de
uso en un determinado nivel de autorización.
Declaración
BOOL PWGENReadUserPerm(
LPCTSTR username,
BOOL is_user,
int levelnumber,
LPBYTE autorización,
LPDWORD areaperms )
Parámetro
username
Nombre del usuario o del grupo de usuarios
is_user
is_user indica si username se trata de un usuario o de un grupo de usuarios.
TRUE Usuarios
FALSE Grupo de usuarios
levelnumber
Número de la autorización que hay que leer
freigabe
Si freigabe = 1, entonces el usuario posee la autorización de uso para todas las áreas en este
nivel de autorización.
areaperms
Con los 32 bit de areaperm se caracterizan las áreas. Si un usuario posee la autorización para
un área, entonces se activa el correspondiente bit. En este sentido, el bit de valor más bajo
corresponde con la primera área.
Valor de retorno
TRUE
Autorizaciones de uso determinadas
FALSE
Errores
Archivos necesarios
usegenap.h
usegen.lib
usegen.dll
Consulte también
Sinopsis de las funciones (Página 638)
Descripción
Comprueba si el usuario registrado tiene la autorización de uso para la autorización facilitada.
Declaración
BOOL PWRTCheckPermission (
DWORD permlevel,
DWORD suppress_messagebox )
Parámetro
permlevel
Número del nivel de autorización que hay que comprobar.
suppress_messagebox
Con suppress_messagebox != 0 no se muestra ningún diálogo.
Valor de retorno
TRUE
Autorización asignada
FALSE
Autorización no asignada
Archivos necesarios
pwrt_api.h
pass_s.lib
useadmin.dll
Ejemplos
PWRT check permission (Página 684)"PWRTBunch.cpp"
Consulte también
PWRT check permission (Página 684)
Sinopsis de las funciones (Página 638)
Descripción
Comprueba si el usuario registrado tiene la autorización de uso para la autorización facilitada.
Declaración
BOOL PWRTCheckPermissionOnPicture (
DWORD permlevel,
LPCTSTR picture_name,
DWORD suppress_messagebox,
LPCMN_ERROR lperr )
Parámetro
permlevel
Número de la autorización que hay que comprobar.
picture_name
Nombre de la imagen en la que está el objeto que hay que probar.
suppress_messagebox
Con suppress_messagebox != 0 no se muestra ningún diálogo.
lperr
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Autorización asignada
FALSE
Autorización no asignada
Archivos necesarios
pwrt_api.h
pass_s.lib
useadmin.dll
Ejemplos
Checks admission of a certain level for a picture (Página 685)"PWRTBunch.cpp"
Consulte también
Checks admission of a certain level for a picture (Página 685)
Sinopsis de las funciones (Página 638)
Descripción
Es necesario abrir el diálogo para seleccionar la autorización con la función
PWRTPermisssionLevelDialogEx, ya que al mover la ventana de diálogo se realiza un
redibujado.
Declaración
LONG PWRTPermissionLevelDialog (
)
Parámetro
Ninguno
Funciones similares
Ejemplos
Permission level query through a dialog with specifying a possible error
(Página 687)"PWRTBunch.cpp"
Consulte también
Permission level query through a dialog with specifying a possible error (Página 687)
PWRTPermissionLevelDialogEx (Página 672)
PWRTPermissionToString (Página 673)
Sinopsis de las funciones (Página 638)
Descripción
La protección de la manejabilidad de objetos se realiza en WinCC con un diálogo para la
selección de una autorización. PWRTPermissionLevelDialogEx abre el correspondiente
diálogo en el que se ofrecen las autorizaciones disponibles para su selección.
Declaración
LONG PWRTPermissionLevelDialogEx (
HWND hParentWnd,
CMN_ERROR *lpErr)
Parámetro
hParentWnd
Handle en la ventana principal del diálogo.
lpErr
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
0-999: Nivel de autorización
-1: El diálogo se ha finalizado con Cancelar.
Archivos necesarios
pwrt_api.h
pass_s.lib
useadmin.dll
Ejemplo
Permission level query through a dialog with specifying a possible error
(Página 687)"PWRTBunch.cpp"
Consulte también
PWRTPermissionLevelDialog (Página 671)
Permission level query through a dialog with specifying a possible error (Página 687)
Sinopsis de las funciones (Página 638)
Descripción
Determina la descripción correspondiente a un nivel de autorización.
Declaración
BOOL PWRTPermissionToString (
LONG perm,
LPTSTR string,
int bufsize)
Parámetros
perm
Nivel de autorización cuya descripción debe determinarse.
string
Puntero al búfer que recoge la descripción
bufsize
Tamaño del búfer
Valor de retorno
TRUE
Descripción transferida correctamente.
FALSE
No se ha podido determinar la descripción.
Archivos necesarios
pwrt_api.h
pass_s.lib
useadmin.dll
Funciones relacionadas
Ejemplos
Gets a string associated with the permission number (Página 686). "PWRTBunch.cpp"
Consulte también
PWRTPermissionLevelDialog (Página 671)
Gets a string associated with the permission number (Página 686)
Sinopsis de las funciones (Página 638)
Descripción
Determina el nombre del usuario del usuario registrado actualmente.
Declaración
BOOL PWRTGetCurrentUser (
LPTSTR dest,
int bufsize )
Parámetro
dest
Búfer de datos para recibir el nombre de usuario
bufsize
Tamaño del búfer de datos bytes
Valor de retorno
TRUE
Nombre del usuario transferido correctamente
FALSE
No se ha registrado ningún usuario
Archivos necesarios
pwrt_api.h
pass_s.lib
useadmin.dll
Ejemplos
Return the name of the current user (Página 688)"PWRTBunch.cpp"
Consulte también
Return the name of the current user (Página 688)
Sinopsis de las funciones (Página 638)
Descripción
Comprobación del inicio de sesión sin diálogo.
Declaración
LONG PWRTGetLoginPriority (
)
Parámetro
Ninguno
Valor de retorno
Nivel de prioridad:
LOGIN_STANDARD (Valor: 0)
LOGIN_CARD (Valor: 1)
LOGIN_KEYSWITCH (Valor: 2)
Archivos necesarios
pwrt_api.h
pass_s.lib
useadmin.dll
Ejemplos
Queries the current login priority (Página 689)"PWRTBunch.cpp"
Consulte también
Queries the current login priority (Página 689)
Sinopsis de las funciones (Página 638)
Descripción
Determina si el usuario se ha registrado a través de tarjeta chip.
Declaración
BOOL PWRTIsLoggedInByCard (
)
Parámetro
Ninguno
Valor de retorno
TRUE
Usuario dado de alta con tarjeta chip
FALSE
Usuario no dado de alta con tarjeta chip o no dado de alta
Archivos necesarios
pwrt_api.h
pass_s.lib
useadmin.dll
Ejemplos
Checks for the user has been logged on by card (Página 689)"PWRTBunch.cpp"
Consulte también
Checks for the user has been logged on by card (Página 689)
Sinopsis de las funciones (Página 638)
Descripción
Abre el diálogo de inicio de sesión y carga los datos de usuario en la memoria compartida en
caso de inicio de sesión correcto.
Declaración
BOOL PWRTLogin (
TCHAR monitor )
Parámetro
monitor
Pantalla en la que se abre el diálogo. El valor no se indica numéricamente, sino en formato
TCHAR, por lo tanto '1' para la pantalla 1.
Valor de retorno
TRUE
Diálogo abierto. La función no espera a la finalización del diálogo.
FALSE
Diálogo no abierto
Comentario
Además de la introducción manual de los datos de inicio de sesión, también es posible iniciar
la sesión con una tarjeta chip. El lector de tarjetas está conectado directamente al sistema
operativo. Si al ejecutar la función hay conectada una tarjeta válida, el diálogo de inicio de
sesión se oculta automáticamente.
Archivos necesarios
pwrt_api.h
pass_s.lib
useadmin.dll
Funciones similares
Ejemplos
PWRT login - dialog provided by WinCC itself (Página 690)"PWRTBunch.cpp"
Consulte también
PWRTSilentLogin (Página 681)
PWRT login - dialog provided by WinCC itself (Página 690)
PWRTSilentLoginEx (Página 682)
Sinopsis de las funciones (Página 638)
Descripción
Esta función provoca que en la memoria compartida se active un indicador cuando la sesión
está cerrada.
Declaración
BOOL PWRTLogout (
)
Parámetro
Ninguno
Valor de retorno
TRUE
Cierre de sesión transmitido correctamente a PassDBRT.
FALSE
Cierre de sesión rechazado (por ejemplo: PassDBRT no disponible, ServiceMode, ...).
Archivos necesarios
pwrt_api.h
pass_s.lib
useadmin.dll
Funciones similares
Ejemplos
PWRT logout (Página 691)"PWRTBunch.cpp"
Consulte también
PWRT logout (Página 691)
PWRTLogoutEx (Página 680)
Sinopsis de las funciones (Página 638)
Descripción
Esta función provoca que en la memoria compartida se active un indicador cuando la sesión
está cerrada, siempre que el nivel de prioridad indicado no sea demasiado bajo.
Declaración
BOOL PWRTLogoutEx (
int nLevel
)
Parámetro
nLevel
Nivel de prioridad del usuario.
Valor de retorno
TRUE
Cierre de sesión transmitido correctamente a PassDBRT.
FALSE
Cierre de sesión rechazado (por ejemplo: PassDBRT no disponible, ServiceMode, ...).
Archivos necesarios
pwrt_api.h
pass_s.lib
useadmin.dll
Funciones similares
Ejemplos
Silent logout with priority level (Página 692)"PWRTBunch.cpp"
Consulte también
Silent logout with priority level (Página 692)
PWRTLogout (Página 679)
Sinopsis de las funciones (Página 638)
Descripción
A diferencia de PWRTLogin el inicio de sesión no se realiza con un diálogo. Los datos del
usuario, nombre de usuario y contraseña se transmiten directamente a la función.
Declaración
BOOL PWRTSilentLogin (
LPCTSTR login,
LPCTSTR password )
Parámetro
login
Nombre del usuario.
password
Contraseña del usuario
Valor de retorno
TRUE
Inicio de sesión correcto
FALSE
Inicio de sesión rechazado
Comentario
Si al ejecutar la función hay conectada una tarjeta chip válida, se rechaza el inicio de sesión.
Archivos necesarios
pwrt_api.h
pass_s.lib
useadmin.dll
Funciones similares
Ejemplos
Login without using a dialog (Página 693)"PWRTBunch.cpp"
Consulte también
PWRTLogin (Página 677)
PWRTSilentLoginEx (Página 682)
Login without using a dialog (Página 693)
Sinopsis de las funciones (Página 638)
Descripción
A diferencia de PWRTLogin el inicio de sesión no se realiza con un diálogo. Los datos del
usuario (nombre de usuario, contraseña y nivel de prioridad) se transmiten directamente a la
función.
Declaración
BOOL PWRTSilentLoginEx (
LPCTSTR login,
LPCTSTR password,
int nLevel)
Parámetro
login
Nombre del usuario.
password
Contraseña del usuario
nLevel
Nivel de prioridad del usuario
Valor de retorno
TRUE
Inicio de sesión correcto
FALSE
Inicio de sesión rechazado
Comentario
Si al ejecutar la función hay conectada una tarjeta chip válida, se rechaza el inicio de sesión.
Archivos necesarios
pwrt_api.h
pass_s.lib
useadmin.dll
Funciones similares
Ejemplos
Silent login with priority level (Página 694)"PWRTBunch.cpp"
Consulte también
PWRTSilentLogin (Página 681)
Silent login with priority level (Página 694)
PWRTLogin (Página 677)
Sinopsis de las funciones (Página 638)
Ejemplo
//{{ODK_EXAMPLE}(END)}
Consulte también
PWRTCheckPermission (Página 669)
Ejemplo
Consulte también
PWRTCheckPermissionOnPicture (Página 670)
2.5.8.3 Gets a string associated with the permission number (RT Professional)
Sinopsis
//{{ODK_EXAMPLE}Gets a string associated with the permission number.
(USE)}
//{{FUNCTION}PWRTPermissionToString (USE)}
//{{FUNCTION}(END)}
void CPWRTBunch::Pwrtpermissiontostring()
{
BOOL bRet;
CString csOut;
CString csPermLevName;
CGetText l_PermissionLevel("Insert the permission level
number:");
if(l_PermissionLevel.DoModal()==IDOK)
{
////////////////////////////////////////////////////////////
/////////////////////////////
bRet=PWRTPermissionToString(l_PermissionLevel.m_lNumber,
csPermLevName.GetBuffer(1024), 1024);
////////////////////////////////////////////////////////////
/////////////////////////////
if(!bRet)
{
m_pView->Print("ERROR: ", FSIZE_FUNCMARK);
m_pView->Print("PWRTPermissionToString.\n",
FSIZE_PARAMMARK, FALSE, TRUE);
m_pView->Print("\n");
return;
}
csOut.Format("PWRTPermissionToString( %ld, buffer )\n",
l_PermissionLevel.m_lNumber);
m_pView->Print(csOut, FSIZE_FUNCMARK, TRUE);
m_pView->Print("Permission level name:\n", FSIZE_PARAMMARK,
FALSE, TRUE);
csOut.Format("buffer = \"%s\"\n", csPermLevName);
m_pView->Print(csOut, FSIZE_SUBMARK);
m_pView->Print("\n");
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
PWRTPermissionToString (Página 673)
2.5.8.4 Permission level query through a dialog with specifying a possible error (RT Professional)
Ejemplo
Consulte también
PWRTPermissionLevelDialog (Página 671)
PWRTPermissionLevelDialogEx (Página 672)
Ejemplo
Consulte también
PWRTGetCurrentUser (Página 674)
Ejemplo
Consulte también
PWRTGetLoginPriority (Página 675)
2.5.8.7 Checks for the user has been logged on by card (RT Professional)
Sinopsis
////////////////////////////////////////////////////////////////
/////////////////////////
if(bRet)
{
m_pView->Print("PWRTIsLoggedInByCard\n", FSIZE_FUNCMARK,
TRUE);
m_pView->Print("An user show-up logged in by card.\n",
FSIZE_PARAMMARK, FALSE, TRUE);
}
else
{
m_pView->PrintError(_T("Either no user logged-on-by-card or
no user logged on at all."),
_T("PWRTIsLoggedInByCard()"));
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
PWRTIsLoggedInByCard (Página 676)
Ejemplo
Consulte también
PWRTLogin (Página 677)
Ejemplo
Consulte también
PWRTLogout (Página 679)
Ejemplo
Consulte también
PWRTLogoutEx (Página 680)
Ejemplo
Consulte también
PWRTSilentLogin (Página 681)
Ejemplo
Consulte también
PWRTSilentLoginEx (Página 682)
Declaración
Sinopsis
Las funciones API pueden devolver los siguientes mensajes de error en la estructura de error
CMN_ERROR:
Text Library RT
LANG_ARABIC 0x0401
LANG_AFRIKAANS 0x0436
LANG_ALBANIAN 0x041C
LANG_BASQUE 0x042D
LANG_BULGARIAN 0x0402
LANG_BELARUSIAN 0x0423
LANG_CATALAN 0x0403
LANG_CHINESE 0x0804
LANG_CROATIAN 0x041A
LANG_CZECH 0x0405
LANG_DANISH 0x0406
LANG_DUTCH 0x0413
LANG_ENGLISH 0x0409
LANG_ESTONIAN 0x0425
LANG_FAEROESE 0x0438
LANG_FARSI 0x0429
LANG_FINNISH 0x040B
LANG_FRENCH 0x040C
LANG_GERMAN 0x0407
LANG_GREEK 0x0408
LANG_HEBREW 0x040D
LANG_HUNGARIAN 0x040E
LANG_ICELANDIC 0x040F
LANG_INDONESIAN 0x0421
LANG_ITALIAN 0x0410
LANG_JAPANESE 0x0411
LANG_KOREAN 0x0412
LANG_LATVIAN 0x0426
LANG_LITHUANIAN 0x0427
LANG_NORWEGIAN 0x0414
LANG_POLISH 0x0415
LANG_PORTUGUESE 0x0416
LANG_ROMANIAN 0x0418
LANG_RUSSIAN 0x0419
LANG_SLOVAK 0x041B
LANG_SLOVENIAN 0x0424
LANG_SPANISH 0x040A
LANG_SWEDISH 0x041D
LANG_THAI 0x041E
LANG_TURKISH 0x041F
LANG_UKRAINIAN 0x0422
Descripción
Cierra la base de datos del proyecto en caso de ejecución correcta.
Declaración
BOOL TXTCloseProject (
LPCTSTR lpszProjectFile,
LPCMN_ERROR lpdmError );
Parámetro
lpszProjectFile
Puntero en el nombre del proyecto incluidas ruta y extensión.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Librería de textos cerrada.
FALSE
Errores
Comentario
La función TXTOpenProject incrementa con cada llamada un contador de referencia interno.
Cada llamada de TXTCloseProject disminuye de nuevo este contador. Sólo cuando el
contador de referencia está de nuevo a 0 se cierra también la librería de textos.
Por este motivo se debe llamar siempre la misma cantidad de TXTCloseProject, ya que de lo
contrario se puede producir un error de excepción al finalizar la aplicación.
Nota
La llamada no se debe usar en el destructor de una aplicación (EXE, DLL, OCX, ...). Debido
a mecanismos específicos de Microsoft esto puede llevar, si se diera el caso, al bloqueo de
la llamada y con ello al del programa.
Mensajes de error
Archivos necesarios
text_cs.h
text_cs.lib
text_cs.dll
Funciones similares
Ejemplos
Obtener texto de ayuda (Página 722)"TX01.cpp"
Enumerar textos de ayuda (Página 724)"TX01.cpp"
Consulte también
TXTOpenProject (Página 701)
Obtener texto de ayuda (Página 722)
Enumerar textos de ayuda (Página 724)
Sinopsis de las funciones (Página 695)
Descripción
Determina el mayor ID de texto que se lleva a la DLL.
Declaración
BOOL TXTGetMaxTextID (
LPLONG lplMaxTextID,
LPCMN_ERROR lpdmError );
Parámetro
lplMaxTextID
Puntero en el búfer en el que se debe depositar la ID de texto.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
ID de texto máximo determinado
FALSE
Errores
Archivos necesarios
text_cs.h
text_cs.lib
text_cs.dll
Consulte también
Sinopsis de las funciones (Página 695)
Descripción
Abre la base de datos en caso de ejecución correcta.
Declaración
BOOL TXTOpenProject (
LPCTSTR lpszProjectFile,
LPCTSTR lpszDSNName,
BOOL fExclusive,
LPCMN_ERROR lpdmError );
Parámetro
lpszProjectFile
Puntero en el nombre del proyecto incluidas ruta y extensión.
lpszDSNName
Puntero en el nombre de la fuente de datos.
fExclusive
Si TRUE, no se puede iniciar TEXTBIB.EXE porque, por ejemplo, otro programa tiene acceso
a la Text Library. Si TEXTBIB.EXE ya ha arrancado, se rechaza la llamada
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Base de datos abierta
FALSE
Errores
Comentario
Si no se dispone de tablas de librería de textos, se generan de nuevo.
En cada llamada de la función se aumenta un contador de referencia. Para finalizar se debe
llamar la misma cantidad de TXTCloseProject. De lo contrario se puede producir un error de
excepción al finalizar la aplicación.
Mensajes de error
Archivos necesarios
text_cs.h
text_cs.lib
text_cs.dll
Funciones similares
Ejemplos
Obtener texto de ayuda (Página 722)"TX01.cpp"
Enumerar textos de ayuda (Página 724)"TX01.cpp"
Consulte también
TXTCloseProject (Página 698)
Obtener texto de ayuda (Página 722)
Enumerar textos de ayuda (Página 724)
Sinopsis de las funciones (Página 695)
Descripción
Establece una conexión con el servidor de texto. Esta función acelera la ejecución de las
funciones TXTRT. Entonces la conexión con el servidor de texto no se establece en cada
llamada ni luego se vuelve a deshacer.
Declaración
BOOL TXTRTConnect ( );
Parámetro
Ninguno
Valor de retorno
TRUE
Conexión con el servidor de texto establecida
FALSE
Errores
Comentario
Antes de finalizar la aplicación se debe deshacer sin falta la conexión de nuevo con
TXTRTDisconnect para evitar las consiguientes funciones de error en el sistema.
Archivos necesarios
text_rt.h
text_rt.lib
text_rt.dll
Funciones similares
Consulte también
TXTRTDisconnect (Página 704)
Sinopsis de las funciones (Página 695)
Descripción
Deshace una conexión con conexión configurada TXTRTConnect con el servidor de texto.
Declaración
BOOL TXTRTDisconnect ( );
Parámetro
Ninguno
Valor de retorno
TRUE
Conexión con el servidor de texto establecida
Comentario
Esta función finaliza la aceleración de las funciones TXTRT y devuelve siempre TRUE.
Las siguientes funciones TXTRT llamadas vuelven a establecer de nuevo con cada llamada
la conexión con el servidor de texto y la vuelven a deshacer.
Si se ha utilizado TXTRTConnect y no se ejecuta ningún TXTRTDisconnect antes de finalizar
la aplicación, se pueden producir a continuación funciones de error en el sistema.
Nota
La llamada no se debe usar en el destructor de una aplicación (EXE, DLL, OCX, ...). Debido
a mecanismos específicos de Microsoft esto puede llevar, si se diera el caso, al bloqueo de
la llamada y con ello al del programa.
Archivos necesarios
text_rt.h
text_rt.lib
text_rt.dll
Funciones similares
Consulte también
TXTRTConnect (Página 703)
Sinopsis de las funciones (Página 695)
Descripción
Se muestran en una lista todos los textos de ayuda que corresponden con el criterio de filtro
en lpszFilter.
Declaración
BOOL TXTEnumInfoText (
LPCTSTR lpszProjectFile,
DWORD dwLocale,
LPDWORD lpdwItems,
LPCTSTR lpszFilter,
TXT_ENUM_INFOTEXTS_PROC lpfnEnum,
LPVOID lpvUser,
LPCMN_ERROR lpdmError );
Parámetro
lpszProjectFile
Puntero en el nombre del proyecto incluidas ruta y extensión.
dwLocale
Código del idioma cuyos textos informativos deben enumerarse.
lpdwItems
Puntero en una variable de palabra doble de la aplicación que contiene la cantidad de textos
informativos enumerados después de la llamada.
lpszFilter
Puntero en la condición de una instrucción SQL para el operador LIKE.
lpfnEnum
Su función Callback que acepta los textos informativos.
lpvUser
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Listado de textos informativos
FALSE
Errores
Comentario
Si lpszFilter == NULL o se transmite una cadena vacía, se enumeran todos los textos
informativos del idioma. En este caso también se enumeran los textos informativos vacíos no
ocupados y se cuentan con lpdwItems.
Mensajes de error
Archivos necesarios
text_cs.h
text_cs.lib
text_cs.dll
Funciones similares
Ejemplos
Enumerar textos de ayuda (Página 724)"TX01.cpp"
Consulte también
TXT_ENUM_INFOTEXTS_PROC (Página 707)
Enumerar textos de ayuda (Página 724)
Sinopsis de las funciones (Página 695)
Descripción
Para poder evaluar los tooltips listados, es necesario poner a disposición una función Callback
del tipo TXT_ENUM_INFOTEXTS_PROC.
Declaración
BOOL ( * TXT_ENUM_INFOTEXTS_PROC) (
DWORD dwTextID,
LPCTSTR lpszInfoText,
LPVOID lpvUser);
Parámetro
dwTextID
ID del texto al que remite lpszInfotext.
lpszInfoText
Puntero al tooltip transmitido por la función que efectúa la llamada.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
La enumeración continúa.
FALSE
La enumeración se cancela
Observación
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un bucle de mensaje, por ejemplo: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
text_cs.h
text_cs.lib
text_cs.dll
Funciones relacionadas
Ejemplos
Enumerar textos de ayuda (Página 724)"TX01.cpp"
Consulte también
TXTEnumInfoText (Página 705)
Enumerar textos de ayuda (Página 724)
Sinopsis de las funciones (Página 695)
Descripción
En Runtime se cargan de nuevo los textos de la librería de textos.
Declaración
BOOL TXTUpdateRuntime (
LPCTSTR lpszProjectFile,
HWND hwndParent,
LPCMN_ERROR lpdmError );
Parámetro
lpszProjectFile
Puntero en el nombre del proyecto incluidas ruta y extensión.
hwndParent
Handle en la ventana principal
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Textos informativos actualizados
Comentario
En variables de referencia de texto no se realiza ninguna actualización. La función devuelve
siempre TRUE.
Archivos necesarios
text_cs.h
text_cs.lib
text_cs.dll
Consulte también
Sinopsis de las funciones (Página 695)
Descripción
En caso de ejecución correcta, llena el búfer transmitido en lpszBuffer con el texto descrito
mediante dwTextID. Si el búfer transmitido es menor que la longitud del texto (longitud del
búfer en caracteres en pdwSize), el texto se reduce de forma correspondiente. El valor de
retorno sigue siendo TRUE. Si se transmite en lpszBuffer NULL, la función determina el
tamaño de búfer necesario y lo guarda en pdwSize.
Declaración
BOOL TXTRTGetInfoText (
DWORD dwTextID,
LPTSTR lpszBuffer,
LPDWORD pdwSize,
LPCMN_ERROR lpdmError );
Parámetro
dwTextID
ID del texto que hay que leer
lpszBuffer
Puntero en un búfer en el que se debe almacenar el texto informativo.
pdwSize
Puntero en el DWORD que contiene el tamaño del búfer
lpdmError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Texto informativo determinado
FALSE
Error
Observación
Mensajes de error
Archivos requeridos
text_rt.h
text_rt.lib
text_rt.dll
Funciones relacionadas
Ejemplos
Obtener texto de ayuda (Página 722) "TX01.cpp"
Consulte también
Obtener texto de ayuda (Página 722)
Sinopsis de las funciones (Página 695)
Descripción
Obtiene un texto, p. ej., un tooltip, del servidor de texto indicado o de la lista de textos C. En
caso de ejecución correcta, llena el búfer transmitido en lpszBuffer con el texto descrito
mediante dwTextID. Si el búfer transmitido es menor que la longitud del texto (longitud del
búfer en caracteres en pdwSize), el texto se reduce de forma correspondiente. El valor de
retorno sigue siendo TRUE. Si se transmite en lpszBuffer NULL, la función determina el
tamaño de búfer necesario y lo guarda en pdwSize.
Declaración
BOOL TXTRTGetInfoTextMC (
DWORD dwTextID,
LPTSTR lpszBuffer,
LPDWORD pdwSize,
LPTSTR lpszServer,
LPCMN_ERROR lpdmError );
Parámetros
dwTextID
ID del texto que hay que leer
lpszBuffer
Puntero en un búfer en el que se debe almacenar el texto informativo.
pdwSize
Puntero en el DWORD que contiene el tamaño del búfer
lpszServer
Puntero en el nombre simbólico del servidor de texto (sin separadores de servidor :: )
lpdmError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Texto informativo determinado
FALSE
Error
Observación
Esta función trabaja sólo en caso de proyectos Multiclient
Mensajes de error
Archivos requeridos
text_rt.h
text_rt.lib
text_rt.dll
Funciones relacionadas
Consulte también
Sinopsis de las funciones (Página 695)
Descripción
Llama a la función transmitida Callback para todos los idiomas configurados.
Declaración
BOOL TXTEnumLanguages (
LPCTSTR lpszProjectFile,
LPDWORD lpdwItems,
TXT_ENUM_LANGUAGES_PROC lpfnEnum,
LPVOID lpvUser,
LPCMN_ERROR lpdmError );
Parámetro
lpszProjectFile
Puntero en el nombre del proyecto incluidas ruta y extensión.
lpdwItems
Puntero en una variable de palabra doble de la aplicación que contiene la cantidad de idiomas
enumerados después de la llamada.
lpfnEnum
Su función Callback que acepta los idiomas configurados.
lpvUser
Puntero a datos específicos de aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Listado de idiomas configurados
FALSE
Errores
Mensajes de error
Archivos necesarios
text_cs.h
text_cs.lib
text_cs.dll
Funciones similares
Ejemplos
Enumerar textos de ayuda (Página 724)"TX01.cpp"
Consulte también
TXT_ENUM_LANGUAGES_PROC (Página 715)
Enumerar textos de ayuda (Página 724)
Sinopsis de las funciones (Página 695)
Descripción
Para poder evaluar los idiomas listados, es necesario preparar una función Callback del tipo
TXT_ENUM_LANGUAGES_PROC.
Declaración
BOOL ( * TXT_ENUM_LANGUAGES_PROC) (
DWORD dwLocaleID,
LPCTSTR lpszName,
LPVOID lpvUser);
Parámetro
dwLocaleID
Código de idioma
lpszName
Puntero en el nombre del idioma.
lpvUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
La enumeración continúa.
FALSE
La enumeración se cancela.
Observación
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un bucle de mensaje, por ejemplo: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
text_cs.h
Funciones relacionadas
Ejemplos
Enumerar textos de ayuda (Página 724)"TX01.cpp"
Consulte también
TXTEnumLanguages (Página 713)
Enumerar textos de ayuda (Página 724)
Sinopsis de las funciones (Página 695)
Descripción
En caso de ejecución correcta llena la estructura LOGFONT transmitida en lplf con la fuente
configurada del idioma deseado.
Declaración
BOOL TXTGetFont (
LPCTSTR lpszProjectFile,
DWORD dwLocale,
LPLOGFONT lplf,
LPCMN_ERROR lpdmError );
Parámetro
lpszProjectFile
Puntero en el nombre del proyecto incluidas ruta y extensión.
dwLocale
Código de los idiomas de los que se debe tomar la fuente.
lplf
Puntero en una estructura específica de Windows del tipo LOGFONT con los datos de un
juego de caracteres.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Juego de caracteres determinado
FALSE
Errores
Mensajes de error
Archivos necesarios
text_cs.h
text_cs.lib
text_cs.dll
Consulte también
Sinopsis de las funciones (Página 695)
Descripción
Abre un diálogo con los idiomas disponibles. Si se cierra el diálogo con "OK", se guarda el
idioma seleccionado en lpdwLocale. Además, la fuente correspondiente se transmite a la
estructura LOGFONT.
Declaración
BOOL TXTShowLanguagesDialog (
LPCTSTR lpszProjectFile,
HWND hwndParent,
LPDWORD lpdwLocale,
LPLOGFONT lplf,
LPCMN_ERROR lpdmError );
Parámetro
lpszProjectFile
Puntero en el nombre del proyecto incluidas ruta y extensión.
hwndParent
Handle en la ventana principal en la que tiene lugar el diálogo. El parámetro está ocupado por
defecto con NULL.
dwLocale
Puntero en el código del idioma que se va a instalar.
lplf
Puntero en una estructura específica de Windows del tipo LOGFONT con los datos de un
juego de caracteres.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Idioma selecciona
FALSE
Salir del error o del diálogo con "Cancelar"
Comentario
Para poder ofrecer los idiomas instalados en la ventana de diálogo, la función enumera los
idiomas disponibles en la base de datos. Si se produce un error, el mensaje de error
TXT_CALLBACK se guarda en la estructura de error.
Mensajes de error
Archivos necesarios
text_cs.h
text_cs.lib
text_cs.dll
Consulte también
Sinopsis de las funciones (Página 695)
Descripción
En caso de ejecución correcta llena el búfer transmitido en lpchLanguageID con el ID del
idioma primario cargado en el archivo asignado en memoria.
Declaración
BOOL TXTRTGetLanguageID (
LPBYTE lpchLanguageID,
LPCMN_ERROR lpdmError );
Parámetro
lpchLanguageID
Puntero en un búfer en el que se debe almacenar el ID del idioma primario.
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Idioma activado determinado
FALSE
Errores
Mensajes de error
Archivos necesarios
text_rt.h
text_rt.lib
text_rt.dll
Consulte también
Sinopsis de las funciones (Página 695)
Descripción
Ajusta el idioma para los mensajes de error. Si este idioma no está disponible, se ajusta el
idioma por defecto (alemán) y se devuelve FALSE.
Ya no se da soporte a esta función y siempre se devuelve el valor de retorno TRUE.
Declaración
BOOL TXTRTSetLanguage (
DWORD dwLocaleID,
LPCMN_ERROR lpdmError );
Parámetro
dwLocaleID
Código del idioma que debe ajustarse
lpdmError
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Se ha cambiado el idioma de los mensajes de error
Archivos necesarios
text_rt.h
text_rt.lib
text_rt.dll
Consulte también
Sinopsis de las funciones (Página 695)
Ejemplo
ODKTrace(szText);
}
}
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
TXTCloseProject (Página 698)
TXTOpenProject (Página 701)
TXTRTGetInfoText (Página 710)
Ejemplo
void MyTxtEnums(void)
{
TCHAR szText[255];
CMN_ERROR Error;
BOOL ret = FALSE;
DWORD dwLocale = 0x0407; // german
DWORD dwItems = 0;
DWORD dwUser = 0;
TCHAR szFilter[]="S%"; // all texts with 'S'
//DWORD dwSize =254;
ret = MyDMEnumOpenedProjects(); // open the DM and set the g_szProjectFile and
g_szDSNName
if(TRUE == ret)
{
memset(&Error, 0, sizeof(CMN_ERROR));
Consulte también
TXTCloseProject (Página 698)
TXTOpenProject (Página 701)
TXTEnumInfoText (Página 705)
TXT_ENUM_INFOTEXTS_PROC (Página 707)
TXT_ENUM_LANGUAGES_PROC (Página 715)
TXTEnumLanguages (Página 713)
Sinopsis
● PaperSize
● Orientation
● DynMarginLeft
● DynMarginRight
● DynMarginTop
● DynMarginBottom
● PrintMarginLeft
● PrintMarginRight
● PrintMarginTop
● PrintMarginBottom
Styles
● BorderStyle
● BorderWidth
● FillStyle
Colores
● BorderBackColor
● BorderColor
● BackColor
● FillColor
● ForeColor
Caracteres
● FontName
● FontSize
● FontBold
● FontItalic
● FontUnderline
● Text
● AlignmentLeft
● AlignmentTop
● WordWrap
Otros
● FirstPage
● LastPage
● MetaFileName
● LayoutFileName
● Formato
● List
● Tag
● DataType
● OutFormat
● Calculation
● PageBreak
AbsoluteSelectionFrom
AbsoluteSelectionTo
CycleSpan
DestinationFile
EnableCycle
EnableStart
EndPage Con estos datos se puede conseguir que la im‐
presión del informe termine con una página en
concreto.
JobName El nombre del trabajo de impresión debe ser uní‐
voco dentro de un proyecto y debe ser conforme
a las convenciones de Windows.
LayoutName Con el nombre de diseño se asigna un diseño al
trabajo de impresión.
PrinterName 1 Aquí se define la impresora en la que se intentará
iniciar la impresión en primer lugar.
PrinterName 2 Aquí se define la impresora que se activa cuando
la primera impresora no está disponible.
PrinterName 3 Aquí se define la impresora que se activa cuando
las dos primeras impresoras no están disponibles.
RelativeSelectionCount
RelativeSelectionRange
StartPage Con estos datos se puede conseguir que el infor‐
me se imprima a partir de una página en concreto.
StartTime
UseRelative
UseOutputFile
UseOutputPrinter
Sinopsis
Las funciones API pueden devolver los siguientes mensajes de error en la estructura de error
CMN_ERROR:
Mensajes de error CS
Mensajes de error RT
Nota
Los nombres de propiedades con una descripción básica también pueden consultarse en la
ayuda contextual haciendo clic con el botón derecho del ratón en el campo de propiedades
del objeto en cuestión en el Report-Designer.
"BorderWidth" VT_I4
"BorderBackColor" VT_I4
"BorderColor" VT_I4
"Left" VT_I4
"Top" VT_I4
"FillStyle" VT_I4
"BackColor" VT_I4
"FillColor" VT_I4
"DataLink" VT_BSTR
"FontName" VT_BSTR
"FontSize" VT_I4
"FontBold" VT_I4
"FontItalic" VT_I4
"FontUnderline" VT_I4
"Orientation" VT_I4
"Columns" VT_BSTR
"ForeColor" VT_I4
"List" VT_I4
"FontName" VT_BSTR
"FontSize" VT_I4
"FontBold" VT_I4
"FontItalic" VT_I4
"FontUnderline" VT_I4
"Orientation" VT_I4
"AlignmentLeft" VT_I4
"AlignmentTop" VT_I4
"WordWrap" VT_I4
"ForeColor" VT_I4
"DynHeight" VT_I4
"Radius" VT_I4
"StartAngle" VT_I4
"EndAngle" VT_I4
"StartAngle" VT_I4
"EndAngle" VT_I4
"RadiusWidth" VT_I4
"RadiusHeight" VT_I4
Propiedades de "círculos":
"Radius" VT_I4
Propiedades de "elipses":
"RadiusWidth" VT_I4
"RadiusHeight" VT_I4
Propiedades de "polígonos":
"Polyline" VT_BSTR
"PointCount" VT_I4
"Index" VT_I4
"ActualPointLeft" VT_I4
"ActualPointTop" VT_I4
"Radius" VT_I4
"StartAngle" VT_I4
"EndAngle" VT_I4
"StartAngle" VT_I4
"EndAngle" VT_I4
"RadiusWidth" VT_I4
"RadiusHeight" VT_I4
Propiedades de "Polilínea":
"Polyline" VT_BSTR
"PointCount" VT_I4
"Index" VT_I4
"ActualPointLeft" VT_I4
"ActualPointTop" VT_I4
"RoundCornerWidth" VT_I4
"RoundCornerHeight" VT_I4
"FontName" VT_BSTR
"FontSize" VT_I4
"FontBold" VT_I4
"FontItalic" VT_I4
"FontUnderline" VT_I4
"Orientation" VT_I4
"Text" VT_BSTR
"AlignmentLeft" VT_I4
"AlignmentTop" VT_I4
"WordWrap" VT_I4
"ForeColor" VT_I4
"LayoutFileName" VT_BSTR
Propiedades de "diseños":
"PrintMarginLeft" VT_I4
"PrintMarginRight" VT_I4
"PrintMarginTop" VT_I4
"PrintMarginBottom" VT_I4
"PaperSize" VT_BSTR
"FirstPage" VT_I4
"LastPage" VT_I4
"Orientation" VT_I4
"Printer1" VT_BSTR
"Printer2" VT_BSTR
"Printer3" VT_BSTR
"BackColor" VT_I4
"BorderColor" VT_I4
"FillColor" VT_I4
"DynMarginLeft" VT_I4
"DynMarginRight" VT_I4
"DynMarginTop" VT_I4
"DynMarginBottom" VT_I4
"Context" VT_BSTR
Propiedades de "MetaFiles":
"MetaFileName" VT_BSTR
"Tag" VT_BSTR
"FontSize" VT_I4
"FontName" VT_BSTR
"FontBold" VT_I4
"FontItalic" VT_I4
"FontUnderline" VT_I4
"AlignmentLeft" VT_I4
"AlignmentTop" VT_I4
"WordWrap" VT_I4
"ForeColor" VT_I4
"OutFormat" VT_BSTR
"DataType" VT_I4
"Calculation" VT_VARIANT
Borrar handle
Borrar handle de una propiedad de trabajo de impresión. Los handles que se crean con
RPJCreatePropertyHandle deben borrarse si ya no se necesitan.
Función: RPJDeletePropertyHandle.
General
Para poder editar las propiedades de un trabajo de impresión, primero es necesario configurar
un handle en el trabajo de impresión. A través de él se identifica un área de memoria a través
de la cual se puede acceder a las propiedades del trabajo de impresión.
Crear handle:Función
RPJCreatePropertyHandle.
Borrar handle
Borrar handle de una propiedad de trabajo de impresión. Los handles que se crean con
RPJCreatePropertyHandle deben borrarse si ya no se necesitan.
Función: RPJDeletePropertyHandle.
Ejemplo
void DruckAuftrag(void)
{
CMN_ERROR err; //error structure
BOOL ret;
HPROPERTIES hProp;
char jobname[200];
char method[200];
LPCSTR szProjectName = "c:\\rest\\test.mcp"; //name of project
strcpy(method, "PREVIEW");
strcpy(jobname, "Backdokumentation Control Center");
ret = RPJAttach(&err);
if (TRUE == ret)
{
hProp = RPJCreatePropertyHandle(szProjectName. &err);
if (NULL == hProp)
{
ErrMsg("Error RPJCreatePropertyHandle", &err);
}
else
{
ret = RPJGetJobProps(hProp, jobname, &err);
if (FALSE == ret)
{
ErrMsg("Error RPJGetJobProbs", &err);
}
else
{
ret = RPJCallJobMethod(hProp, method, &err);
if (FALSE == ret)
{
ErrMsg("Error executing RPJCallJobMethod", &err);
}
else
{
Msg("Print job started.");
}
}
RPJDeletePropertyHandle(hProp, &err);
}
RPJDetach(&err);
}
else
{
Msg("No connection to report designer DLL");
}
}
Descripción
Con esta función se establece e inicializa una conexión con RPJAPI.DLL.
Declaración
BOOL RPJAttach (
CMN_ERROR* pcmnerror );
Parámetro
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Conexión establecida.
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Funciones similares
Consulte también
RPJDetach (Página 740)
Sinopsis de las funciones (Página 726)
Descripción
Con esta función se deshace de nuevo una conexión ya existente con RPJAPI.DLL.
Declaración
BOOL RPJDetach (
CMN_ERROR* pcmnerror );
Parámetro
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
La conexión se ha deshecho de nuevo.
FALSE
Errores
Comentario
Nota
La llamada no se debe usar en el destructor de una aplicación (EXE, DLL, OCX, ...). Debido
a mecanismos específicos de Microsoft esto puede llevar, si se diera el caso, al bloqueo de
la llamada y con ello al del programa.
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Funciones similares
Consulte también
RPJAttach (Página 739)
Sinopsis de las funciones (Página 726)
Descripción
Con esta función se deshace de nuevo una conexión ya existente con RPJAPI.DLL y se
autoriza la memoria asignada.
Declaración
BOOL RPJMemFree (
const PVOID pvMemBlock,
CMN_ERROR* pcmnerror );
Parámetro
pvMemBlock
Puntero sobre un área de la memoria que se va a liberar, asignada anteriormente por una
función RPJ.
Si pvMemBlock = NULL, no se ejecuta nada.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Se ha liberado el área de la memoria.
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Consulte también
Sinopsis de las funciones (Página 726)
Descripción
Esta función determina la cantidad de propiedades del proyecto.
Declaración
BOOL RPJGetNumProjectProperties (
LPCSTR pszReserved,
DWORD* pdwNumProperties
CMN_ERROR* pcmnerror );
Parámetro
pszReserved
El parámetro está reservado para ampliaciones posteriores.
pdwNumProperties
Puntero en una variable DWORD en la que se devuelve la cantidad de propiedades.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Se ha determinado la cantidad de propiedades.
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Consulte también
Sinopsis de las funciones (Página 726)
Descripción
La función determina el nombre y tipo de una propiedad con el índice del proyecto.
Declaración
BOOL RPJGetProjectPropertyAt (
LPCSTR pszReserved,
DWORD dwPropIndex,
LPSTR pszBuffer,
DWORD dwCharMax,
DWORD* pdwPrpType,
CMN_ERROR* pcmnerror );
Parámetro
pszReserved
El parámetro está reservado para ampliaciones posteriores.
dwPropIndex
Índice de las propiedades del proyecto desde el que se ha de devolver la información.
pszBuffer
Puntero en un búfer al que se ha de devolver el nombre de la propiedad. El tamaño del búfer
se indica con dwCharMax.
dwCharMax
Tamaño máximo del búfer indicado por pszBuffer
pdwPropType
Puntero en una variable DWORD en la que se devuelve el tipo de la propiedad del proyecto.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Se ha determinado el nombre y tipo de la propiedad del proyecto.
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Consulte también
Sinopsis de las funciones (Página 726)
Descripción
Esta función determina el valor de una propiedad. Se deben transmitir el nombre del proyecto
y el de la propiedad.
Declaración
BOOL RPJGetProjectProperty (
LPCSTR pszProjectName,
LPCSTR pszPropName,
PVOID pvPropValue,
VARTYPE vtPropType,
DWORD dwBufferSize,
CMN_ERROR* pcmnerror );
Parámetro
pszProjectName
Puntero en el nombre del proyecto, compuesto de los datos de la ruta, el nombre del proyecto
y la extensión.
pszPropName
Nombre de la propiedad del proyecto.
pvPropValue
Puntero en un búfer al que se ha de devolver el valor de la propiedad. El tamaño del búfer en
pvPropValue se indica con dwBufferSize.
vtPropType
Tipo en el que se espera el valor de la propiedad en el búfer pvPropValue.
dwBufferSize
Tamaño del búfer en pvPropValue en el que se ha de devolver el valor de la propiedad. El
tamaño se debe indicar sólo en BYTE y no en CHAR.
pcmnerror
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Se ha determinado el valor de la propiedad.
FALSE
Error
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Consulte también
Sinopsis de las funciones (Página 726)
Descripción
Se bloquea para otros el acceso a la lista de trabajo de impresión del proyecto. El nombre de
quien ha bloqueado se debe indicar en pszLockerNameNew. En caso de conflicto de acceso,
se devuelve el nombre de quien ha bloqueado a través de ppszLockerNameCur.
Declaración
BOOL RPJProjectLock (
LPCSTR pszProjectName,
BOOL fWriteLock,
BOOL fDoNotWait,
LPCSTR pszLockerNameNew,
LPSTR* ppszLockerNameCur,
CMN_ERROR* pcmnerror );
Parámetro
pszProjectName
Puntero en el nombre del proyecto, compuesto de los datos de la ruta, el nombre del proyecto
y la extensión.
fWriteLock
Define el tipo de bloqueo.
fDoNotWait
pszLockerNameNew
Contiene el nombre de quien bloquea. En caso de conflicto de acceso, se devuelve este
nombre a través de ppszLockerNameCur.
ppszLockerNameCur
En caso de un conflicto de acceso, se devuelve en ppszLockerNameCur el nombre de quien
bloquea actualmente.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Lista de trabajo de impresión bloqueada.
FALSE
Ha ocurrido un conflicto de acceso. La lista de trabajo de impresión del proyecto ya está
bloqueada. El nombre de quien bloquea se devuelve con ppszLockerNameCur.
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Funciones similares
Consulte también
RPJProjectUnlock (Página 747)
RPJProjectUnlockAll (Página 748)
Sinopsis de las funciones (Página 726)
Descripción
Se elimina el bloqueo de una lista de trabajo de impresión.
Declaración
BOOL RPJProjectUnlock (
LPCSTR pszProjectName,
CMN_ERROR* pcmnerror );
Parámetro
pszProjectName
Puntero en el nombre del proyecto, compuesto de los datos de la ruta, el nombre del proyecto
y la extensión.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Se ha eliminado el bloqueo de la lista de trabajo de impresión.
FALSE
Ha ocurrido un conflicto de acceso.
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Funciones similares
Consulte también
RPJProjectLock (Página 745)
RPJProjectUnlockAll (Página 748)
Sinopsis de las funciones (Página 726)
Descripción
Se eliminan todos los bloqueos de una lista de trabajo de impresión.
Declaración
BOOL RPJProjectUnlockAll (
LPCSTR pszProjectName,
CMN_ERROR* pcmnerror );
Parámetro
pszProjectName
Puntero en el nombre del proyecto, compuesto de los datos de la ruta, el nombre del proyecto
y la extensión.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Se han eliminado todos los bloqueos de la lista de trabajo de impresión.
FALSE
Ha ocurrido un conflicto de acceso.
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Funciones similares
Consulte también
RPJProjectLock (Página 745)
RPJProjectUnlock (Página 747)
Sinopsis de las funciones (Página 726)
Descripción
Crea un nuevo trabajo de impresión.
Declaración
BOOL RPJCreateJob (
LPCSTR pszProjectName,
LPCSTR pszJobName,
CMN_ERROR* pcmnerror );
Parámetro
pszProjectName
Puntero en el nombre del proyecto, compuesto de los datos de la ruta, el nombre del proyecto
y la extensión.
pszJobName
Puntero en el nombre del trabajo de impresión que se va a crear.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Trabajo de impresión creado.
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Funciones similares
Consulte también
RPJDeleteJob (Página 751)
Sinopsis de las funciones (Página 726)
Descripción
Se borra un trabajo de impresión especificado con pszJobName.
Declaración
BOOL RPJDeleteJob (
LPCSTR pszProjectName,
LPCSTR pszJobName,
CMN_ERROR* pcmnerror );
Parámetro
pszProjectName
Puntero en el nombre del proyecto, compuesto de los datos de la ruta, el nombre del proyecto
y la extensión.
pszJobName
Puntero en el nombre del trabajo de impresión que se va a borrar.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Trabajo de impresión borrado.
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Funciones similares
Consulte también
RPJCreateJob (Página 749)
Sinopsis de las funciones (Página 726)
Descripción
Para poder editar las propiedades de un trabajo de impresión, primero es necesario configurar
un Handle en el trabajo de impresión con esta función. El Handle se obtiene suministrado en
valor de retorno.
Declaración
HPROPERTIES RPJCreatePropertyHandle (
LPCSTR pszProjectName,
CMN_ERROR* pcmnerror );
Parámetro
pszProjectName
Puntero en el nombre del proyecto, compuesto de los datos de la ruta, el nombre del proyecto
y la extensión.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
Handle en la propiedad de trabajo de impresión.
En caso de error el valor de retorno es CERO.
Comentario
El Handle suministrado aquí es necesario, por ejemplo, para las funciones RPJGetJobProps,
RPJGetProperty y RPJSetProperty.
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Funciones similares
Ejemplos
Show print job preview (Página 791)"RD02.cpp"
Modify print job properties (Página 786)"RD02.cpp"
Obtener nombres de trabajo de impresión (Página 780)"RD02.cpp"
Obtener nombre de método del trabajo de impresión (Página 777)"RD02.cpp"
Obtener propiedades del trabajo de impresión (Página 783)"RD02.cpp"
Consulte también
Obtener nombre de método del trabajo de impresión (Página 777)
Obtener nombres de trabajo de impresión (Página 780)
Obtener propiedades del trabajo de impresión (Página 783)
Modify print job properties (Página 786)
Show print job preview (Página 791)
RPJDeletePropertyHandle (Página 753)
RPJGetProperty (Página 769)
RPJGetJobProps (Página 767)
RPJSetProperty (Página 774)
RPJPropertyClear (Página 772)
Sinopsis de las funciones (Página 726)
Descripción
Todos los Handles creados con RPJCreatePropertyHandle deberían borrarse con esta función
cuando yo no se necesiten más.
Declaración
BOOL RPJDeletePropertyHandle (
HPROPERTIES hproperties,
CMN_ERROR* pcmnerror );
Parámetro
hproperties
El Handle de la propiedad del trabajo de impresión se crea con la función
RPJCreatePropertyHandle.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Handle borrado
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Funciones similares
Ejemplos
Show print job preview (Página 791)"RD02.cpp"
Modify print job properties (Página 786)"RD02.cpp"
Obtener nombres de trabajo de impresión (Página 780)"RD02.cpp"
Obtener nombre de método del trabajo de impresión (Página 777)"RD02.cpp"
Obtener propiedades del trabajo de impresión (Página 783)"RD02.cpp"
Consulte también
RPJCreatePropertyHandle (Página 752)
Obtener nombre de método del trabajo de impresión (Página 777)
Obtener nombres de trabajo de impresión (Página 780)
Obtener propiedades del trabajo de impresión (Página 783)
Modify print job properties (Página 786)
Show print job preview (Página 791)
Sinopsis de las funciones (Página 726)
Descripción
Determina el nombre de un trabajo de impresión especificado por dwJobIndex.
Declaración
BOOL RPJGetJobNameAt (
LPCSTR pszProjectName,
DWORD dwJobIndex,
LPSTR pszBuffer,
DWORD dwCharMax,
CMN_ERROR* pcmnerror );
Parámetro
PszProjectName
Puntero en el nombre del proyecto, compuesto de los datos de la ruta, el nombre del proyecto
y la extensión.
dwJobIndex
Índice del trabajo de impresión del que debe determinarse el nombre.
pszBuffer
Puntero en un búfer de recepción en el que se ha de crear el nombre del trabajo de impresión.
dwCharMax
Tamaño del búfer de recepción en número de caracteres incluyendo la terminación cero. Este
valor debe ser mayor que 1.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Nombre del trabajo de impresión determinado.
FALSE
Errores
Comentario
Un error de índice mostrado por RPJGetJobNameAt se deba posiblemente a que se ha
modificado el número de los trabajos de impresión después de la llamada de RPJGetNumJobs.
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Ejemplos
Obtener nombres de trabajo de impresión (Página 780)"RD02.cpp"
Consulte también
Obtener nombres de trabajo de impresión (Página 780)
Sinopsis de las funciones (Página 726)
Descripción
Determina la cantidad de trabajos de impresión pendientes actualmente. Después de llamar
la función se puede modificar la cantidad borrando o añadiendo trabajos de impresión.
Declaración
BOOL RPJGetNumJobs (
LPCSTR pszProjectName,
DWORD* pdwNumJobs,
CMN_ERROR* pcmnerror );
Parámetro
pszProjectName
Puntero en el nombre del proyecto, compuesto de los datos de la ruta, el nombre del proyecto
y la extensión.
pdwNumJobs
Puntero en el lugar de memoria en el que se debe almacenar el número de trabajos de
impresión.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Cantidad de trabajos de impresión determinada.
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Ejemplos
Obtener nombres de trabajo de impresión (Página 780)"RD02.cpp"
Consulte también
Obtener nombres de trabajo de impresión (Página 780)
Sinopsis de las funciones (Página 726)
Descripción
Se bloquea para otros el acceso al trabajo de impresión indicado. El nombre de quien ha
bloqueado se debe indicar en pszLockerNameNew. En caso de conflicto de acceso, se
devuelve el nombre de quien ha bloqueado a través de ppszLockerNameCur.
Declaración
BOOL RPJJobLock (
LPCSTR pszProjectName,
LPCSTR pszJobName,
BOOL fWriteLock,
BOOL fDoNotWait,
LPCSTR pszLockerNameNew,
LPSTR* ppszLockerNameCur,
CMN_ERROR* pcmnerror );
Parámetro
pszProjectName
Puntero en el nombre del proyecto, compuesto de los datos de la ruta, el nombre del proyecto
y la extensión.
pszJobName
Puntero en el nombre del trabajo de impresión que se va a bloquear.
fWriteLock
Define el tipo de bloqueo.
fDoNotWait
pszLockerNameNew
Contiene el nombre de quien bloquea. En caso de conflicto de acceso, se devuelve este
nombre a través de ppszLockerNameCur.
ppszLockerNameCur
En caso de un conflicto de acceso, se devuelve en ppszLockerNameCur el nombre de quien
bloquea actualmente.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Trabajo de impresión bloqueado.
FALSE
Ha ocurrido un conflicto de acceso. La lista de trabajo de impresión del proyecto ya está
bloqueada. El nombre de quien bloquea se devuelve con ppszLockerNameCur.
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Funciones similares
Consulte también
RPJJobUnlockAll (Página 760)
RPJJobUnlock (Página 759)
Sinopsis de las funciones (Página 726)
Descripción
Se elimina el bloqueo de un trabajo de impresión.
Declaración
BOOL RPJJobUnlock (
LPCSTR pszProjectName,
LPCSTR pszJobName,
CMN_ERROR* pcmnerror );
Parámetro
pszProjectName
Puntero en el nombre del proyecto, compuesto de los datos de la ruta, el nombre del proyecto
y la extensión.
pszJobName
Puntero en el nombre del trabajo de impresión.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Se ha eliminado el bloqueo del trabajo de impresión.
FALSE
Ha ocurrido un conflicto de acceso.
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Funciones similares
Consulte también
RPJJobUnlockAll (Página 760)
RPJJobLock (Página 757)
Sinopsis de las funciones (Página 726)
Descripción
Se eliminan todos los bloqueos del trabajo de impresión indicado.
Declaración
BOOL RPJJobUnlockAll (
LPCSTR pszProjectName,
LPCSTR pszJobName,
CMN_ERROR* pcmnerror );
Parámetro
pszProjectName
Puntero en el nombre del proyecto, compuesto de los datos de la ruta, el nombre del proyecto
y la extensión.
pszJobName
Puntero en el nombre del trabajo de impresión.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Se han eliminado todos los bloqueos del trabajo de impresión indicado.
FALSE
Ha ocurrido un conflicto de acceso
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Funciones similares
Consulte también
RPJJobUnlock (Página 759)
RPJJobLock (Página 757)
Sinopsis de las funciones (Página 726)
Descripción
Con esta función se puede fijar un determinado método de trabajo. Actualmente se diferencia
entre dos métodos: PrintJob y PreviewJob.
Declaración
RPJCallJobMethod (
HPROPERTIES hproperties,
LPCSTR pszMethodName
CMN_ERROR* pcmnerror );
Parámetro
hproperties
El Handle de la propiedad del trabajo de impresión se crea con la función
RPJCreatePropertyHandle.
pszMethodName
Puntero en el nombre del método de trabajo que se va a utilizar.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Método de trabajo de impresión fijado
FALSE
Errores
Comentario
Para poder fijar un método de trabajo de impresión con RPJCallJobMethod antes se tiene que
haber ejecutado la función RPJGetJobProps.
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Ejemplos
Show print job preview (Página 791)"RD02.cpp"
Consulte también
Show print job preview (Página 791)
Sinopsis de las funciones (Página 726)
Descripción
La función determina para el nombre del método de impresión especificado en
dwMethodIndex.
Declaración
BOOL RPJGetJobMethodAt (
DWORD dwMethodIndex,
LPSTR pszBuffer,
DWORD dwCharMax,
CMN_ERROR* pcmnerror );
Parámetro
dwMethodIndex
Índice del método de impresión cuyo nombre se va a determinar.
pszBuffer
Puntero en un búfer en el que se ha de almacenar el nombre del método de impresión.
dwCharMax
Tamaño del búfer que debe registrar el nombre, en número de caracteres incluyendo la
terminación cero. Este valor debe ser mayor que 1.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Nombre del método de trabajo de impresión determinado
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Ejemplos
Obtener nombre de método del trabajo de impresión (Página 777)"RD02.cpp"
Consulte también
Obtener nombre de método del trabajo de impresión (Página 777)
Sinopsis de las funciones (Página 726)
Descripción
La función determina cuántos métodos de trabajo de impresión están disponibles actualmente.
Declaración
BOOL RPJGetNumJobMethods (
DWORD* pdwNumMethods,
CMN_ERROR* pcmnerror );
Parámetro
pdwNumMethods
Puntero en un lugar de memoria en el que se debe guardar el número de métodos de trabajo
de impresión.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Cantidad de métodos de trabajo de impresión determinada
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Ejemplos
Obtener nombre de método del trabajo de impresión (Página 777)"RD02.cpp"
Consulte también
Obtener nombre de método del trabajo de impresión (Página 777)
Sinopsis de las funciones (Página 726)
Descripción
Determina el nombre y el tipo de la propiedad de trabajo especificada en dwPropindex.
Declaración
BOOL RPJGetJobPropertyAt (
DWORD dwPropIndex,
LPSTR pszBuffer,
DWORD dwCharMax,
DWORD* pdwPropType,
CMN_ERROR* pcmnerror );
Parámetro
dwPropIndex
Índice de las propiedades de trabajo de impresión cuyo nombre debe determinarse.
pszBuffer
Puntero en el búfer que acepta el nombre de la propiedad de trabajo.
dwCharMax
Tamaño del búfer de recepción en número de caracteres incluyendo la terminación cero. Este
valor debe ser mayor que 1.
pdwPropType
Puntero en un lugar de memoria en el que se almacena el tipo de propiedades de trabajo.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Nombre de la propiedad del trabajo de impresión determinado.
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Ejemplos
Obtener propiedades del trabajo de impresión (Página 783)"RD02.cpp"
Consulte también
Obtener propiedades del trabajo de impresión (Página 783)
Sinopsis de las funciones (Página 726)
Descripción
La función determina las propiedades de un trabajo de impresión y las guarda en el búfer
interno hProps.
Declaración
BOOL RPJGetJobProps (
HPROPERTIES hproperties,
LPCSTR pszJobName,
CMN_ERROR* pcmnerror );
Parámetro
hproperties
El Handle de la propiedad del trabajo de impresión se crea con la función
RPJCreatePropertyHandle.
pszJobName
Puntero en el nombre del trabajo de impresión.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Comentario
Esta función es una condición para funciones como RPJGetProperty y RPJSetProperty.
Valor de retorno
TRUE
Propiedades de trabajo de impresión determinadas
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Funciones similares
Ejemplos
Show print job preview (Página 791)"RD02.cpp"
Modify print job properties (Página 786)"RD02.cpp"
Consulte también
RPJGetProperty (Página 769)
RPJSetProperty (Página 774)
Modify print job properties (Página 786)
Show print job preview (Página 791)
RPJCreatePropertyHandle (Página 752)
Sinopsis de las funciones (Página 726)
Descripción
Determina la cantidad de propiedades de trabajo de impresión disponibles.
Declaración
BOOL RPJGetNumJobProperties (
DWORD* pdwNumProperties,
CMN_ERROR* pcmnerror );
Parámetro
pdwNumProperties
Puntero en un lugar de memoria en el que se debe almacenar el número de propiedades del
trabajo de impresión.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Cantidad de propiedades de trabajo de impresión determinada
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Ejemplos
Obtener propiedades del trabajo de impresión (Página 783)"RD02.cpp"
Consulte también
Obtener propiedades del trabajo de impresión (Página 783)
Sinopsis de las funciones (Página 726)
Descripción
Antes de que se pueda determinar con RPJGetProperty el valor de la propiedad del trabajo
de impresión especificada con pszPropName, es necesario haber almacenado con
RPJGetJobProps las propiedades de trabajo en el búfer interno hProp.
Declaración
BOOL RPJGetProperty (
HPROPERTIES hproperties,
LPCSTR pszPropName,
PVOID pvPropValue,
VARTYPE vtPropType,
DWORD dwBufferSize,
CMN_ERROR* pcmnerror );
Parámetro
hproperties
El Handle de la propiedad del trabajo de impresión se crea con la función
RPJCreatePropertyHandle.
pszPropName
Puntero en el nombre de la propiedad del trabajo de impresión:
AbsoluteSelectionFrom
AbsoluteSelectionTo
CycleSpan
DestinationFile
EnableCycle
EnableStart
EndPage Con estos datos se puede conseguir que la impresión del informe
termine con una página en concreto.
JobName El nombre del encargo de impresión debe ser unívoco dentro de un
proyecto y debe ser conforme a las convenciones de Windows.
LayoutName Con el nombre de diseño, se le asigna un diseño al trabajo de impre‐
sión.
PrinterName 1 Aquí se define la impresora en la que se intentará iniciar la impresión
en primer lugar.
PrinterName 2 Aquí se define la impresora que se activa cuando la primera impresora
no está disponible.
PrinterName 3 Aquí se define la impresora que se activa cuando las dos primeras
impresoras no están disponibles.
RelativeSelectionCount
RelativeSelectionRange
StartPage Con estos datos se puede conseguir que el informe se imprima a partir
de una página en concreto.
StartTime
UseRelative
UseOutputFile
UseOutputPrinter
pvPropValue
Puntero en el búfer que debe aceptar el nombre.
vtPropType
El tipo de la propiedad del objeto depende de pszPropName:
AbsoluteSelectionFrom VT_DATE
AbsoluteSelectionTo VT_DATE
CycleSpan VT_I4
DestinationFile VT_LPSTR
EnableCycle VT_I4
EnableStart VT_I4
EndPage VT_I4
JobName VT_LPSTR / VT_LPWSTR
LayoutName VT_LPSTR / VT_LPWSTR
PrinterName VT_LPSTR / VT_LPWSTR
PrinterName2 VT_LPSTR / VT_LPWSTR
PrinterName3 VT_LPSTR / VT_LPWSTR
RelativeSelectionCount VT_I4
RelativeSelectionRange VT_I4
StartPage VT_I4
StartTime VT_DATE
UseRelative VT_I4
UseOutputFile VT_I4
UseOutputPrinter VT_I4
Si se desea modificar una cadena de caracteres y la aplicación está compilada con Unicode,
es necesario utilizar como tipo de datos de vtPropVT_LPWSTR. De lo contrario vtProp es del
tipo de datos VT_LPTSTR.
Si vtProp es del tipo de datos VT_DATE, el parámetro prop deberá señalar a una estructura
SYSTEMTIME.
dwBufferSize
Tamaño del búfer al que señala prop en cantidad de bytes.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Propiedad de trabajo de impresión determinada
FALSE
Errores
Comentario
El búfer se llenará en caso de que se haya seleccionado el búfer demasiado pequeño para
el registro de la propiedad de trabajo, concebible, por ejemplo, en caso del nombre del trabajo
o el nombre del diseño, pero la función devolverá el mensaje de error
ERR_UNKNOWNERROR.
Mensajes de error
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Funciones similares
Ejemplos
Modify print job properties (Página 786)"RD02.cpp"
Consulte también
RPJGetJobProps (Página 767)
RPJSetProperty (Página 774)
RPJCreatePropertyHandle (Página 752)
Modify print job properties (Página 786)
Sinopsis de las funciones (Página 726)
Descripción
La utilización de la función tiene sentido si el área de memoria referenciada por un Handle
debe inicializarse sin que se borre el Handle.
Declaración
BOOL RPJPropertyClear (
HPROPERTIES hproperties,
CMN_ERROR* pcmnerror );
Parámetro
hproperties
El Handle de la propiedad del trabajo de impresión se crea con la función
RPJCreatePropertyHandle.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Memoria inicializada.
FALSE
Errores
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Funciones similares
Consulte también
RPJCreatePropertyHandle (Página 752)
Sinopsis de las funciones (Página 726)
Descripción
Con esta función se pueden modificar temporalmente distintas propiedades de trabajo de
impresión.
Antes de que se pueda ajustar de nuevo con RPJSetProperty el valor de la propiedad del
trabajo de impresión especificada con pszPropName, es necesario haber almacenado con
RPJGetJobProps las propiedades de trabajo en el búfer interno hProp.
Declaración
BOOL RPJSetProperty (
HPROPERTIES hproperties,
LPCSTR pszPropName,
PVOID pvPropValue,
VARTYPE vtPropType,
DWORD dwReserved,
CMN_ERROR* pcmnerror );
Parámetro
hproperties
Handle de las propiedades de trabajo de impresión. El Handle se crea con la función
RPJCreatePropertyHandle.
pszPropName
Puntero en el nombre de la propiedad del trabajo de impresión:
AbsoluteSelectionFrom
AbsoluteSelectionTo
CycleSpan
DestinationFile
EnableCycle
EnableStart
EndPage Con estos datos se puede conseguir que la impresión del informe
termine con una página en concreto.
JobName El nombre del encargo de impresión debe ser unívoco dentro de un
proyecto y debe ser conforme a las convenciones de Windows.
LayoutName Con el nombre de diseño, se le asigna un diseño al trabajo de impre‐
sión.
PrinterName 1 Aquí se define la impresora en la que se intentará iniciar la impresión
en primer lugar.
PrinterName 2 Aquí se define la impresora que se activa cuando la primera impresora
no está disponible.
PrinterName 3 Aquí se define la impresora que se activa cuando las dos primeras
impresoras no están disponibles.
RelativeSelectionCount
RelativeSelectionRange
StartPage Con estos datos se puede conseguir que el informe se imprima a partir
de una página en concreto.
StartTime
UseRelative
UseOutputFile
UseOutputPrinter
pvPropValue
Puntero en el valor de la propiedad del objeto.
vtPropType
El tipo de la propiedad del objeto depende de pszPropName:
AbsoluteSelectionFrom VT_DATE
AbsoluteSelectionTo VT_DATE
CycleSpan VT_I4
DestinationFile VT_LPSTR
EnableCycle VT_I4
EnableStart VT_I4
EndPage VT_I4
JobName VT_LPSTR / VT_LPWSTR
LayoutName VT_LPSTR / VT_LPWSTR
PrinterName VT_LPSTR / VT_LPWSTR
PrinterName2 VT_LPSTR / VT_LPWSTR
PrinterName3 VT_LPSTR / VT_LPWSTR
RelativeSelectionCount VT_I4
RelativeSelectionRange VT_I4
StartPage VT_I4
StartTime VT_DATE
UseRelative VT_I4
UseOutputFile VT_I4
UseOutputPrinter VT_I4
Si se desea modificar una cadena de caracteres y la aplicación está compilada con Unicode,
es necesario utilizar como tipo de datos de vtPropVT_LPWSTR. De lo contrario vtProp es del
tipo de datos VT_LPTSTR.
Si vtProp es del tipo de datos VT_DATE, el parámetro prop deberá señalar a una estructura
SYSTEMTIME.
dwReserved
El parámetro está reservado para ampliaciones posteriores.
pcmnerror
Puntero a los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Propiedad de trabajo de impresión modificada temporalmente
FALSE
Errores
Comentario
Con las funciones RPJGetNumJobProperties y RPJGetJobPropertyAt se pueden determinar
todas las propiedades de trabajo de impresión disponibles.
Archivos necesarios
rpjapi.h
rpjapi.lib
rpjapi.dll
Funciones similares
Ejemplos
Modify print job properties (Página 786)"RD02.cpp"
Consulte también
RPJGetJobProps (Página 767)
RPJGetProperty (Página 769)
RPJCreatePropertyHandle (Página 752)
Modify print job properties (Página 786)
Sinopsis de las funciones (Página 726)
Ejemplo
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
RPJCreatePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
ret = RPJDetach(&Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJDetach: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDetach"));
}
ODKTrace(szText);
return;
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJCreatePropertyHandle = 0x
%08lx"), hProp);
ODKTrace(szText);
}
memset(&Error,0,sizeof(CMN_ERROR));
ret = RPJGetNumJobMethods(&d, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJGetNumJobMethods:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
else
{
for (i = 0; i < d; i++)
{
memset(&Error,0,sizeof(CMN_ERROR));
ret = RPJGetJobMethodAt(i, buf, dwBufsize, &Error);
if(ret == FALSE)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
RPJDeletePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" %d PrintJobMethod=
%s"),i+1,buf);
}
ODKTrace(szText);
}
}
memset(&Error,0,sizeof(CMN_ERROR));
ret = RPJDeletePropertyHandle (hProp, &Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
RPJDeletePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDeletePropertyHandle"));
}
ODKTrace(szText);
memset(&Error,0,sizeof(CMN_ERROR));
ret = RPJDetach(&Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJDetach: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDetach"));
}
ODKTrace(szText);
}
//{{ODK_EXAMPLE}(END)}
Consulte también
RPJCreatePropertyHandle (Página 752)
RPJDeletePropertyHandle (Página 753)
RPJGetJobMethodAt (Página 763)
RPJGetNumJobMethods (Página 764)
Ejemplo
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
RPJDeletePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDeletePropertyHandle"));
}
ODKTrace(szText);
memset(&Error,0,sizeof(CMN_ERROR));
ret = RPJDetach(&Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJDetach: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDetach"));
}
ODKTrace(szText);
}
//{{ODK_EXAMPLE}(END)}
Consulte también
RPJCreatePropertyHandle (Página 752)
RPJDeletePropertyHandle (Página 753)
RPJGetJobNameAt (Página 755)
RPJGetNumJobs (Página 756)
Ejemplo
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
RPJDeletePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDeletePropertyHandle"));
}
ODKTrace(szText);
memset(&Error,0,sizeof(CMN_ERROR));
ret = RPJDetach(&Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJDetach: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDetach"));
}
ODKTrace(szText);
}
//{{ODK_EXAMPLE}(END)}
Consulte también
RPJCreatePropertyHandle (Página 752)
RPJDeletePropertyHandle (Página 753)
RPJGetJobPropertyAt (Página 765)
RPJGetNumJobProperties (Página 768)
Ejemplo
ODKTrace(szText);
return;
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" RPJGetJobProps"));
ODKTrace(szText);
}
typ = VT_DATE;
_tcsncpy_s(jobname, _countof(jobname), _T("ODK_PRINTJOB"), _TRUNCATE);
_tcsncpy_s(propname, _countof(propname), _T("STARTTIME"), _TRUNCATE);
memset(&st, 0, sizeof(SYSTEMTIME));
ptr = (LPVOID)&st;
memset(&Error,0,sizeof(CMN_ERROR));
ret = RPJGetProperty (hProp, propname, ptr, (VARTYPE)typ, 16, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJGetProperty: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" RPJGetProperty"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" Jobname=%s Propname=
%s"),jobname,propname);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" %02d.%02d.%04d %02d:
%02d:%02d"),
(WORD)st.wDay,
(WORD)st.wMonth,
(WORD)st.wYear,
(WORD)st.wHour,
(WORD)st.wMinute,
(WORD)st.wSecond);
}
ODKTrace(szText);
// write properties
st.wHour = 11;
st.wMinute = 12;
st.wSecond = 13;
memset(&Error,0,sizeof(CMN_ERROR));
ret = RPJSetProperty (hProp, propname, ptr, (VARTYPE) typ, 16, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJSetProperty: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" RPJSetProperty"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" Jobname=%s ;Propname=
%s"),jobname,propname);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" %02d.%02d.%04d %02d:
%02d:%02d"),
(WORD)st.wDay,
(WORD)st.wMonth,
(WORD)st.wYear,
(WORD)st.wHour,
(WORD)st.wMinute,
(WORD)st.wSecond);
}
ODKTrace(szText);
memset(&Error,0,sizeof(CMN_ERROR));
ret = RPJSetJobProps (hProp, jobname, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJSetJobProps: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" RPJSetJobProps"));
}
ODKTrace(szText);
memset(&Error,0,sizeof(CMN_ERROR));
ret = RPJDeletePropertyHandle (hProp, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
RPJDeletePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDeletePropertyHandle"));
}
ODKTrace(szText);
memset(&Error,0,sizeof(CMN_ERROR));
ret = RPJDetach(&Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJDetach: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE,
_T("RPJDeletePropertyHandle")); }
ODKTrace(szText);
}
//{{ODK_EXAMPLE}(END)}
Consulte también
RPJCreatePropertyHandle (Página 752)
RPJDeletePropertyHandle (Página 753)
RPJGetJobProps (Página 767)
RPJGetProperty (Página 769)
RPJSetProperty (Página 774)
Ejemplo
// =====================================================================
// =====================================================================
// : Modul with examples of Report Designer
// *********************************************************************
// Copyright (C) 1995-99 SIEMENS AG, A&D PT1 D2 All rights reserved
// *********************************************************************
#include "stdafx.h" // if MFC classes
#include "RD02.h"
#include "DM01.h"
}
memset(&Error, 0, sizeof(CMN_ERROR));
hProp = RPJCreatePropertyHandle (/*PROJ_PATH*/g_szProjectFile, &Error);
if(NULL == hProp)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
RPJCreatePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
ret = RPJDetach(&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJDetach: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDetach"));
}
ODKTrace(szText);
return;
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJCreatePropertyHandle = 0x
%08lx"), hProp);
ODKTrace(szText);
}
memset(&Error, 0, sizeof(CMN_ERROR));
ret = RPJGetJobProps (hProp, jobname, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJGetJobProps: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
ret = RPJDeletePropertyHandle (hProp, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
RPJDeletePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDeletePropertyHandle"));
}
ODKTrace(szText);
ret = RPJDetach(&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJDetach: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDetach"));
}
ODKTrace(szText);
return;
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" RPJGetJobProps"));
ODKTrace(szText);
}
_tcsncpy_s(methode, _countof(methode), _T("PREVIEW"), _TRUNCATE); // preview
// _tcsncpy_s(methode, _countof(methode), _T("PRINTJOB"), _TRUNCATE); // print
// _tcsncpy_s(methode, _countof(methode), _T("SETSELECTIONALLPAGES"), _TRUNCATE);
memset(&Error, 0, sizeof(CMN_ERROR));
ret = RPJCallJobMethod (hProp, methode, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJGetJobProps: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" RPJCallJobMethod"));
}
ODKTrace(szText);
memset(&Error, 0, sizeof(CMN_ERROR));
ret = RPJDeletePropertyHandle (hProp, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
RPJDeletePropertyHandle: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDeletePropertyHandle"));
}
ODKTrace(szText);
memset(&Error, 0, sizeof(CMN_ERROR));
ret = RPJDetach(&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in RPJDetach: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("RPJDetach"));
}
ODKTrace(szText);
}
//{{ODK_EXAMPLE}(END)}
Consulte también
RPJCreatePropertyHandle (Página 752)
RPJDeletePropertyHandle (Página 753)
RPJCallJobMethod (Página 762)
RPJGetJobProps (Página 767)
Resumen
Sinopsis
Sinopsis
Las funciones API pueden devolver los siguientes mensajes de error en la estructura de error
CMN_ERROR:
Ventana de runtime
Funciones de trasvase
Formatos de exportación/importación
Tipos de fichero
Tipos de ficheros
Flags de fichero
Plantillas de ventana
Plantillas
Valores límite
Formas de curva
TLG_DATATYP_TIMERANGE 0x00000001
TLG_DATATYP_USERARCHIV 0x00000002
TLG_DATATYP_BLOCKDATA 0x00000004
Rangos de tiempo
TLG_TR_MINUTE 1
TLG_TR_HOUR 2
TLG_TR_DAY 3
TLG_TR_WEEK 4
TLG_TR_MONTH 5
TLG_TR_YEAR 6
Ejes
TLG_AXIS_X_TOP 0x00000001
TLG_AXIS_X_MIDDLE 0x00000002
TLG_AXIS_X_BOTTOM 0x00000004
TLG_AXIS_Y_LEFT 0x00000001
TLG_AXIS_Y_MIDDLE 0x00000002
TLG_AXIS_Y_RIGHT 0x00000004
Conexión de informe
TLG_PROTFLG_TIME_RANGE 0x00000001
TLG_PROTFLG_DATA_RANGE 0x00000002
TLG_PROTFLG_DATA 0x00000001
TLG_PROTFLG_TITLE 0x00000002
TLG_PROTFLG_TIMEFIELD 0x00000004
TLG_PROTFLG_DATACOUNT 0x00000008
TLG_PROTFLG_DATEFIELD 0x00000010
TAG_PROT_CURVE_FORM_STEP 0x00000001
TAG_PROT_CURVE_FORM_POINTS 0x00000002
TAG_PROT_CURVE_FORM_DIRECT 0x00000003
TAG_PROT_CURVE_FORM_AREA 0x00000004
TLG_PROTFLG_FIRST_COL 0x00000000
TLG_PROTFLG_FIRST_COL_TIME 0x00000001
TLG_PROTFLG_FIRST_COL_DATA 0x00000002
TLG_PROTFLG_FIRST_COL_DATE 0x00000004
TLG_DATA_FROM_POS 0x00000000
TLG_DATA_FROM_BEGIN 0x00000001
TLG_DATA_FROM_END 0x00000002
TLG_DATA_FROM_ACTUAL 0x00000004
TLG_DATA_FROM_LEFT_ABS 0x00000008
TLG_DATA_FROM_RIGHT_ABS 0x00000010
PDE_DB_PRJ_PROJNAME_MAX_LENGHT 128
TLG_DB_PRJ_PROJNAME_MAX_LENGHT
PDE_DB_PRJ_COMMENT_MAX_LENGHT 200
TLG_DB_PRJ_COMMENT_MAX_LENGHT
PDE_DB_PRJ_USERDATE_MAX_LENGHT 12
TLG_DB_PRJ_USERDATE_MAX_LENGHT
PDE_DB_PRJ_USERNAME_MAX_LENGHT 30
TLG_DB_PRJ_USERNAME_MAX_LENGHT
PDE_DB_ARC_NAME_MAX_LENGHT 32
TLG_DB_ARC_NAME_MAX_LENGHT
PDE_DB_ARC_NAME_MAX_LENGHT 32
TLG_DB_ARC_NAME_MAX_LENGHT
TLG_DB_ARC_USER_NAME_MAX_LENGHT 8
PDE_DB_ARC_SERVERNAME_MAX_LENGHT 50
TLG_DB_ARC_SERVERNAME_MAX_LENGHT
PDE_DB_ARC_COMMENT_MAX_LENGHT 100
TLG_DB_ARC_COMMENT_MAX_LENGHT
PDE_DB_ARC_ACTIONNAME_MAX_LENGHT 30
TLG_DB_ARC_ACTIONNAME_MAX_LENGHT
PDE_DB_VAR_NAME_MAX_LENGHT 64
TLG_DB_VAR_NAME_MAX_LENGHT
TLG_DB6_VAR_NAME_MAX_LENGHT 128
TLG_DB_MCP_VAR_MAME_MAX_LENGTH 128
PDE_DB_VAR_COMMENT_MAX_LENGHT 100
TLG_DB_VAR_COMMENT_MAX_LENGHT
PDE_DB_VAR_WRITEBACK_MAX_LENGHT 64
TLG_DB_VAR_WRITEBACK_MAX_LENGHT
TLG_DB6_VAR_WRITEBACK_MAX_LENGHT 128
PDE_DB_VAR_CYCLENAME_MAX_LENGHT 30
TLG_DB_VAR_CYCLENAME_MAX_LENGHT
PDE_DB_VAR_SIGNALTEX_MAX_LENGHT 30
TLG_DB_VAR_SIGNALTEX_MAX_LENGHT
PDE_DB_VAR_DLLNAME_MAX_LENGHT 30
TLG_DB_VAR_DLLNAME_MAX_LENGHT
PDE_DB_VAR_FUNCNAME_MAX_LENGHT 30
TLG_DB_VAR_FUNCNAME_MAX_LENGHT
PDE_DB_VAR_UNITDIR_MAX_LENGHT 30
TLG_DB_VAR_UNITDIR_MAX_LENGHT
PDE_DB_VAR_UNITSTR_MAX_LENGHT 64
TLG_DB_VAR_UNITSTR_MAX_LENGHT
TLG_DB6_VAR_UNITSTR_MAX_LENGHT 128
PDE_DB_FUNCNAME_MAX_LENGHT 30
TLG_DB_FUNCNAME_MAX_LENGHT
PDE_DB_DLLNAME_MAX_LENGHT 30
TLG_DB_DLLNAME_MAX_LENGHT
PDE_DB_SCALE_MAX_LENGHT 30
TLG_DB_SCALE_MAX_LENGHT
PDE_DB_TIMENAME_MAX_LENGHT 30
TLG_DB_TIMENAME_MAX_LENGHT
PDE_DB_FIELDNAME_MAX_LENGHT 64
TLG_DB_FIELDNAME_MAX_LENGHT
PDE_DB_STRUCTNAME_MAX_LENGHT 30
TLG_DB_STRUCTNAME_MAX_LENGHT
Declaración
typedef struct {
TCHAR szName[
PDE_DB_ARC_NAME_MAX_LENGHT+1];
TCHAR szComment[
PDE_DB_ARC_COMMENT_MAX_LENGHT+1];
TCHAR szServername[
PDE_DB_ARC_SERVERNAME_MAX_LENGHT +1];
DWORD dwTyp;
DWORD dwAccessRead;
DWORD dwAccessWrite;
TCHAR szArchivAction[
PDE_DB_ARC_ACTIONNAME_MAX_LENGHT+1];
BOOL fLocked;
DWORD dwRecordTyp;
DWORD dwFillMessage;
DWORD dwRecordSize;
DWORD dwStorage;
TCHAR szCircularAction[
PDE_DB_ARC_ACTIONNAME_MAX_LENGHT+1];
TCHAR szCompressTime[
PDE_DB_TIMENAME_MAX_LENGHT+1];
DWORD dwSourceProcess;
TCHAR szRawDatVar[
PDE_DB_VAR_NAME_MAX_LENGHT+1];
TCHAR szSendAct[
PDE_DB_ARC_ACTIONNAME_MAX_LENGHT+1];
TCHAR szRecAct[
PDE_DB_ARC_ACTIONNAME_MAX_LENGHT+1];
DWORD dwRecItems;
}
TLG_ARCHIV_STR;
Members
szName
Parámetro global para el nombre del archivo
szComment
Parámetro global para el comentario del proyecto.
szServername
Parámetro global reservado para futuras ampliaciones.
dwTyp
Parámetro global que identifica el tipo de fichero.
dwAccessRead
Parámetro global que identifica el nivel de autorización para el acceso de lectura ( 0...999).
dwAccessWrite
Parámetro global que identifica el nivel de autorización para el acceso de escritura ( 0...999).
szArchivAction
Parámetro global con el nombre de la acción de la edición general del fichero.
fLocked
Parámetro global que identifica un fichero como habilitado o bloqueado.
dwRecordTyp
Parámetro para ficheros circulares y siguientes, el cual identifica el tipo de fichero.
dwFillMessage
Parámetro para ficheros circulares, siguientes y comprimidos, el cual identifica cuándo se
debe ejecutar un mensaje de nivel de llenado. Con una operación lógica O se pueden
configurar como máximo dos mensajes de nivel de llenado.
p.ej.: 100% || 50%-90%)
dwRecordSize
Parámetro para ficheros circulares, el cual define el tamaño del búfer circular en registros.
dwStorage
Parámetro para ficheros circulares, el cual define el lugar de archivación.
szCircularAction
Parámetro para fichero circular, nombre de la acción para traspasar los datos de un fichero
circular.
szCompressTime
Parámetro para ficheros comprimidos, nombre del objeto temporal que especifica el período
de compresión.
dwSourceProcess
Parámetro para ficheros comprimidos, el cual define el tipo de ejecución del fichero de origen.
PDE_COMPSRC_CALC Calcular
PDE_COMPSRC_CALCCOPY Calcular y copiar
PDE_COMPSRC_CALCDEL Calcular y borrar
PDE_COMPSRC_CALCCOPYDEL Calcular, copiar y borrar
szRawDatVar
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
szSendAct
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
szRecAct
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
dwRecItems
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
Observación
Los parámetros de la estructura TLG_ARCHIV_STR dependen del tipo de fichero (fichero de
proceso, o fichero comprimido) y el tipo de archivación (archivo circular o siguiente).
Archivos requeridos
pde_def.h
Funciones API
Consulte también
TLGReadArchiv (Página 895)
Declaración
typedef struct {
SYSTEMTIME stTime;
double doValue;
DWORD dwFlags;
}
TLG_ARCHIVDATARAW;
Members
stTime
stTime contiene el instante de archivación.
doValue
doValue contiene el valor existente en el instante stTime.
dwFlags
Tag Logging activa Flags para cada valor escrito en el fichero, los cuales proporcionan
información sobre el estado de las variables.
Para analizar los Flags se debe convertir el valor en su representación hexadecimal. Así,
● la palabra izquierda (HighWord) contiene Flags del administrador de datos
● la palabra izquierda (HighWord) contiene Quality Codes, cuando
PDE_RT_QUALITYCODE se encuentra activado
● la palabra derecha (LowWord) contiene Statusflags del Tag Logging
Observación
Si se requiere una hora actual para transferir un parámetro SYSTEMTIME, se debe utilizar la
función GetLocalTime y no GetSystemTime. Normalmente existe una diferencia de tiempo
considerable entre estas dos funciones.
Active el Flag PDE_RT_DAYLIGHT si la hora correspondiente coincide con el horario de
verano. La función de sistema GetTimeZoneInformation le permite determinar el estado del
Flag (TIME_ZONE_ID_DAYLIGHT).
Archivos requeridos
pdertdef.h
pdert.h
dmdefs.h
Funciones API
Consulte también
TLGGetArchivDataEx (Página 883)
Declaración
typedef struct {
TCHAR szArchivName[ _MAX_PATH + 1 ];
TCHAR szFileName[ _MAX_PATH + 1 ];
TCHAR szComment[ _MAX_PATH + 1 ];
DWORD dwFormatFlags;
DWORD dwJobFlags;
DWORD dwSize;
SYSTEMTIME sysFrom;
SYSTEMTIME sysTo;
DWORD dwUserData;
}
TLG_BACKUP_TABLE_INFO;
Members
szArchivName
Nombre del fichero del que se transferirán los datos.
szFileName
Nombre del archivo de transferencia con ruta y extensión
szComment
Texto del comentario para la transferencia
dwFormatFlags
Especificador de formato:
dwJobFlags
Posibles identificadores específicos de petición:
dwSize
Tamaño de los datos a exportar.
sysFrom
Instante de inicio a partir del cual se deben transferir datos.
sysTo
Instante final hasta el cual se deben transferir datos.
dwUserData
datos específicos de aplicación
Archivos requeridos
pdertdef.h
Funciones API
Consulte también
TLG_ENUMBACKUP_ENTRIES (Página 913)
Declaración
typedef struct {
DWORD dwDataTyp;
DWORD dwBufferSize;
DWORD dwRangeTyp;
DWORD dwAxisLocation;
BOOL fActualize;
BOOL fAutoRange;
BOOL fGridLinesBig;
BOOL fGridLinesFine;
BOOL fGridLinesBigVisible;
BOOL fGridLinesFineVisible;
BOOL fPercent;
BOOL fLimitRange;
BOOL fSubstitute;
SYSTEMTIME stFrom;
SYSTEMTIME stTo;
double doFrom;
double doTo;
double doGridBig;
double doGridFine;
double doShowDigits;
double doLimitUpper1;
double doLimitUpper2;
double doLimitUpper3;
double doLimitLower1;
double doLimitLower2;
double doLimitLower3;
double doDisplayRangeFrom;
double doDisplayRangeTo;
double doLimitRangeFrom;
double doLimitRangeTo;
COLORREF crColor;
COLORREF crColorTimeOverlapped;
COLORREF crColorTimeJump;
COLORREF crColorLimitUpper1;
COLORREF crColorLimitUpper2;
COLORREF crColorLimitUpper3;
COLORREF crColorLimitLower1;
COLORREF crColorLimitLower2;
COLORREF crColorLimitLower3;
TCHAR szSelectSQL[ TLG_MAX_SQL_SELECT ];
TCHAR szText[ TLG_MAX_STD_TEXT_NAME ];
TCHAR szFunction[ TLG_MAX_FUNCTION_NAME ];
TCHAR szDLL[ TLG_MAX_DLL_NAME ];
}
TLG_CURVESCALEX;
Members
dwDataTyp
Con dwDataTyp se determina el tipo de datos que sirven de base para la curva:
dwBufferSize
dwBufferSize equivale al número de puntos de medición de la curva y determina el tamaño
del búfer de datos de la curva.
dwRangeTyp
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
dwAxisLocation
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
fActualize
Si fActualize = TRUE la representación de la curva se realiza de forma dinámica. En otro caso
se representará de forma estática.
fAutoRange
Si fAutoRange = TRUE la autoescala se encuentra activada.
Si existe un fichero controlado por tiempo (dwDataTyp = TLG_DATATYP_TIMERANGE),
fAutoRange no produce ningún efecto y los valores indicados en stFrom y stTo son válidos.
fGridLinesBig
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
fGridLinesFine
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
fGridLinesBigVisible
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
fGridLinesFineVisible
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
fPercent
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
fLimitRange
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
fSubstitute
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
stFrom
Instante de inicio del área de representación. El parámetro sólo se evalúa si
dwDataTy = TLG_TIME_RANGE.
stTo
Instante final del área de representación. El parámetro sólo se evalúa si
dwDataTyp = TLG_TIME_RANGE.
Si se requiere una hora actual para transferir un parámetro SYSTEMTIME, se debe utilizar la
función GetLocalTime y no GetSystemTime. Normalmente existe una diferencia de tiempo
considerable entre estas dos funciones.
doFrom
Valor inicial del área de representación. El parámetro sólo se evalúa si
dwDataTyp = TLG_DATA_RANGE.
doTo
Valor final del área de representación. El parámetro sólo se evalúa si en
dwDataTyp = TLG_DATA_RANGE.
doGridBig
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
doGridFine
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
doShowDigits
Número de decimales
doLimitUpper1
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
doLimitUpper2
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
doLimitUpper3
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
doLimitLower1
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
doLimitLower2
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
doLimitLower3
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
doDisplayRangeFrom
Indica el valor a partir del cual se debe producir una visualización controlada por datos.
doDisplayRangeTo
Indica el valor hasta el cual se debe producir una visualización controlada por datos.
doLimitRangeFrom
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
doLimitRangeTo
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
crColor
El valor crColor de 32 bits específico de Windows determina el color de representación de la
curva.
crColorTimeOverlapped
El parámetro se reserva para futuras ampliaciones.
crColorTimeJump
El parámetro se reserva para futuras ampliaciones.
crColorLimitUpper1
El parámetro se reserva para futuras ampliaciones.
crColorLimitUpper2
El parámetro se reserva para futuras ampliaciones.
crColorLimitUpper3
El parámetro se reserva para futuras ampliaciones.
crColorLimitLower1
El parámetro se reserva para futuras ampliaciones.
crColorLimitLower2
El parámetro se reserva para futuras ampliaciones.
crColorLimitLower3
El parámetro se reserva para futuras ampliaciones.
szSelectSQL
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
szText;
Título del eje x.
szFunction
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
szDLL
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
Observación
TLG_CURVESCALEX es empleado por la estructura TLG_TPLITEM_CURVE (Página 838).
Archivos requeridos
pdertdef.h
Consulte también
TLG_TPLITEM_CURVE (Página 838)
Declaración
typedef struct {
DWORD dwDataTyp;
DWORD dwRangeTyp;
DWORD dwAxisLocation;
DWORD dwCurveForm;
BOOL fAutoRange;
BOOL fGridLinesBig;
BOOL fGridLinesFine;
BOOL fGridLinesBigVisible;
BOOL fGridLinesFineVisible;
BOOL fPercent;
BOOL fLimitRange;
BOOL fSubstitute;
SYSTEMTIME stFrom;
SYSTEMTIME stTo;
double doFrom;
double doTo;
double doGridBig;
double doGridFine;
double doShowDigitsF;
double doShowDigitsB;
double doLimitUpper1;
double doLimitUpper2;
double doLimitUpper3;
double doLimitLower1;
double doLimitLower2;
double doLimitLower3;
double doDisplayRangeFrom;
double doDisplayRangeTo;
double doLimitRangeFrom;
double doLimitRangeTo;
COLORREF crColor;
COLORREF crColorTimeOverlapped;
COLORREF crColorTimeJump;
COLORREF crColorLimitUpper1;
COLORREF crColorLimitUpper2;
COLORREF crColorLimitUpper3;
COLORREF crColorLimitLower1;
COLORREF crColorLimitLower2;
COLORREF crColorLimitLower3;
TCHAR szSelectSQL[ TLG_MAX_SQL_SELECT ];
TCHAR szText[ TLG_MAX_STD_TEXT_NAME ];
}
TLG_CURVESCALEY;
Members
dwDataTyp
El tipo de datos (tiempo/ usuario/ datos de bloque) carece aquí de significado
dwRangeTyp
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
dwAxisLocation
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
dwCurveForm
Con dwCurveForm se determina el aspecto de la curva
fAutoRange
fAutoRange = TRUE adapta automáticamente el área de representación.
fGridLinesBig
fgridLinesBig = TRUE activa líneas de cuadrícula gruesas.
fGridLinesFine
fgridLinesFine = TRUE activa líneas de cuadrícula finas.
fGridLinesBigVisible
Si fgridLinesBigVisible = TRUE se representan las líneas gruesas de cuadrícula.
fGridLinesFineVisible
Si fgridLinesFineVisible = TRUE se representan las líneas finas de cuadrícula.
fPercent
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
fLimitRange
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
fSubstitute
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
stFrom
El parámetro se reserva para futuras ampliaciones.
stTo
El parámetro se reserva para futuras ampliaciones.
doFrom
Límite inferior del área de representación del eje y.
doTo
Límite superior del área de representación del eje y.
doGridBig
Distancia entre las líneas gruesas de cuadrícula.
doGridFine
Distancia entre las líneas finas de cuadrícula.
doShowDigitsF
Dígitos al visualizar valores (previos a decimales)
doShowDigitsB
Determina el número de decimales
doLimitUpper1
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
doLimitUpper2
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
doLimitUpper3
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
doLimitLower1
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
doLimitLower2
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
doLimitLower3
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
doDisplayRangeFrom
Determina el valor a partir del cual comienza el área de representación.
doDisplayRangeTo
Determina el valor hasta el cual alcanza el área de representación.
doLimitRangeFrom
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
doLimitRangeTo
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
crColor
El valor crColor de 32 bits específico de Windows determina el color de representación de la
curva.
crColorTimeOverlapped
El parámetro se reserva para futuras ampliaciones.
crColorTimeJump
El parámetro se reserva para futuras ampliaciones.
crColorLimitUpper1
El parámetro se reserva para futuras ampliaciones.
crColorLimitUpper2
El parámetro se reserva para futuras ampliaciones.
crColorLimitUpper3
El parámetro se reserva para futuras ampliaciones.
crColorLimitLower1
El parámetro se reserva para futuras ampliaciones.
crColorLimitLower2
El parámetro se reserva para futuras ampliaciones.
crColorLimitLower3
El parámetro se reserva para futuras ampliaciones.
szSelectSQL[ TLG_MAX_SQL_SELECT ];
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
szText[ TLG_MAX_STD_TEXT_NAME ];
Título del eje y.
Observación
TLG_CURVESCALEY es empleado por la estructura AUTOHOTSPOT.
Archivos requeridos
pdertdef.h
Consulte también
TLG_TPLITEM_CURVE (Página 838)
Declaración
typedef struct {
LPTSTR lpszArchivName;
LPTSTR lpszVarName;
SYSTEMTIME stTime;
double doValue;
DWORD dwFlags;
}
TLG_GETARCHIVDATA;
Members
lpszArchivName
Puntero en el nombre del fichero desde el cual se han leído los datos.
lpszVarName
Puntero en el nombre de variable cuyos valores han sido leídos.
stTime
Valor x del valor de fichero.
doValue
Valor y del valor de fichero.
dwFlags
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
Archivos requeridos
pdertdef.h
Funciones API
Consulte también
TLG_GETARCHIVDATA_CALLBACK (Página 882)
Declaración
typedef struct {
SYSTEMTIME sysFrom;
SYSTEMTIME sysTo;
LPTSTR lpszSqlString;
}
TLG_IO_BACKUP_SELECT;
Members
sysFrom
Hora del sistema del primer registro a seleccionar
sysTo
Hora del sistema del último registro a seleccionar
lpszSqlString
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
Archivos requeridos
pdertdef.h
Funciones API
Consulte también
TLGGetBackupSize (Página 916)
TLGExport (Página 915)
Declaración
typedef struct {
TCHAR szArchivName[ 128 + 1 ];
TCHAR szVariableName[ 128 + 1 ];
TCHAR szTextX[ 128 + 1 ];
TCHAR szTextY[ 128 + 1 ];
SYSTEMTIME stFrom;
SYSTEMTIME stTo;
double doFrom;
double doTo;
DWORD dwFlags;
DWORD dwCurveForm;
}
TLG_PROT_CURVE_INFOS;
Members
szArchivName
Nombre del fichero del que proceden los datos a registrar.
szVariableName
Nombre de las variables de fichero cuyos valores se registran.
szTextX
Título del eje x.
szTextY
Título del eje y.
stFrom
Instante de inicio a partir del cual se registra. El parámetro sólo se evalúa si en dwFlags se
encuentra activado TLG_PROTFLG_TIME_RANGE.
stTo
Instante final hasta el cual se registra. El parámetro sólo se evalúa si en dwFlags se encuentra
activado TLG_PROTFLG_TIME_RANGE.
Si se requiere una hora actual para transferir un parámetro SYSTEMTIME, se debe utilizar la
función GetLocalTime y no GetSystemTime. Normalmente existe una diferencia de tiempo
considerable entre estas dos funciones.
doFrom
Instante de inicio a partir del cual se debe realizar el registro. El parámetro sólo se evalúa si
en dwFlags se encuentra activado TLG_PROTFLG_DATA_RANGE.
doTo
Instante final hasta el cual se debe realizar el registro. El parámetro sólo se evalúa si en
dwFlags se encuentra activado TLG_PROTFLG_DATA_RANGE.
dwFlags
Con dwFlags se determina el tipo de datos que sirven de base para la curva:
dwCurveForm
Con dwCurveForm se determina el aspecto de la curva
Observación
TLG_PROT_CURVE_INFOS es utilizado por las estructuras TLG_TABLESCALE
(Página 831) y TLG_TPLITEM_INFO (Página 839).
Archivos requeridos
pdertdef.h
Funciones API
Consulte también
TLGDrawCurvesInDC (Página 897)
TLG_TABLESCALE (Página 831)
TLG_TPLITEM_INFO (Página 839)
Declaración
typedef struct {
double doScalVarUpper;
double doScalVarLower;
double doScalArcUpper;
double doScalArcLower;
TCHAR szStructName[PDE_DB_SCALE_MAX_LENGHT];
}
TLG_SCAL_STR;
Members
doScalVarLower
Límite inferior del valor de variable.
doScalVarUpper
Límite superior del valor de variable.
doScalArcLower
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
doScalArcUpper
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
szStructName
Nombre de la estructura de escala para los valores de variable.
Observación
La estructura TLG_SCAL_STR se utiliza dentro de la estructura TLG_VAR_STR (Página 841)
para futuras ampliaciones.
Archivos requeridos
pde_def.h
Consulte también
TLG_VAR_STR (Página 841)
Declaración
typedef struct {
DWORD dwArchivTyp;
TCHAR szArchivName[ _MAX_PATH + 1 ];
DWORD dwSaveTyp;
}
TLG_TABLE_INFO;
Members
dwArchivTyp
dwArchivTyp identifica el tipo de fichero:
szArchivName
La forma en la que se proporciona el nombre del fichero depende de las funciones que utilizan
TLG_TABLE_INFO.
La enumeración de los ficheros mediante TLGEnumArchivs y TLGEnumArchivsSel
proporciona el nombre del fichero en forma de nombre de tabla, es decir, en la forma
"UA#ARCHIV#Archivname" para Userarchive o "PDE#HD#Archivname#Variablenname", ya
que aquí existe una variable para cada entrada de tabla. Es decir, se realiza una enumeración
para cada variable.
La enumeración mediante TLGEnumArchivsEx proporciona el "mero" nombre del fichero.
dwSaveTyp
dwSaveTyp identifica el tipo del fichero:
Ficheros requeridos
pdertdef.h
Funciones API
Consulte también
TLG_ENUMTABLES (Página 877)
Declaración
typedef struct {
BOOL fActualize;
BOOL fVisible;
BOOL fModify;
BOOL fCommon;
DWORD dwDataTyp;
SYSTEMTIME stFrom;
SYSTEMTIME stTo;
double doFrom;
double doTo;
double doShowDigits;
double doLimitUpper1;
double doLimitUpper2;
double doLimitUpper3;
double doLimitLower1;
double doLimitLower2;
double doLimitLower3;
OLORREF crColor;
COLORREF crColorTimeOverlapped;
COLORREF crColorTimeJump;
COLORREF crColorLimitUpper1;
COLORREF crColorLimitUpper2;
COLORREF crColorLimitUpper3;
COLORREF crColorLimitLower1;
COLORREF crColorLimitLower2;
COLORREF crColorLimitLower3;
TCHAR szSelectSQL[ TLG_MAX_SQL_SELECT ];
}
TLG_TABLESCALE;
Members
fActualize
fVisible
fModify
fCommon
TRUE Todas las columnas de la tabla poseen una columna de tiempos compartida:
FALSE Las columnas de la tabla no poseen una columna de tiempos compartida:
dwDataTyp
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
stFrom
Instante de inicio del área de representación.
stTo
Instante final del área de representación.
Si se requiere una hora actual para transferir un parámetro SYSTEMTIME, se debe utilizar la
función GetLocalTime y no GetSystemTime. Normalmente existe una diferencia de tiempo
considerable entre estas dos funciones.
doFrom
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
doTo
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
doShowDigits
Número de decimales de salida.
doLimitUpper1
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
doLimitUpper2
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
dpoLimitUper3
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
doLimitLower1
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
doLimitLower2
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
doLimitLower3
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
crColor
El valor crColor de 32 bits específico de Windows determina el color utilizado en la columna
de la tabla.
crColorTimeOverlapped
El parámetro se reserva para futuras ampliaciones.
crColorTimeJump
El parámetro se reserva para futuras ampliaciones.
crColorLimitUpper1
El parámetro se reserva para futuras ampliaciones.
crColorLimitUpper2
El parámetro se reserva para futuras ampliaciones.
crColorLimitUpper3
El parámetro se reserva para futuras ampliaciones.
crColorLimitLower1
El parámetro se reserva para futuras ampliaciones.
crColorLimitLower2
El parámetro se reserva para futuras ampliaciones.
crColorLimitLower3
El parámetro se reserva para futuras ampliaciones.
szSelectSQL
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
Observación
TLG_TABLESCALE es empleado por la estructura TLG_TEMPLATEITEM_INFO
(Página 834).
Archivos requeridos
pdertdef.h
Consulte también
TLG_PROT_CURVE_INFOS (Página 827)
TLG_TPLITEM_INFO (Página 839)
Declaración
typedef struct {
TCHAR szTemplateItemName[
TLG_MAX_TEMPLATEITEM_NAME+1 ];
TCHAR szTemplateName[
TLG_MAX_TEMPLATE_NAME + 1 ];
TCHAR szArchivName[ 128 + 1 ];
TCHAR szVariableName[ 128 + 1 ];
TCHAR szDMVariableName[ 128 + 1 ];
DWORD dwReadAccessLevel;
DWORD dwWriteAccessLevel;
DWORD dwArchivTyp;
TCHAR szTimeNameRange[ 128 + 1 ];
DWORD dwTemplateItemTyp;
DWORD dwTemplateTyp;
BOOL fVisible;
TLG_TPLITEM_INFO tplInfo;
}
TLG_TEMPLATEITEM_INFO;
Members
szTemplateItemName
Nombre de la curva / columna
szTemplateName
Nombre de la plantilla de la curva / plantilla de la ventana de tabla
szArchivName
Nombre del fichero en el cual se encuentra archivada la variable de fichero enlazada con la
curva / columna.
szVariableName
Nombre de las variables de fichero enlazadas con la curva / columna
szDMVariableName
Nombre de las variables del administrador de datos
dwReadAccessLevel
En la enumeración de curvas / columnas, dwReadAccesLevel contiene el nivel de autorización
de usuario para un acceso de lectura.
dwWriteAccessLevel
En la enumeración de curvas / columnas, dwWriteAccesLevel contiene el nivel de autorización
de usuario para un acceso de escritura.
dwArchivTyp
dwArchivTyp identifica el tipo de fichero:
szTimeNameRange
Nombre del objeto de tiempo a utilizar para fijar el rango de tiempo a partir de una hora de
inicio.
dwTemplateItemTyp
dwTemplateItemTyp debe corresponderse con el valor indicado en dwTemplateTyp:
dwTemplateTyp
dwTemplateTyp identifica el tipo de plantilla de ventana
fVisible
tplInfo
Estructura del tipo TLG_TPLITEM_INFO (Página 839) con las propiedades de una plantilla
de curva / columna.
Archivos requeridos
pdertdef.h
Funciones API
Consulte también
TLG_TPLITEM_INFO (Página 839)
TLG_TABLESCALE (Página 831)
TLGInsertTemplateItem (Página 899)
Declaración
typedef struct {
DWORD dwBasis;
DWORD dwFactor;
TCHAR szTimeName[
PDE_DB_TIMENAME_MAX_LENGHT + 1 ];
}
TLG_TIME_STR;
Members
dwBasis
Base de tiempo. El tiempo de ciclo resulta de multiplicar el factor de tiempo con la base de
tiempo.
TLG_TBASE_500MS 500ms
TLG_TBASE_SEC 1 segundo
TLG_TBASE_MIN 1 minuto
TLG_TBASE_HOUR 1 hora
TLG_TBASE_DAY 1 día
dwFactor
Factor de tiempo. El tiempo de ciclo resulta de multiplicar el factor de tiempo con la base de
tiempo.
szTimeName
Nombre del objeto de tiempo.
Observación
Al hablar de tiempos se entienden ciclos de adquisición y archivación de libre asignación. Se
puede utilizar un objeto de tiempo simultáneamente como ciclo de adquisición y ciclo de
archivación.
Archivos requeridos
pde_def.h
Funciones API
Consulte también
TLGReadTime (Página 910)
Declaración
typedef struct {
TCHAR szTimeName[ _MAX_PATH + 1 ];
DWORD dwTimeBase;
DWORD dwTimeValue;
}
TLG_TIMEDATA;
Members
szTimeName
Nombre del objeto de tiempo
dwTimeBase
Base de tiempo. El tiempo de ciclo resulta de multiplicar el factor de tiempo con la base de
tiempo
TLG_TBASE_500MS 500ms
TLG_TBASE_SEC 1 segundo
TLG_TBASE_MIN 1 minuto
TLG_TBASE_HOUR 1 hora
TLG_TBASE_DAY 1 día
dwTimeValue
Factor de tiempo. El tiempo de ciclo resulta de multiplicar el factor de tiempo con la base de
tiempo.
Archivos requeridos
pdertdef.h
Funciones API
Consulte también
TLG_ENUMTIMES_CALLBACK (Página 909)
Declaración
typedef struct {
TLG_CURVESCALEX csx;
TLG_CURVESCALEY csy;
}
TLG_TPLITEM_CURVE;
Members
csx
La estructura TLG_CURVESCALEX (Página 816) contiene los datos para la escala del eje X
de una curva.
csy
La estructura TLG_CURVESCALEY (Página 821) contiene los datos para la escala del eje Y
de una curva.
Descripción
TLG_TPLITEM_CURVE es empleado por la estructura TLG_TPLITEM_INFO (Página 839).
Archivos requeridos
pdertdef.h
Consulte también
TLG_TPLITEM_INFO (Página 839)
TLG_CURVESCALEX (Página 816)
TLG_CURVESCALEY (Página 821)
Declaración
typedef union {
TLG_TPLITEM_CURVE tplCurve;
TLG_TPLITEM_TABLE tplTable;
}
TLG_TPLITEM_INFO;
Members
tplCurve
Las propiedades de una curva se leen de la estructuraTLG_TPLITEM_CURVE (Página 838).
tplTable
Las propiedades de una columna se leen de la estructuraTLG_TPLITEM_TABLE
(Página 840).
Observación
TLG_TPLITEM_INFO es empleado por la estructura TLG_TEMPLATEITEM_INFO
(Página 834).
Dado que una variable se puede representar tanto en una curva como una tabla, es posible
asignar valores a ambas estructuras TLG_TPLITEM_CURVE y TLG_TPLITEM_TABLE.
Archivos requeridos
pdertdef.h
Consulte también
TLG_PROT_CURVE_INFOS (Página 827)
TLG_TABLESCALE (Página 831)
TLG_TEMPLATEITEM_INFO (Página 834)
TLG_TPLITEM_CURVE (Página 838)
TLG_TPLITEM_TABLE (Página 840)
Declaración
typedef struct {
TLG_TABLESCALE ts;
}
TLG_TPLITEM_TABLE;
Members
ts
TLG_TABLESCALE (Página 831) con las propiedades de una columna de tabla.
Descripción
TLG_TPLITEM_TABLE es empleado por la estructura TLG_TPLITEM_INFO (Página 839).
Por cuestiones de organización no es posible utilizar TLG_TABLESCALE directamente en la
estructura TLG_TPLITEM_INFO.
Archivos requeridos
pdertdef.h
Consulte también
TLG_TPLITEM_INFO (Página 839)
TLG_TABLESCALE (Página 831)
Declaración
typedef struct {
TCHAR szVarName [PDE_DB_VAR_NAME_MAX_LENGHT + 1];
TCHAR szProcName [PDE_DB_VAR_NAME_MAX_LENGHT + 1];
DWORD dwVarType;
DWORD dwArchivStyle;
TCHAR szWriteBackTo [PDE_DB_VAR_WRITEBACK_MAX_LENGHT + 1];
DWORD dwSupply;
BOOL fLocked;
TCHAR szComment [PDE_DB_VAR_COMMENT_MAX_LENGHT + 1];
TCHAR szRecordCycle [PDE_DB_VAR_CYCLENAME_MAX_LENGHT + 1];
TCHAR szArchivCycle [PDE_DB_VAR_CYCLENAME_MAX_LENGHT + 1];
DWORD dwMultiple;
DWORD dwValueFlow;
DWORD dwValueFollow;
DWORD dwSaveByFault;
DWORD dwArchivTrigger;
TCHAR szTextHighSignal [PDE_DB_VAR_SIGNALTEX_MAX_LENGHT + 1];
TCHAR szTextLowSignal [PDE_DB_VAR_SIGNALTEX_MAX_LENGHT + 1];
DWORD dwValProcess;
TCHAR szFuncValProcess [PDE_DB_VAR_FUNCNAME_MAX_LENGHT + 1];
TCHAR szDLLValProcess [PDE_DB_VAR_DLLNAME_MAX_LENGHT + 1];
TCHAR szFuncStartEvent [PDE_DB_VAR_FUNCNAME_MAX_LENGHT + 1];
TCHAR szDLLStartEvent [PDE_DB_VAR_DLLNAME_MAX_LENGHT + 1];
TCHAR szFuncStopEvent [PDE_DB_VAR_FUNCNAME_MAX_LENGHT + 1];
TCHAR szDLLStopEvent [PDE_DB_VAR_DLLNAME_MAX_LENGHT + 1];
TCHAR szFuncDynamic [PDE_DB_VAR_FUNCNAME_MAX_LENGHT + 1];
TCHAR szDLLDynamic [PDE_DB_VAR_DLLNAME_MAX_LENGHT + 1];
TCHAR szUnitDirect [PDE_DB_VAR_UNITDIR_MAX_LENGHT + 1];
TCHAR szUnitStruct [PDE_DB_VAR_UNITSTR_MAX_LENGHT + 1];
DWORD dwRecItems;
TCHAR szSourceArchiv [PDE_DB_ARC_NAME_MAX_LENGHT + 1];
TCHAR szSourceVarName [PDE_DB_VAR_NAME_MAX_LENGHT + 1];
TCHAR szRawdataName [PDE_DB_VAR_NAME_MAX_LENGHT + 1];
TCHAR szRawConvDLLName [TLG_DB_DLLNAME_MAX_LENGHT + 1];
DWORD dwRawDataIndex;
DWORD dwRawDataFormat;
TLG_SCAL_STR ScaleStruct;
TLG_RECORD_STR RecordStruct;
} TLG_VAR_STR;
Observación
La asignación de los parámetros de la estructura TLG_VAR_STR se realiza en función del
tipo de archivación (acíclica, cíclica selectiva o cíclica continua) y el tipo de variable (binaria
o analógica).
Members
szVarName
Parámetro global para el nombre de las variables de fichero / del grupo de variables.
Los caracteres : ? " ' \ * % y blanco no se pueden emplear en los nombres de variable de
fichero, ya que de lo contrario se suministra TLG_API_NAME_WRONG_CHAR.
szProcName
Parámetro global para el nombre de las variables de proceso
dwVarType
Parámetro global que identifica el tipo de variables de fichero.
dwArchivStyle
Parámetro global que identifica el tipo de archivación.
szWriteBackTo
Parámetro global en el cual se debe reescribir el nombre de la variable de fichero.
dwSupply
Parámetro global que identifica el modo de suministro de variables.
fLocked
Parámetro global que identifica el tratamiento de la archivación durante un arranque del
sistema.
TRUE bloqueado
FALSE habilitado
szComment
Parámetro global para el comentario de las variables de fichero.
szRecordCycle
Nombre del objeto de tiempo (p. ej.: "1 minuto"), el cual especifica el ciclo de adquisición.
El parámetro es relevante para la adquisición cíclica selectiva, cíclica continua de variables
analógicas y binarias.
szArchivCycle
Nombre del objeto de tiempo (p. ej.: "1 minuto"), que especifica el ciclo de archivación. El ciclo
de archivación resulta de multiplicar dwMultiple con szArchivCycle.
El parámetro es relevante para la archivación cíclica selectiva, cíclica continua de variables
analógicas y binarias.
dwMultiple
Identifica el factor de multiplicación. El ciclo de archivación resulta de multiplicar dwMultiple
con szArchivCycle.
El parámetro es relevante para la archivación cíclica selectiva, cíclica continua de variables
analógicas y binarias.
dwValueFlow
Identifica el número de valores de cabeza.
El parámetro es relevante para la archivación cíclica selectiva, cíclica continua de variables
analógicas y binarias.
dwValueFollow
Identifica el número de valores de retorno.
El parámetro es relevante para la archivación cíclica selectiva, cíclica continua de variables
analógicas y binarias.
dwSaveByFault
Identifica el comportamiento de almacenamiento en caso de fallo.
El parámetro es relevante para variables analógicas y binarias de todo tipo de archivaciones.
dwArchivTrigger
Identifica el comportamiento de disparo de la archivación.
El parámetro es relevante para la archivación cíclica selectiva, cíclica continua de variables
binarias.
szTextHighSignal
Texto para el estado de señal 1.
El parámetro es relevante para la archivación cíclica selectiva, cíclica continua de variables
binarias.
szTextLowSignal
Texto para el estado de señal 0.
El parámetro es relevante para la archivación cíclica selectiva, cíclica continua de variables
binarias.
dwValProcess
Identifica la ejecución del valor de fichero a guardar a través de los valores registrados durante
el ciclo de archivación.
El parámetro es relevante para la archivación cíclica selectiva, cíclica continua de variables
analógicas.
szFuncValProcess
Nombre de la acción o de la función DLL que especifica la ejecución del valor de fichero a
guardar.
El parámetro es relevante para la archivación cíclica selectiva, cíclica continua de variables
analógicas y comprimidas, únicamente si dwValProcess = TLG_VAL_DLL.
szDLLValProcess
Nombre del DLL.
El parámetro es relevante para la archivación cíclica selectiva, cíclica continua de variables
analógicas y comprimidas, únicamente si dwValProcess = TLG_VAL_DLL.
szFuncStartEvent
Nombre de la acción o de la función DLL que especifica el evento de arranque.
El parámetro es relevante para la archivación cíclica selectiva, cíclica continua de variables
analógicas y binarias.
szDLLStartEvent
Nombre del DLL.
El parámetro es relevante para la archivación cíclica selectiva, cíclica continua de variables
analógicas y binarias.
szFuncStopEvent
Nombre de la acción o de la función DLL que especifica el evento de parada.
El parámetro es relevante para la archivación cíclica selectiva de variables analógicas y
binarias.
szDLLStopEvent
Nombre del DLL.
El parámetro es relevante para la archivación cíclica selectiva de variables analógicas y
binarias.
szFuncDynamic
Nombre de la acción o de la función DLL que especifica la conmutación dinámica del ciclo de
adquisición y/o del ciclo de archivación.
El parámetro es relevante para la archivación cíclica selectiva, cíclica continua de variables
analógicas y binarias,
szDLLDynamic
Nombre del DLL.
El parámetro es relevante para la archivación cíclica selectiva, cíclica continua de variables
analógicas y binarias,
szUnitDirect
Identifica la unidad de las variables de fichero.
El parámetro es relevante para la variable analógica de todo tipo de archivaciones.
szUnitStruct
Nombre de la estructura que contiene la unidad de las variables de fichero. NULL cuando la
unidad se configura directamente en szUnitDirect.
El parámetro es relevante para la variable analógica de todo tipo de archivaciones,
dwRecItems
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
szSourceArchiv
Nombre del fichero de origen.
El parámetro es relevante para la archivación cíclica continua,
szSourceVarName
Nombre de las variables de fichero en el fichero de origen.
El parámetro es relevante para la archivación cíclica continua,
szRawdataName
Nombre de las variables de datos sin formato.
El parámetro es relevante para las variables controladas por proceso.
szRawConvDLLName
Nombre del DLL de normalización.
El parámetro es relevante para las variables controladas por proceso,
dwRawDataIndex
El número de las variables de datos sin formato se corresponde, en relación a S7PMC, con
el ID de fichero del PLC.
El parámetro es relevante para variables controladas por proceso.
dwRawDataFormat
Formato de las variables de datos sin formato.
El parámetro es relevante para las variables controladas por proceso
ScaleStruct
Estructura TLG_SCAL_STR (Página 829) con los valores límite de la variable.
RecordStruct
El parámetro se reserva para futuras ampliaciones.
Archivos necesarios
pde_def.h
Funciones API
Consulte también
TLGReadVariable (Página 867)
TLG_SCAL_STR (Página 829)
Declaración
typedef struct {
DWORD dwVariableTyp;
TCHAR szVariableName[ _MAX_PATH + 1 ];
}
TLG_VARIABLE_INFO;
Members
dwVariableTyp
dwVariableTyp identifica el tipo de variables. Valores posibles:
szVariableName
Nombre de la variable
Archivos requeridos
pdertdef.h
pde_typ.h
Funciones API
Consulte también
TLG_ENUMVARIABLES (Página 866)
Descripción
La función establece una conexión con la base de datos de proyecto WinCC.
Declaración
BOOL TLGCSConnect (
HWND hwndParent,
LPCMN_ERROR lpError );
Parámetro
hwndParent
Handle de ventana de la ventana maestra.
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Conexión establecida.
FALSE
Error
Archivos requeridos
pdecscli.h
pdecscli.lib
pdecscli.dll
Funciones relacionadas
Ejemplos
Enum all acquisition and archiving times (Página 922) "TL01.cpp"
Read parameters of time object (Página 936) "TL01.cpp"
Enum archives (Página 925) "TL01.cpp"
Read archive (Página 932) "TL01.cpp"
Consulte también
TLGCSConnectEx (Página 849)
Enum archives (Página 925)
TLGOpenProject (Página 857)
Read parameters of time object (Página 936)
Enum all acquisition and archiving times (Página 922)
Read archive (Página 932)
TLGCSDisConnect (Página 850)
Descripción
La función establece una conexión con la base de datos de proyecto WinCC.
Declaración
BOOL TLGCSConnectEx (
HWND hwndParent,
DWORD dwMode,
LPCMN_ERROR lpError );
Parámetro
hwndParent
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
dwMode
El parámetro se reserva para futuras ampliaciones.
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Conexión establecida
FALSE
Error
Archivos requeridos
pdecscli.h
pdecscli.lib
pdecscli.dll
Funciones relacionadas
Consulte también
TLGCSConnect (Página 848)
TLGOpenProject (Página 857)
Descripción
La función establece una conexión ya existente con la base de datos de proyecto WinCC. La
llamada es necesaria para que el DLL pueda volver a descargarse sin problemas.
Nota
No se puede utilizar la llamada en el destructor de una aplicación (EXE, DLL, OCX...), ya que
debido a los mecanismos especiales de Microsoft la llamada podría bloquearse, y en
consecuencia, también el programa.
Declaración
BOOL TLGCSDisConnect (
LPCMN_ERROR lpError );
Parámetros
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Conexión finalizada.
FALSE
Errores
Archivos necesarios
pdecscli.h
pdecscli.lib
pdecscli.dll
Funciones relacionadas
Ejemplos
Enum all acquisition and archiving times (Página 922) "TL01.cpp"
Read parameters of time object (Página 936) "TL01.cpp"
Enum archives (Página 925) "TL01.cpp"
Read archive (Página 932) "TL01.cpp"
Consulte también
TLGCSConnect (Página 848)
Enum all acquisition and archiving times (Página 922)
Enum archives (Página 925)
Descripción
La función permite cambiar el idioma de datos actualmente utilizado.
Declaración
BOOL TLGChangeLanguage (
DWORD dwLanguage,
PCMN_ERROR lpError );
Parámetro
dwLanguage
Código del futuro idioma a utilizar.
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Idioma de datos cambiado
FALSE
Error
Mensajes de error
Archivos requeridos
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
Descripción
La función inicializa el sistema de ficheros y establece una conexión con el Tag Logging
Runtime.
Declaración
BOOL TLGConnect (
HWND hwndParent,
PCMN_ERROR lpError );
Parámetro
hwndParent
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Conexión establecida
FALSE
Error
Observación
La llamada genera una ventana invisible para la comunicación, la cual se borra con la función
TLGDisconnect. Ello resulta eventualmente relevante si se utilizan también funciones de
Windows.
Mensajes de error
Archivos requeridos
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
Funciones relacionadas
Ejemplos
Enumerate archives (Página 930)"TL02.cpp"
Consulte también
Enumerate archives (Página 930)
TLGDisconnect (Página 854)
Edit curve template - Example 1 (Página 919)
Descripción
Con la función se interrumpe una conexión existente con el Tag Logging Runtime.
Declaración
BOOL TLGDisconnect (
PCMN_ERROR lpError );
Parámetro
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
conexión interrumpida
FALSE
Error
Observación
Nota
No se puede utilizar la llamada en el destructor de una aplicación (EXE, DLL, OCX...), ya que
debido a los mecanismos especiales de Microsoft la llamada podría bloquearse, y en
consecuencia, también el programa.
Mensajes de error
Archivos requeridos
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
Funciones relacionadas
Ejemplos
Enumerate archives (Página 930)"TL02.cpp"
Consulte también
Enumerate archives (Página 930)
TLGConnect (Página 853)
Edit curve template - Example 1 (Página 919)
Enum all acquisition and archiving times (Página 922)
Descripción
Cierra el proyecto actual. Se borran todos los objetos de datos pertenecientes a este proyecto.
La función deja de tener significado y suministra siempre el valor de retorno TRUE.
Declaración
BOOL TLGCloseProject(
HANDLE hProject,
LPCMN_ERROR lpoes );
Parámetro
hProject
Handle de un proyecto abierto con TLGOpenProject.
lpoes
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Proyecto cerrado
FALSE
Error
Archivos requeridos
pdecscli.h
pdecscli.lib
pdecscli.dll
Ejemplos
Read parameters of time object (Página 936)"TL01.cpp"
Enum archives (Página 925)"TL01.cpp"
Consulte también
Read parameters of time object (Página 936)
Enum archives (Página 925)
Read archive (Página 932)
Descripción
Establece una conexión con la base de datos de proyecto WinCC.
Declaración
BOOL TLGOpenProject (
HANDLE* lphProject,
LPTSTR lpszProjectName,
HWND hwndParent,
LPCMN_ERROR lpoes );
Parámetro
lphProject
Dirección de un área de memoria donde se guardará el Handle.
lpszProjectName
Nombre del proyecto a abrir.
La ruta del proyecto a indicar aquí puede ser determinada por una de las siguientes funciones
API:
● DMEnumOpenedProjects
● DMGetRuntimeProject
● TLGEnumProject
Cuando se indica una ruta de proyecto distinta del proyecto actualmente abierto se devuelve
el error TLG_API_PROJECT_NAME_NOT_EXIST. Sino existe ningún proyecto abierto se
devuelve el error TLG_API_NO_PROJECT_EXIST.
hwndParent
Handle de la ventana maestra.
lpoes
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Proyecto abierto
FALSE
Error
Observación
Si no se ha establecido previamente con TLGCSConnect una conexión con la base de datos
de proyecto WinCC se devuelve el error de conexión TLG_API_NO_CONNECTION.
Mensajes de error
Archivos necesarios
pdecscli.h
pdecscli.lib
pdecscli.dll
Funciones relacionadas
Ejemplos
Read parameters of time object (Página 936)"TL01.cpp"
Consulte también
TLGEnumProject (Página 859)
TLGCSConnect (Página 848)
TLGCSConnectEx (Página 849)
Read parameters of time object (Página 936)
Enum archives (Página 925)
Read archive (Página 932)
Enum variables of an archive (Página 928)
Descripción
La función determina el nombre del proyecto abierto.
Declaración
BOOL TLGEnumProject (
TLG_ENUM_PROJECT_NAME_CALLBACK lpCallbackFunc,
PVOID lpUser,
LPCMN_ERROR lpoes );
Parámetro
lpCallbackFunc
Puntero en su función Callback llamada para cada proyecto abierto.
lpUser
Puntero en datos específicos de la aplicación. Este puntero no es evaluado por la función,
sino que se pone nuevamente a disposición en la función Callback.
lpoes
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Proyectos listados
FALSE
Error
Archivos requeridos
pdecscli.h
pdecscli.lib
pdecscli.dll
Funciones relacionadas
Consulte también
TLG_ENUM_PROJECT_NAME_CALLBACK (Página 860)
TLGOpenProject (Página 857)
Descripción
Para poder evaluar los proyectos listados por el sistema debe proporcionar una función
Callback del tipo TLG_ENUM_PROJECT_NAME_CALLBACK.
Declaración
BOOL ( * TLG_ENUM_PROJECT_NAME_CALLBACK) (
LPTSTR lpszName,
PVOID lpUser );
Parámetro
lpszName
El puntero lpszName remite al nombre del primer proyecto.
lpUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
Los valores de retorno dependen de su implementación.
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
pdecscli.h
Funciones relacionadas
Consulte también
TLGEnumProject (Página 859)
Descripción
La función determina todos los nombres de variables de un archivo.
Declaración
BOOL TLGEnumVariables (
HANDLE hProject,
LPTSTR lpszArchivName,
TLG_ENUM_VARIABLE_NAME_CALLBACK lpCallbackFunc,
PVOID lpUser,
LPCMN_ERROR lpoes );
Parámetro
hProject
Handle del proyecto en el que se encuentra el fichero.
lpszArchivName
Puntero en el nombre del fichero
lpCallbackFunc
Puntero en su función Callback llamada para cada entrada de variable en el fichero.
lpUser
Puntero en datos específicos de la aplicación. Este puntero no es evaluado por la función,
sino que se pone nuevamente a disposición en la función Callback.
lpoes
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Variables de fichero listadas
FALSE
Error
Archivos requeridos
pdecscli.h
pdecscli.lib
pdecscli.dll
Funciones relacionadas
Consulte también
TLG_ENUM_VARIABLE_NAME_CALLBACK (Página 863)
TLGReadVariable (Página 867)
Descripción
Para poder evaluar las variables listadas por el sistema debe proporcionar una función
Callback del tipo TLG_ENUM_VARIABLE_NAME_CALLBACK.
Declaración
BOOL ( * TLG_ENUM_VARIABLE_NAME_CALLBACK) (
LPTSTR lpszName,
PVOID lpUser );
Parámetro
lpszName
El puntero lpszName remite al nombre de la primera variable.
lpUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
La enumeración continúa.
FALSE
La enumeración se cancela.
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
pdecscli.h
Funciones relacionadas
Consulte también
TLGEnumVariables (Página 861)
Descripción
La función determina todos los nombres de variables de un archivo.
Declaración
BOOL TLGEnumVariablesEx (
LPCTSTR lpszArchiveName,
TLG_ENUMVARIABLES lpfnCallback,
LPVOID lpUser,
PCMN_ERROR lpError );
Parámetro
lpszArchiveName
Puntero en el nombre del archivo, cuyas variables se deben listar.
lpfnCallback
Puntero en su función Callback llamada para cada variable del fichero.
lpUser
Puntero en datos específicos de la aplicación. Este puntero no es evaluado por la función,
sino que se pone nuevamente a disposición en la función Callback.
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Variables listadas
FALSE
Error
Mensajes de error
Archivos requeridos
pdecscli.h
pdecscli.lib
pdecscli.dll
pdertcli.h
pdertcli.lib
pdertcli.dll
Funciones relacionadas
Ejemplos
Enum variables of an archive (Página 928) "TL02.cpp"
Consulte también
TLG_ENUMVARIABLES (Página 866)
Enum variables of an archive (Página 928)
Descripción
Para poder evaluar los datos listados por el sistema de una variable debe proporcionar una
función Callback del tipo TLG_ENUMVARIABLES.
Declaración
BOOL ( * TLG_ENUMVARIABLES) (
PTLG_VARIABLE_INFO lpvi,
LPVOID lpUser );
Parámetro
lpvi
Dirección de una estructura del tipo TLG_VARIABLE_INFO (Página 847) con los datos de una
variable.
lpUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
La enumeración continúa.
FALSE
La enumeración se cancela.
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
pdertcli.h
pde_glob.h
pdertdef.h
Funciones relacionadas
Ejemplos
Enum variables of an archive (Página 928)"TL02.cpp"
Consulte también
TLGEnumVariablesEx (Página 864)
TLG_VARIABLE_INFO (Página 847)
Enum variables of an archive (Página 928)
TLGEnumArchivsEx (Página 873)
Descripción
Lectura de los parámetros de una variable.
Declaración
BOOL TLGReadVariable (
HANDLE hProject,
LPTSTR lpszArchivName,
LPTSTR lpszVariableName,
PTLG_VAR_STR lpVariable,
LPCMN_ERROR lpoes );
Parámetro
hProject
Handle del proyecto en que se encuentra la variable editar.
lpszArchivName
Puntero en el nombre del fichero
lpszVariableName
Puntero en el nombre de una variable del fichero.
lpVariable
Dirección de la estructura TLG_VAR_STR (Página 841) , desde la cual se deben leer los datos
de las variables.
lpoes
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Parámetros leídos
FALSE
Error
Archivos requeridos
pdecscli.h
pdecscli.lib
pdecscli.dll
Funciones relacionadas
Ejemplos
Read archive (Página 932)"TL01.cpp"
Consulte también
TLG_VAR_STR (Página 841)
TLGEnumVariables (Página 861)
Read archive (Página 932)
Descripción
La función determina el nombre de todos los ficheros del proyecto hproject. Esta función
permite editar todos los tipos de ficheros.
Declaración
BOOL TLGEnumArchives (
HANDLE hProject,
TLG_ENUM_ARCHIV_CALLBACK lpCallbackFunc,
PVOID lpUser,
LPCMN_ERROR lpoes );
Parámetro
hProject
Handle del proyecto en el que se encuentran los ficheros.
lpCallbackFunc
Puntero en su función Callback llamada para cada fichero.
lpUser
Puntero en datos específicos de la aplicación. Este puntero no es evaluado por la función,
sino que se pone nuevamente a disposición en la función Callback.
lpoes
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Ficheros listados
FALSE
Error
Archivos requeridos
pdecscli.h
pdecscli.lib
pdecscli.dll
Funciones relacionadas
Ejemplos
Enum archives (Página 925)"TL01.cpp"
Consulte también
TLG_ENUM_ARCHIV_CALLBACK (Página 870)
Enum archives (Página 925)
TLGReadArchiv (Página 895)
Descripción
Para poder evaluar los ficheros listados por el sistema debe proporcionar una función Callback
del tipo TLG_ENUM_ARCHIV_CALLBACK.
Declaración
BOOL ( * TLG_ENUM_ARCHIV_CALLBACK) (
LPTSTR lpszName,
PVOID lpUser );
Parámetro
lpszName
El puntero lpszName remite al nombre del fichero.
lpUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
La enumeración continúa.
FALSE
La enumeración se cancela.
Observación
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
pdecscli.h
Funciones relacionadas
Ejemplos
Enum archives (Página 925)"TL01.cpp"
Consulte también
TLGEnumArchives (Página 869)
Enum archives (Página 925)
Descripción
Enumera los ficheros existentes. A diferencia de TLGEnumArchivsSel, solo se pueden limitar
los ficheros a listar a través del tipo de fichero.
Declaración
BOOL TLGEnumArchivs (
DWORD dwArchivTyp,
TLG_ENUMTABLES lpfnCallback,
LPVOID lpUser,
PCMN_ERROR lpError );
Parámetro
dwArchivTyp
dwArchivTyp identifica el tipo de fichero:
lpfnCallback
Puntero en su función Callback llamada para cada fichero.
lpUser
Puntero en datos específicos de la aplicación. Este puntero no es evaluado por la función,
sino que se pone nuevamente a disposición en la función Callback.
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Ficheros listados
FALSE
Error
Mensajes de error
Archivos requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Funciones relacionadas
Ejemplos
Enumerate archives (Página 930)"TL02.cpp"
Consulte también
TLGEnumArchivsEx (Página 873)
TLGEnumArchivsSel (Página 875)
TLG_ENUMTABLES (Página 877)
Enumerate archives (Página 930)
Descripción
Enumera los ficheros existentes. A diferencia de TLGEnumArchivsSel, solo se pueden limitar
los ficheros a listar a través del tipo de fichero (fichero de usuario, fichero de valor de proceso,
fichero comprimido).
A través de la función Callback se proporcionan las informaciones de un fichero en estructuras
del tipo TLG_TABLE_INFO. A diferencia de TLGEnumArchivs, no se transfiere el nombre de
tabla del fichero, sino el "mero" nombre del fichero.
Declaración
BOOL TLGEnumArchivsEx (
DWORD dwArchivTyp,
TLG_ENUMTABLES lpfnCallback,
LPVOID lpUser,
PCMN_ERROR lpError );
Parámetro
dwArchivTyp
dwArchivTyp identifica el tipo de fichero:
lpfnCallback
Puntero en su función Callback llamada para cada fichero.
lpUser
Puntero en datos específicos de la aplicación. Este puntero no es evaluado por la función,
sino que se pone nuevamente a disposición en la función Callback.
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Los ficheros se listan
FALSE
Error
Mensajes de error
Archivos requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Funciones relacionadas
Consulte también
TLGEnumArchivsSel (Página 875)
TLGEnumArchivs (Página 871)
TLG_ENUMTABLES (Página 877)
Descripción
La función enumera los tipos de fichero existentes. A diferencia de TLGEnumArchivs, los
archivos a listar se pueden limitar junto con el tipo de archivo también mediante el tipo de
archivación (fichero circular, fichero siguiente).
A través de la función Callback se proporcionan las informaciones de un fichero en estructuras
del tipo TLG_TABLE_INFO. En esta operación se transfiere el nombre del fichero en forma
de nombre de tabla, es decir, en la forma "UA#ARCHIV#ArchivName" o
"PDE#HD#Archivname#Variablenname". Se enumeran todas las variables del fichero. Esta
forma se requiere, p.ej. en TLGBackup.
Declaración
BOOL TLGEnumArchivsSel (
DWORD dwArchivTyp,
DWORD dwSaveTyp,
TLG_ENUMTABLES lpfnCallback,
LPVOID lpUser,
PCMN_ERROR lpError );
Parámetro
dwArchivTyp
dwArchivTyp identifica el tipo de fichero:
dwSaveTyp
dwSaveTyp identifica el tipo del fichero:
lpfnCallback
Puntero en su función Callback llamada para cada fichero.
lpUser
Puntero en datos específicos de la aplicación. Este puntero no es evaluado por la función,
sino que se pone nuevamente a disposición en la función Callback.
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Los ficheros se listan.
FALSE
Error
Mensajes de error
Archivos requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Funciones relacionadas
Consulte también
TLGEnumArchivsEx (Página 873)
TLGEnumArchivs (Página 871)
TLG_ENUMTABLES (Página 877)
TLG_TABLE_INFO (Página 830)
Descripción
Para poder evaluar los ficheros listados por el sistema debe proporcionar una función Callback
del tipo TLG_ENUMTABLES.
Declaración
BOOL TLG_ENUMTABLES (
LPTSTR lpTableName,
PTLG_TABLE_INFO lpti,
PVOID lpUser );
Parámetro
lpTableName
Puntero al nombre del fichero.
lpti
La información sobre la tabla de la base de datos está contenida en la estructura
TLG_TABLE_INFO (Página 830).
lpUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
La enumeración continúa.
FALSE
La enumeración se cancela.
Observación
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Funciones relacionadas
Ejemplos
Enumerate archives "TL02.cpp"
Consulte también
TLGEnumArchivs (Página 871)
TLGEnumArchivsSel (Página 875)
TLG_TABLE_INFO (Página 830)
TLGEnumArchivsEx (Página 873)
Descripción
Con esta función se habilita un área de memoria mediante TLGGetArchivDataEx.
Declaración
BOOL TLGFreeMemory (
LPVOID lpMemory );
Parámetro
lpMemory
El puntero en el área de memoria a habilitar se obtiene al llamar la función
TLGGetArchivDataEx en el parámetro ppTLGData.
Nota
Se debe inicializar el puntero antes de la llamada TLGGetArchivDataEx() con NULL, y realizar
antes de la llamada TLGFreeMemory() una comprobación del tipo diferente de NULL.
Valor de retorno
TRUE
Se habilita la memoria
FALSE
Error
Nota
Se debe inicializar el puntero antes de la llamada TLGGetArchivDataEx() con NULL, y realizar
antes de la llamada TLGFreeMemory() una comprobación del tipo diferente de NULL.
Archivos requeridos
pdertcli.h
pdertcli.lib
pdertcli.dll
Funciones relacionadas
Consulte también
TLGGetArchivDataEx (Página 883)
Descripción
La función lee de un fichero los datos entre dos instantes. A diferencia de
TLGGetArchivDataEx, se proporcionan los valores de las variables de fichero mediante una
función Callback.
Con una llamada se pueden leer hasta 10.000 registros. Si existen más registros entre la hora
de inicio y la hora de fin, sólo obtendrá los primeros 10.000.
Los siguientes registros se obtienen añadiendo un milisegundo a la hora del último registro,
utilizándola como hora de inicio en una nueva llamada de TLGGetArchivData.
Declaración
BOOL TLGGetArchivData (
LPTSTR lpszArchivName,
LPTSTR lpszVarName,
SYSTEMTIME stStart,
SYSTEMTIME stStop,
TLG_GETARCHIVDATA_CALLBACK lpfnCallback,
PVOID lpUser,
DWORD dwFlags,
PCMN_ERROR lpError );
Parámetro
lpszArchivName
Puntero en el nombre del archivo del cual se deben leer datos.
lpszVarName
Puntero en el nombre de las variables de fichero, cuyos valores se deben leer.
stStart
Instante de inicio, a partir del cual se deben leer datos.
stStop
Instante final hasta el cual se deben leer datos.
lpfnCallback
Puntero en su función Callback llamada para cada punto de medición a leer.
lpUser
Puntero en datos específicos de la aplicación. Este puntero no es evaluado por la función,
sino que se pone nuevamente a disposición en la función Callback.
dwFlags
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Datos de fichero determinados
FALSE
Error
Mensajes de error
Archivos requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Funciones relacionadas
Consulte también
TLG_GETARCHIVDATA_CALLBACK (Página 882)
TLGGetArchivDataEx (Página 883)
Descripción
Para poder evaluar los datos de fichero listados por el sistema debe proporcionar una función
Callback del tipo TLG_GETARCHIVDATA_CALLBACK.
Declaración
BOOL ( * TLG_GETARCHIVDATA_CALLBACK) (
PTLG_GETARCHIVDATA lpGAD,
PVOID lpUser );
Parámetro
lpGAD
Por cada archivo el sistema reserva memoria con la longitud de la estructura
TLG_GETARCHIVDATA. El puntero lpGAD remite al comienzo del primer elemento.
lpUser
Puntero en datos específicos de la aplicación. Este puntero se vuelve a proporcionar en la
función Callback.
Valor de retorno
TRUE
Se continúa la enumeración.
FALSE
Se cancela la enumeración.
Nota
Transferir, dentro de lo posible, únicamente datos. Los siguientes tipos de llamadas de función
dentro del Callback pueden provocar Deadlocks o Stackoverflow:
● Funciones en las cuales se accede a un Message Loop, p.ej. GetMessage
● Funciones API Runtime de la misma DLL
● Enumeraciones que llaman otras enumeraciones
Archivos requeridos
pdertcli.h
pde_glob.h
pdertdef.h
Funciones relacionadas
Consulte también
TLGGetArchivData (Página 880)
TLG_GETARCHIVDATA (Página 825)
Descripción
Lee de un fichero los datos entre dos instantes. A diferencia de TLGGetArchivData los valores
de las variables de fichero se guardan en la memoria.
Nota
La memoria asignada en ppTlgData se debe habilitar de nuevo mediante TLGFreeMemory.
Declaración
BOOL TLGGetArchivDataEx (
LPCTSTR lpszArchivName,
LPCTSTR lpszVarName,
SYSTEMTIME* pstStart,
SYSTEMTIME* pstStop,
PTLG_ARCHIVDATARAW* ppTlgData,
DWORD* pdwNumberOfData,
DWORD* pdwFlags,
PCMN_ERROR lpError );
Parámetro
lpszArchivName
Puntero en el nombre del fichero desde el cual se leen los datos.
lpszVarName
Puntero en el nombre de las variables de fichero, cuyos valores se leen.
stStart
Instante de inicio, a partir del cual se leen datos.
stStop
Instante final hasta el cual se leen datos.
Si se requiere una hora actual para transferir un parámetro SYSTEMTIME, utilice la función
GetLocalTime y no GetSystemTime. Normalmente existe una diferencia de tiempo
considerable entre estas dos funciones.
ppTlgData
Dirección de un puntero, en el cual se guarda la dirección de los datos de las variables de
fichero. El campo de datos es asignado por TLGGetArchivDataEx y contiene estructuras del
tipo TLG_ARCHIVDATARAW (Página 811).
Nota
Se debe habilitar de nuevo la memoria asignada mediante TLGFreeMemory.
Se debe inicializar el puntero antes de la llamada TLGGetArchivDataEx() con NULL, y realizar
antes de la llamada TLGFreeMemory() una comprobación del tipo diferente de NULL.
pdwNumberOfData
Puntero en la cantidad de registros.
● Antes de la llamada: Cantidad máxima de registros a leer.
● Después de la llamada: Cantidad de registros leídos con los valores de las variables de
fichero (de las estructuras del tipo TLG_ARCHIVDATARAW).
Se pueden leer un máximo de 10.000 registros con una llamada. Si existen más registros
entre la hora de inicio y la hora de fin, sólo recibirá los primeros 10.000. Para obtener los
siguientes debe añadir un milisegundo a la hora del último registro, indicando esta
circunstancia como hora de inicio en la nueva llamada de TLGGetArchivDataEx.
dwFlags
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Datos de fichero determinados
FALSE
Error
Nota
La memoria asignada mediante en TLGGetArchivDataEx en ppTlgData se debe habilitar de
nuevo mediante TLGFreeMemory.
Se debe inicializar el puntero antes de la llamada TLGGetArchivDataEx() con NULL, y realizar
antes de la llamada TLGFreeMemory() una comprobación del tipo diferente de NULL.
Mensajes de error
Archivos requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Funciones relacionadas
Consulte también
TLGFreeMemory (Página 879)
TLGGetArchivData (Página 880)
TLG_ARCHIVDATARAW (Página 811)
Descripción
La función determina los instantes de archivación adyacentes en un instante predeterminado.
Declaración
BOOL TLGGetClosestTime (
LPCTSTR lpszArchivName,
LPCTSTR lpszVarName,
SYSTEMTIME* pstTime,
BOOL bPrevious,
PCMN_ERROR lpError );
Parámetro
lpszArchivName
Puntero en el nombre del fichero
lpszVarName
Puntero en el nombre de las variables
pstTime
pstTime se utiliza como parámetro de entrada y salida. Al llamar TLGGetClosestTime, pstTime
contiene la hora del sistema a la cual se deben determinar los tiempos de archivación
adyacentes. Una vez ejecutada correctamente la llamada de función, pstTime contiene el
instante de archivación más próximo.
bPrevious
bPrevious identifica si a la hora del sistema transmitida se debe determinar un instante de
archivación previo o consecutivo.
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
pstTime contiene un instante de archivación adyacente.
FALSE
Error o no se ha podido determinar ningún instante de archivación adyacente.
Observación
Si bPrevious se encuentra indicado como TRUE y pstTime contiene un valor existente, puede
ocurrir que se devuelva exactamente este instante y no el instante precedente. Si bPrevious
se encuentra indicado como FALSE, siempre se suministra el instante consecutivo.
Mensajes de error
Archivos requeridos
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
Funciones relacionadas
Consulte también
TLGGetClosestTimeEx (Página 888)
Descripción
La función determina los instantes de archivación adyacentes en un instante predeterminado.
Declaración
BOOL TLGGetClosestTimeEx (
LPCTSTR lpszArchivName,
LPCTSTR lpszVarName,
SYSTEMTIME* pstTime,
BOOL bPrevious,
BOOL bIgnoreInvalid,
PCMN_ERROR lpError );
Parámetro
lpszArchivName
Puntero en el nombre del fichero
lpszVarName
Puntero en el nombre de las variables
pstTime
pstTime se utiliza como parámetro de entrada y salida. Al llamar TLGGetClosestTime,
pstTime contiene la hora del sistema a la cual se deben determinar los tiempos de archivación
adyacentes. Una vez ejecutada correctamente la llamada de función, pstTime contiene el
instante de archivación más próximo.
bPrevious
bPrevious identifica si a la hora del sistema transmitida se debe determinar un instante de
archivación previo o consecutivo.
bIgnoreInvalid
Indica si en la determinación del tiempo se deben ignorar los valores con el Flag Fallo de
conexión.
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
pstTime contiene un instante de archivación adyacente.
FALSE
Error o no se ha podido determinar ningún instante de archivación adyacente.
Observación
Si bPrevious se encuentra indicado como TRUE y pstTime contiene un valor existente, puede
ocurrir que se devuelva exactamente este instante y no el instante precedente. Si bPrevious
se encuentra indicado como FALSE, siempre se suministra el instante consecutivo.
Mensajes de error
Archivos requeridos
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
Funciones relacionadas
Consulte también
TLGGetClosestTime (Página 886)
Descripción
La función permite incorporar cualquier tipo de datos a un fichero existente en el disco duro.
Si ejecuta TlgInsertArchivData para valores creados durante el horario de verano, deberá
tener en cuenta el desplazamiento horario. Al llamar estos valores active el Flag
PDE_RT_DAYLIGHT.
Sin este Flag las llamadas de lectura, p. ej. TLGGetArchivData o TLGGetClosestTime,
devuelven la hora estándar.
Nota
Al no comprobarse la veracidad de los datos incorporados existe el riesgo de que el fichero
sea destruido.
Declaración
BOOL TLGInsertArchivData (
LPCTSTR lpszArchivName,
LPCTSTR lpszVarName,
PTLG_ARCHIVDATARAW pTlgData,
DWORD dwNumberOfData,
DWORD dwFlags,
PCMN_ERROR lpError );
Parámetro
lpszArchivName
Puntero al nombre del fichero
lpszVarName
Puntero al nombre de la variable
pTlgData
Puntero a la primera de las estructuras del tipo TLG_ARCHIVDATARAW con los valores de
variable a incorporar al fichero.
dwNumberOfData
Número de valores de variable a incorporar (de las estructuras TLG_ARCHIVDATARAW).
dwFlags
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0. Aquí puede
indicarse el flag TLG_API_FLG_FAST_INSERT.
Cuando se activa que este Flag, los datos se escriben mucho más rápido en el modo
optimizado.
No obstante, para poder utilizar esta optimización de rendimiento, los sellos de tiempo de los
registros escritos deben encontrarse ordenados con la secuencia de tiempo correcta y además
siempre deben ser más actuales que los registros ya existentes en el fichero.
No se puede utilizar este Flag al incorporar registros más antiguos entre registros ya
existentes. Si se incorporan valores más antiguos que los actuales o no ordenados
temporalmente, los valores más antiguos se rechazan sin indicación de error.
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Valores de variable incorporados al fichero.
FALSE
Error
Observación
Si se indica un fichero en lpszArchivName, ubicado en la memoria principal, se emite el
mensaje de error TLG_API_ERR_SUPPLY.
Esta función solamente se puede aplicar para ficheros existentes en el disco duro. Si se
producen errores de escritura en valores individuales, se devuelve una descripción detallada
del error en CMN_ERROR . Debido a la limitación de la longitud del CMN_ERR.szErrorText
la cantidad de errores detallados se limita a un máximo de 57.
dwError1 TLG_API_ERR_SUPPLY
dwError2 0
dwError3 Número de línea en el código fuente
dwError4 Cantidad de errores (máx. 57)
Mensajes de error
Archivos necesarios
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Descripción
Bloquea o habilita un fichero completo. Un fichero bloqueado no permite archivar datos nuevos.
Declaración
BOOL TLGLockArchiv (
HWND hwnd,
LPTSTR lpszArchivName,
BOOL fLocked,
PCMN_ERROR lpError );
Parámetro
hwnd
Handle de ventana de la ventana PDE Runtime.
lpszArchivName
Puntero en el nombre del fichero.
fLocked
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR . En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Fichero bloqueado/ habilitado
FALSE
Error
Mensajes de error
Archivos requeridos
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
Descripción
Bloquea o habilita una variable. No es posible actualizar o archivar una variable bloqueada.
Declaración
BOOL TLGLockVariable (
HWND hwnd,
LPTSTR lpszArchivName,
LPTSTR lpszVarName,
BOOL fLocked,
PCMN_ERROR lpError );
Parámetro
hwnd
Handle de ventana de la ventana PDE Runtime.
lpszArchivName
Puntero en el nombre del fichero
Para seleccionar un servidor determinado se puede anteponer "ServerPräfix::" al nombre de
fichero.
lpszVarName
Puntero en el nombre de las variables
fLocked
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Variable habilitada / bloqueada
FALSE
Error
Mensajes de error
Archivos requeridos
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
Descripción
Lectura de los parámetros de un fichero existente en el proyecto hProject. Esta función permite
editar todos los tipos de ficheros.
Declaración
BOOL TLGReadArchiv (
HANDLE hProject,
LPTSTR lpszArchivName,
PTLG_ARCHIV_STR lpArchiv,
LPCMN_ERROR lpoes );
Parámetro
hProject
Handle del proyecto en el que se encuentra el fichero a editar.
lpszArchivName
Nombre del fichero a editar.
lpArchiv
Dirección de la estructura TLG_ARCHIV_STR (Página 808) , en la cual se archivan los
parámetros del fichero.
lpoes
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Contenidos del fichero leídos
FALSE
Error
Archivos requeridos
pdecscli.h
pdecscli.lib
pdecscli.dll
Funciones relacionadas
Ejemplos
Read archive (Página 932)"TL01.cpp"
Consulte también
TLGEnumArchives (Página 869)
Read archive (Página 932)
TLG_ARCHIV_STR (Página 808)
Descripción
Esta función cierra una ventana de una aplicación.
Declaración
BOOL TLGCloseWindow (
HWND hwnd,
PCMN_ERROR lpError );
Parámetros
hwnd
Handle en la ventana maestra de la aplicación a cerrar.
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Ventana de la aplicación cerrada
FALSE
Error
Mensajes de error
Archivos requeridos
pdertcli.h
pde_glob.h
pdertcli.lib
pdertcli.dll
Descripción
Esta función permite representar curvas en una ventana de una aplicación.
Declaración
BOOL TLGDrawCurvesInDC (
HDC hDC,
PRECT lprect,
PTLG_PROT_CURVE_INFOS lpci,
DWORD dwNumberOfCurves,
LPCMN_ERROR lpError );
Parámetro
hDC
Handle en la ventana maestra, en la que se debe representar la curva
lprect
Puntero en la estructura específica de Windows del tipo RECT con las indicaciones de tamaño
de la ventana.
lpci
Puntero en la primera estructura del tipo TLG_PROT_CURVE_INFOS (Página 827) con
informaciones sobre la forma de representación de las curvas.
dwNumberOfCurves
Número de estructuras entregadas en lpci (número de curvas a representar).
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Curvas representadas
FALSE
Error
Mensajes de error
Archivos requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Consulte también
TLG_PROT_CURVE_INFOS (Página 827)
Descripción
La función añade una nueva entrada a una plantilla de ventana existente, bien una plantilla
de curva o una plantilla de tabla.
Declaración
BOOL TLGInsertTemplateItem (
LPTSTR lpszTemplateName,
PTLG_TEMPLATEITEM_INFO lpptii,
LPCMN_ERROR lpError );
Parámetro
lpszTemplateName
Puntero en el nombre de la plantilla de ventana a la que se desea añadir una plantilla de curva
o de tabla.
lpptii
Puntero en una estructura del tipo TLG_TEMPLATEITEM_INFO (Página 834) con los datos
de la plantilla de curva o tabla a añadir.
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Plantilla de ventana ampliada
FALSE
Error
Mensajes de error
Archivos requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Ejemplos
Edit curve template - Example 1 (Página 919)"TL02.cpp"
Consulte también
TLG_TEMPLATEITEM_INFO (Página 834)
Edit curve template - Example 1 (Página 919)
Descripción
Esta función permite lanzar las funciones enlazadas con los botones de la barra de
herramientas.
Declaración
BOOL TLGPressToolbarButton (
LPTSTR lpszTemplate,
DWORD dwButtonID,
PCMN_ERROR lpError );
Parámetro
lpszTemplate
Nombre de la plantilla
dwButtonID
Clave para el botón a activar:
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Mensajes de error
Archivos requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Descripción
Esta función permite mostrar u ocultar la ventana de datos de la línea de lectura.
Declaración
BOOL TLGSetRulerWindowVisible (
LPTSTR lpszTemplateName,
BOOL bShowRulerWindow,
LPCMN_ERROR lpError );
Parámetro
lpszTemplateName
Puntero en el nombre de la plantilla de ventana.
bShowRulerWindow
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Se ha aceptado nuevamente el parámetro para la visibilidad de la ventana de datos de la línea
de lectura.
FALSE
Error
Observación
En el visor de curvas f(x) y el visor de tablas, la función resulta efectiva en cuanto se muestra
la imagen correspondiente con el objeto.
Mensajes de error
Archivos requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Descripción
La función influye en la forma en que se representa la ventana.
Declaración
BOOL TLGShowWindow (
HWND hwnd,
DWORD dwFlags,
PCMN_ERROR lpError );
Parámetro
hwnd
Handle de ventana de la ventana Runtime.
dwFlags
Aquí se aplican los mismos Flags que en ::ShowWindow(HWND hwnd, int nCmdShow), tal y
como se definen en WinUser.h (SW_SHOW, SW_HIDE, ...).
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Ventana de aplicación mostrada
FALSE
Error
Mensajes de error
Archivos requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
WinUser.h
Descripción
Enumera los nombres de todos los tiempos de adquisición y archivación de un proyecto.
Declaración
BOOL TLGEnumTime (
HANDLE hProject,
TLG_ENUM_TIME_NAME_CALLBACK lpCallbackFunc,
PVOID lpUser,
LPCMN_ERROR lpoes );
Parámetro
hProject
Handle del proyecto en el que se encuentran los objetos de tiempo a listar.
lpCallbackFunc
Puntero en su función Callback llamada una única vez para cada objeto de tiempo existente.
lpUser
Puntero en datos específicos de la aplicación. Este puntero no es evaluado por la función,
sino que se pone nuevamente a disposición en la función Callback.
lpoes
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Objetos de tiempo listados
FALSE
Error
Archivos requeridos
pdecscli.h
pdecscli.lib
pdecscli.dll
Funciones relacionadas
Ejemplos
Enum all acquisition and archiving times (Página 922)"TL01.cpp"
Consulte también
TLG_ENUM_TIME_NAME_CALLBACK (Página 906)
Enum all acquisition and archiving times (Página 922)
Descripción
Para poder evaluar los objetos de tiempo listados por el sistema debe proporcionar una función
Callback del tipo TLG_ENUM_TIME_NAME_CALLBACK.
Declaración
BOOL ( * TLG_ENUM_TIME_NAME_CALLBACK) (
LPTSTR lpszName,
PVOID lpUser );
Parámetro
lpszName
El puntero lpszName remite al nombre del primer objeto de tiempo.
lpUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
La enumeración continúa.
FALSE
La enumeración se cancela.
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
pdecscli.h
Funciones relacionadas
Ejemplos
Enum all acquisition and archiving times (Página 922)"TL01.cpp"
Consulte también
Enum all acquisition and archiving times (Página 922)
TLGEnumTime (Página 905)
Descripción
Enumera todos los tiempos de adquisición y archivación.
Declaración
BOOL TLGEnumTimes(
TLG_ENUMTIMES_CALLBACK lpfnCallback,
LPVOID lpUser,
PCMN_ERROR lpError );
Parámetro
lpfnCallback
Puntero en su función Callback,
lpUser
Puntero en datos específicos de la aplicación. Este puntero no es evaluado por la función,
sino que se pone nuevamente a disposición en la función Callback.
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Objetos de tiempo listados.
FALSE
Error
Mensajes de error
Archivos requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Funciones relacionadas
Consulte también
TLG_ENUMTIMES_CALLBACK (Página 909)
Descripción
Para poder evaluar los objetos de tiempo listados por el sistema debe proporcionar una función
Callback del tipo TLG_ENUMTIMES_CALLBACK.
Declaración
BOOL ( * TLG_ENUMTIMES_CALLBACK) (
PTLG_TIMEDATA lpTime,
PVOID lpUser );
Parámetro
lpTime
Por cada objeto de tiempo el sistema reserva memoria con la longitud de la estructura
TLG_TIMEDATA (Página 837). El puntero lpTime remite al comienzo del primer elemento.
lpUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
La enumeración continúa.
FALSE
La enumeración se cancela.
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
pdertcli.h
pde_glob.h
pdertdef.h
Funciones relacionadas
Consulte también
TLGEnumTimes (Página 907)
TLG_TIMEDATA (Página 837)
Descripción
Lectura de los parámetros de un objeto de tiempo ya creado.
Declaración
BOOL TLGReadTime (
HANDLE hProject,
LPTSTR lpszTimeName,
PTLG_TIME_STR lpTime,
LPCMN_ERROR lpoes );
Parámetro
hProject
Handle del proyecto en el que se encuentra el objeto de tiempo a editar.
lpszTimeName
Puntero en el nombre del objeto de tiempo
lpTime
Dirección de la estructura TLG_TIME_STR (Página 836) , con los datos del objeto de tiempo.
lpoes
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Parámetros del objeto de tiempo leídos.
FALSE
Error
Archivos requeridos
pdecscli.h
pdecscli.lib
pdecscli.dll
Ejemplos
Read parameters of time object (Página 936)"TL01.cpp"
Consulte también
TLG_TIME_STR (Página 836)
Read parameters of time object (Página 936)
Descripción
Ya no se soporta esta función, devolviéndose el valor FALSE y el código de error
TLG_API_NOT_SUPPORTED.
Declaración
BOOL TLGEnumBackupEntries (
LPTSTR lpszArchivName,
TLG_ENUMBACKUP_ENTRIES lpfnCallback,
LPVOID lpUser,
PCMN_ERROR lpError );
Parámetro
lpszArchivName
Puntero en el nombre del fichero
lpfnCallback
Puntero en su función Callback llamada para cada copia de seguridad existente.
lpUser
Puntero en datos específicos de la aplicación. Este puntero no es evaluado por la función,
sino que se pone nuevamente a disposición en la función Callback.
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Copias de seguridad listadas
FALSE
Error
Mensajes de error
Archivos requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Funciones relacionadas
Consulte también
TLG_ENUMBACKUP_ENTRIES (Página 913)
Descripción
Ya no se soporta la función TLGEnumBackupEntries. Para poder evaluar las copias de
seguridad listadas por el sistema debe proporcionar una función Callback del tipo
TLG_ENUMBACKUP_ENTRIES.
Declaración
BOOL ( * TLG_ENUMBACKUP_ENTRIES) (
PTLG_BACKUP_TABLE_INFO lpbti,
PVOID lpUser );
Parámetro
lpbti
Por cada copia de seguridad el sistema reserva memoria con la longitud de la estructura
TLG_BACKUP_TABLE_INFO (Página 814). El puntero lpbti remite al comienzo del primer
elemento.
lpUser
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función Callback.
Valor de retorno
TRUE
La enumeración continúa.
FALSE
La enumeración se cancela.
Observación
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Archivos necesarios
pdertcli.h
pde_glob.h
pdertdef.h
Funciones relacionadas
Consulte también
TLGEnumBackupEntries (Página 912)
TLG_BACKUP_TABLE_INFO (Página 814)
Descripción
Esta función permite exportar partes de un fichero. La selección de los registros a exportar se
realiza con la estructura TLG_IO_BACKUP_SELECT.
Declaración
BOOL TLGExport (
LPTSTR lpszArchivName,
LPTSTR lpszFileName,
PTLG_IO_BACKUP_SELECT lpibs,
DWORD dwJobFlags,
DWORD dwFormatFlags,
PCMN_ERROR lpError );
Parámetro
lpszArchivName
Puntero en el nombre del fichero. Se debe indicar el nombre con la estructura "nombre de
archivo \ nombre de variable".
Con TLGEnumArchivsEx y TLGEnumVariablesEx se pueden determinar los componentes del
nombre.
lpszFileName
Puntero en el nombre del fichero en el que se deben exportar los datos.
lpibs
Dirección de la estructura de entrega TLG_IO_BACKUP_SELECT (Página 826) para los
parámetros de selección.
dwJobFlags
El parámetro está previsto para futuras ampliaciones y se debe asignar con 0L.
dwFormatFlags
Especificador de formato:
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Datos de fichero transferidos
FALSE
Error
Observación
La utilización de esta función únicamente resulta adecuada para ficheros siguientes, ficheros
circulares y ficheros comprimidos.
Mensajes de error
Archivos requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Consulte también
TLG_IO_BACKUP_SELECT (Página 826)
Descripción
El sistema ha dejado de soportar la función, devolviendo ésta el valor FALSE y el código de
error TLG_API_NOT_SUPPORTED.
Declaración
BOOL TLGGetBackupSize (
LPTSTR lpszArchivName,
DWORD* lpdwSizeOfTable,
PTLG_IO_BACKUP_SELECT lpibs,
DWORD dwJobFlags,
DWORD dwFormatFlags,
PCMN_ERROR lpError );
Parámetro
lpszArchivName
Puntero en el nombre del fichero
lpdwSizeOfTable
Dirección de un DWORD, en el cual se escribe el tamaño en bytes de los datos seleccionados.
lpibs
Dirección de la estructura de entrega TLG_IO_BACKUP_SELECT (Página 826) para los
parámetros de selección.
dwJobFlags
Posibles identificadores específicos de petición:
dwFormatFlags
Especificador de formato:
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Tamaño de datos determinado
FALSE
Error
Mensajes de error
Archivos requeridos
pdertcli.h
pde_glob.h
pdertdef.h
pdertcli.lib
pdertcli.dll
Consulte también
TLG_IO_BACKUP_SELECT (Página 826)
Ejemplo
// =====================================================================
// =====================================================================
// : Modul with examples to TagLogging-API
// *********************************************************************
// Copyright (C) 1995/96 SIEMENS AG, AUT 913 All rights reserved
// *********************************************************************
#include "stdafx.h" // if MFC classes
//#include "odkapi.h" // if console application
#include "TL02.h"
#include <string.h>
#include <stdlib.h>
#include <malloc.h>
#include <time.h>
// IMPLEMENTATION
//{{ODK_EXAMPLE}Edit curve template (example no. 1) (TLG)}
//{{FUNCTION}TLGConnect (TLG)}
//{{FUNCTION}TLGDisconnect (TLG)}
//{{FUNCTION}TLGInsertTemplateItem (TLG)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: MyTLGInsertTemplateItem(void) ODK TL RT
// =====================================================================
// : Edit curve template
// : Defines a new curve with previous settings
// =====================================================================
void MyTLGInsertTemplateItem (void)
{
#define COLOR_RED 0x000000FF
// scripts
BOOL ret = FALSE;
CMN_ERROR Error;
TCHAR szText[255];
HWND hwndParent = NULL;
TLG_TEMPLATEITEM_INFO TemplateItem;
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGConnect(hwndParent, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
TLGInsertTemplateItem: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
else
{
memset(&TemplateItem, 0, sizeof(TLG_TEMPLATEITEM_INFO));
_tcsncpy_s(TemplateItem.szArchivName, _countof(TemplateItem.szArchivName),
_T("PLSMWA"), _TRUNCATE); // archive name
_tcsncpy_s(TemplateItem.szTemplateName, _countof(TemplateItem.szTemplateName),
_T("KV_PID1"), _TRUNCATE); // template for curve window
_tcsncpy_s(TemplateItem.szVariableName, _countof(TemplateItem.szVariableName),
_T("VPID1_X"), _TRUNCATE); // DM variable name
_tcsncpy_s(TemplateItem.szDMVariableName, _countof(TemplateItem.szDMVariableName),
_T("VPID1_X"), _TRUNCATE);
_tcsncpy_s(TemplateItem.szTemplateItemName,
_countof(TemplateItem.szTemplateItemName), _T("KPID3_X"), _TRUNCATE); // curve name
TemplateItem.dwTemplateTyp = TLG_TEMPLATE_CURVE;
TemplateItem.dwTemplateItemTyp = TLG_TEMPLATEITEM_CURVE;
TemplateItem.dwReadAccessLevel = 1;
TemplateItem.dwWriteAccessLevel = 1;
TemplateItem.dwArchivTyp = TLG_ARCTYP_PROCESS; //_USER, _PROCESS, _COMPRESS
_tcsncpy_s(TemplateItem.szTimeNameRange, _countof(TemplateItem.szTimeNameRange),
_T("500 ms"), _TRUNCATE);
TemplateItem.fVisible = TRUE;
TemplateItem.tplInfo.tplCurve.csx.dwDataTyp = TLG_DATATYP_TIMERANGE;
TemplateItem.tplInfo.tplCurve.csx.fAutoRange = TRUE;
TemplateItem.tplInfo.tplCurve.csx.fActualize = TRUE;
TemplateItem.tplInfo.tplCurve.csx.dwBufferSize = 10;
TemplateItem.tplInfo.tplCurve.csy.dwDataTyp = TLG_DATATYP_BLOCKDATA;
TemplateItem.tplInfo.tplCurve.csy.fAutoRange = TRUE;
TemplateItem.tplInfo.tplCurve.csy.crColor = COLOR_RED;
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGInsertTemplateItem(TemplateItem.szTemplateName, &TemplateItem, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
TLGInsertTemplateItem: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText,_countof(szText), _TRUNCATE, _T("InsertItem:
TemplateItemName= %s "), TemplateItem.szTemplateItemName);
}
ODKTrace(szText);
// Disconnect
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGDisconnect(&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGDisconnect:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
TLGInsertTemplateItem (Página 899)
TLGConnect (Página 853)
TLGDisconnect (Página 854)
Ejemplo
/ =====================================================================
// =====================================================================
// : Modul with examples to TagLogging-API
// *********************************************************************
// Copyright (C) 1995/96 SIEMENS AG, AUT 913 All rights reserved
// *********************************************************************
#include "stdafx.h" // if MFC classes
#include "stdlib.h"
#include "TL01.h"
#include "dm01.h"
// IMPLEMENTATION
// =====================================================================
// 4. Callback
// =====================================================================
//{{ODK_EXAMPLE}Enum all acquisition and archiving times (TLG)}
//{{FUNCTION}TLGCSConnect (TLG)}
//{{FUNCTION}TLGCSDisConnect (TLG)}
//{{FUNCTION}TLGEnumTime (TLG)}
//{{FUNCTION}TLG_ENUM_TIME_NAME_CALLBACK (TLG)}
//{{FUNCTION}(END)}
// =====================================================================
// Function: TLGEnumTime(void) ODK TL CS
// =====================================================================
// : Enum all acquisition and archiving times
// :
// =====================================================================
BOOL MyTLGEnumTimeNameCallback (LPTSTR szTime, PVOID lpUser)
{
TCHAR szText[255];
sprintf(szText,"...Enum Time %s", szTime);
ODKTrace(szText);
//printf("%s\r\n",szText);
return TRUE;
}
void MyTLGEnumTime(void)
{
// #define PROJ_PATH "C:\\siemens\\odk\\samples\\projects\\demo\\odk.mcp"
BOOL ret = FALSE;
TCHAR szText[255];
HANDLE hProject;
CMN_ERROR Error;
PVOID pUser = NULL;
sprintf(szText, "TLGEnumTime");
ODKTrace(szText);
//printf("%s\r\n",szText);
MyDMEnumOpenedProjects(); // open the DM and set the g_szProjectFile
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGCSConnect(NULL, &Error);
if (FALSE == ret)
{
sprintf(szText, "Error in TLGCSConnect: E1= 0x%08lx ; E2= 0x%08lx ; %s",
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
//printf("%s\r\n",szText);
}
else
{
sprintf(szText, " TLGCSConnect");
ODKTrace(szText);
//printf("%s\r\n",szText);
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGOpenProject(&hProject, /*PROJ_PATH*/g_szProjectFile, NULL, &Error);
if (FALSE == ret)
{
sprintf(szText, "Error in TLGOpenProject: E1= 0x%08lx ; E2= 0x%08lx ; %s",
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
//printf("%s\r\n",szText);
}
else //TLGOpenProject OK
{
sprintf(szText, " TLGOpenProject");
ODKTrace(szText);
//printf("%s\r\n",szText);
// read projected archiving times
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGEnumTime(hProject, MyTLGEnumTimeNameCallback, pUser, &Error);
if (FALSE == ret)
{
sprintf(szText, "Error in TLGEnumTime: E1= 0x%08lx ; E2= 0x%08lx ; %s",
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
sprintf(szText, " TLGEnumTime");
}
ODKTrace(szText);
//printf("%s\r\n",szText);
//TLGCloseProject();
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGCloseProject(hProject, &Error);
if(FALSE == ret)
{
sprintf(szText, "Error in TLGCloseProject: E1= 0x%08lx ; E2= 0x%08lx ; %s",
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
sprintf(szText, " TLGCloseProject");
}
ODKTrace(szText);
//printf("%s\r\n",szText);
}
// Disconnect
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGCSDisConnect(&Error);
if (FALSE == ret)
{
sprintf(szText, "Error in TLGCSDisConnect: E1= 0x%08lx ; E2= 0x%08lx ; %s",
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
sprintf(szText, " TLGCSDisConnect");
}
ODKTrace(szText);
//printf("%s\r\n",szText);
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
TLGCSConnect (Página 848)
TLG_ENUM_TIME_NAME_CALLBACK (Página 906)
TLGEnumTime (Página 905)
TLGDisconnect (Página 854)
TLGCSDisConnect (Página 850)
Ejemplo
void MyTLGEnumArchives(void)
{
// #define PROJ_PATH "C:\\siemens\\odk\\samples\\projects\\demo\\odk.mcp"
BOOL ret = FALSE;
CMN_ERROR Error;
HANDLE hProject;
PVOID pUser = NULL;
TCHAR szText[255];
TCHAR szArchivName[255];
_tcsncpy_s(szArchivName, _countof(szArchivName), _T("PLSMWA"), _TRUNCATE);
MyDMEnumOpenedProjects(); // open the DM and set the g_szProjectFile
//TLGConnect
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGCSConnect(NULL, &Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCSConnect:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
else
{
//TLGOpenProject
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGOpenProject(&hProject, /*PROJ_PATH*/g_szProjectFile, NULL, &Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
TLGOpenProject: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
else
{
// TLGEnumArchives
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGEnumArchives(hProject, MyTLGEnumArchivCallback, pUser, &Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
TLGEnumArchives: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" TLGEnumArchives"));
}
ODKTrace(szText);
}
//CloseProject
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGCloseProject(hProject,&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCloseProject:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" TLGCloseProject"));
}
ODKTrace(szText);
}
// Disconnect
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGCSDisConnect(&Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGCSDisConnect: E1=
0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" TLGCSDisConnect"));
}
ODKTrace(szText);
}
//{{ODK_EXAMPLE}(END)}
Consulte también
TLGCSConnect (Página 848)
TLGOpenProject (Página 857)
TLGCloseProject (Página 856)
TLGEnumArchives (Página 869)
TLG_ENUM_ARCHIV_CALLBACK (Página 870)
TLGCSDisConnect (Página 850)
Ejemplo
void MyTLGEnumVariablesEx(void)
{
BOOL ret = FALSE;
TCHAR szText[255];
CMN_ERROR Error;
HANDLE hProject = NULL;
TCHAR szArchivName[255];
HWND hwndParent = NULL;
VOID* pUser = NULL;
_tcsncpy_s(szArchivName, _countof(szArchivName), _T("PLSMWA"), _TRUNCATE);
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGConnect(hwndParent, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGConnect: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGConnect"));
ODKTrace(szText);
// Info
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGEnumVariablesEx (szArchivName, MyTLGEnumVariablesExCallback,
pUser, &Error );
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
TLGEnumVariablesEx: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGEnumVariablesEx: OK"));
}
ODKTrace(szText);
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGDisconnect(&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGDisconnect:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
TLGOpenProject (Página 857)
TLGEnumVariablesEx (Página 864)
TLG_ENUMVARIABLES (Página 866)
Ejemplo
void MyTLGEnumArchivs(void)
{
BOOL ret = FALSE;
//DWORD StartTime = 0;
//DWORD StopTime = 0;
void* lpUser = NULL;
CMN_ERROR Error;
TCHAR szText[255];
HWND hwndParent = NULL;
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGConnect(hwndParent, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGConnect: E1= 0x
%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGConnect"));
ODKTrace(szText);
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGEnumArchivs(TLG_ARCTYP_PROCESS, MyTLGEnumTablesCallback, lpUser, &Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGEnumArchivs:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGEnumArchivs: OK"));
}
ODKTrace(szText);
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGDisconnect(&Error);
if(FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGDisconnect:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
}
}
//{{ODK_EXAMPLE}(END)}
Consulte también
TLGConnect (Página 853)
TLGDisconnect (Página 854)
TLGEnumArchivs (Página 871)
Ejemplo
{
// read
memset(&TLGArchivStruct,0,sizeof(TLG_ARCHIV_STR));
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGReadArchiv(hProject, szArchivName, &TLGArchivStruct, &Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in TLGReadArchiv:
E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGReadArchiv"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" ArcName=%s Comments=
%s dwTyp=0x%04x dwRecSize=%d"),
TLGArchivStruct.szName,
TLGArchivStruct.szComment,
TLGArchivStruct.dwTyp,
TLGArchivStruct.dwRecordSize);
ODKTrace(szText);
}
memset(&TLGVarStruct, 0, sizeof(TLG_VAR_STR));
memset(&Error,0,sizeof(CMN_ERROR));
ret = TLGReadVariable(hProject, szArchivName, szVarName, &TLGVarStruct, &Error);
if (FALSE == ret)
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("Error in
TLGReadVariable: E1= 0x%08lx ; E2= 0x%08lx ; %s"),
Error.dwError1, Error.dwError2, Error.szErrorText);
ODKTrace(szText);
}
else
{
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T("TLGReadVariable"));
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" szVarName=%s"),
TLGVarStruct.szVarName);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" szProcName=%s"),
TLGVarStruct.szProcName);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" dwVarType=0x%04X"),
TLGVarStruct.dwVarType);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" dwArchivStyle=0x
%04X"), TLGVarStruct.dwArchivStyle);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" szWriteBackTo=%s"),
TLGVarStruct.szWriteBackTo);
ODKTrace(szText);
_sntprintf_s(szText, _countof(szText), _TRUNCATE, _T(" dwSupply=0x%04X"),
TLGVarStruct.dwSupply);
ODKTrace(szText);
//{{ODK_EXAMPLE}(END)}
Consulte también
TLGOpenProject (Página 857)
TLGCloseProject (Página 856)
TLGCSConnect (Página 848)
TLGReadVariable (Página 867)
TLGReadArchiv (Página 895)
TLGCSDisConnect (Página 850)
Ejemplo
Consulte también
TLGOpenProject (Página 857)
TLGCloseProject (Página 856)
TLGCSConnect (Página 848)
TLGReadTime (Página 910)
TLGCSDisConnect (Página 850)
Sinopsis
Consulte también
uaUsers (Página 949)
Introducción
Los ficheros de usuario son tablas individuales recogidas en la base de datos, que, con
excepción de la primera columna, tienen una estructura completamente libre. Los tipos de
datos están limitados a campos char, double, int y DateTime.
Las funciones Get y Set trabajan en un registro hRecord interno, que puede escribirse en el
fichero con Insert y Update.
Si el fichero de usuario se modifica directamente desde la base de datos (ODBC/ SQL), no
se realiza una sincronización online.
UAArchiveGetSort
UAArchiveImport
UAArchiveInsert
UAArchiveMoveFirst
UAArchiveMoveLast
UAArchiveMoveNext
UAArchiveMovePrevious
UAArchiveReadTagValues
UAArchiveReadTagValuesByNa‐
me
UAArchiveRequery
UAArchiveSetFieldValueDate
UAArchiveSetFieldValueDouble
UAArchiveSetFieldValueFloat
UAArchiveSetFieldValueLong
UAArchiveSetFieldValueString
UAArchiveSetFilter
UAArchiveSetSort
UAArchiveUpdate
UAArchiveWriteTagValues
UAArchiveWriteTagValuesByName
<--- UAArchiveClose
<--- UAReleaseAr‐
chive
<--- UADisconnect
Sinopsis
Los siguientes mensajes de error pueden consultarse con la función API UAGetLastError.
Constantes de configuración:
Tipos de ficheros
Flags de fichero
Tipos de comunicación
Tipos de campos
Flags de campo
Longitudes máximas
Constantes de parámetros:
Acciones
UA_ACTION_GENERIC 0 Configuración
UA_ACTION_INSERT 1 Pegar
UA_ACTION_UPDATE 2 Sincronizar/sobrescribir
UA_ACTION_DELETE 3 Borrar
Valores Move
Descripción
Muchas funciones se basan en un valor booleano. TRUE significa un procesamiento de la
función sin errores. Cuando se retorna el valor FALSE, puede leerse el error de la última
función utilizada con la función uaGetLastError.
uaGetLastError entrega siempre el último error producido. En caso de saber exactamente en
cual función se ha producido un error, debe evaluarse el retorno después de cada llamada de
una función y llamarse en caso necesario uaGetLastError.
Valor de retorno
Estado de fallo de la última función que se ha ejecutado. Las constantes de error y los
Predefines se encuentran predefinidos en CCUACAPI.H.
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Descripción
Comprueba si se utiliza una receta en un Runtime activado.
Declaración
BOOL uaIsActive (
UAHCONNECT hConnect )
Parámetros
hConnect
Handle para receta en Runtime. Este handle se establece con uaConnect.
Valor de retorno
TRUE
Receta se utiliza en Runtime activado.
FALSE
Receta no se utiliza en Runtime activado.
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaConnect (Página 951)
Descripción
Lista del número de todos los usuarios que están conectados con la receta a través de
uaConnect. Junta a las llamadas por el usuario, p. ej., mediante scripts, se consideran aquí
también las llamadas internas de WinCC.
Declaración
LONG uaUsers (
UAHCONNECT hConnect )
Parámetros
hConnect
Handle para receta en Runtime. Este handle se establece con uaConnect.
Valor de retorno
Número de conexiones activas
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaConnect (Página 951)
Descripción
Coloca eventos locales.
Declaración
void uaSetLocalEvents (
UAHCONNECT hConnect
BOOL bLocalEvents )
Parámetros
hConnect
Handle para receta en Runtime. Este handle se establece con uaConnect.
bLocalEvents
Evento local
Valor de retorno
Sin valor de retorno
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaConnect (Página 951)
Descripción
Establece en Runtime la conexión con una receta.
Declaración
BOOL uaConnect (
UAHCONNECT* phConnect )
Parámetros
phConnect
Puntero sobre el handle de la receta.
Valor de retorno
TRUE
Conexión establecida con la receta
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Observaciones
El handle suministrado es necesario para las funciones uaDisconnect, uaIsActive, uaUsers,
uaOpenViews, uaOpenArchives, uaQueryArchive y uaQueryArchiveByName.
Funciones relacionadas
Consulte también
uaIsActive (Página 948)
uaUsers (Página 949)
uaSetLocalEvents (Página 950)
uaDisconnect (Página 952)
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
uaOpenArchives (Página 974)
uaOpenViews (Página 1002)
Sinopsis de las funciones (Página 938)
Descripción
Cuando en Runtime existe una conexión con una receta, se interrumpe la conexión.
Declaración
BOOL uaDisconnect (
UAHCONNECT hConnect )
Parámetros
hConnect
Handle para receta en Runtime. Este handle se establece con uaConnect.
Valor de retorno
TRUE
Conexión interrumpida.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaConnect (Página 951)
Sinopsis de las funciones (Página 938)
Descripción
Establece la conexión con una receta. uaQueryArchive crea el handle phArchive.
Declaración
BOOL uaQueryArchive (
UAHCONNECT hConnect,
LONG lArchive,
UAHARCHIVE* phArchive )
Parámetros
hConnect
Handle para receta en Runtime. Este handle se establece con uaConnect.
lArchive
ID del fichero que debe conectarse.
phArchive
Puntero sobre el handle de la receta conectada.
Valor de retorno
TRUE
Conexión establecida.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Observaciones
Si solo hay disponible un índice de ficheros, la ID del fichero puede determinarse con la función
de configuración uaGetArchive.
Funciones relacionadas
Consulte también
uaConnect (Página 951)
uaReleaseArchive (Página 958)
uaArchiveClose (Página 961)
uaArchiveDelete (Página 962)
uaArchiveExport (Página 963)
uaArchiveGetID (Página 965)
uaArchiveGetName (Página 966)
uaArchiveGetSort (Página 967)
uaArchiveImport (Página 968)
uaArchiveOpen (Página 969)
uaArchiveUpdate (Página 971)
uaArchiveGetCount (Página 975)
uaArchiveGetFilter (Página 976)
uaArchiveInsert (Página 977)
uaArchiveMoveFirst (Página 978)
uaArchiveMoveLast (Página 979)
uaArchiveMoveNext (Página 980)
uaArchiveMovePrevious (Página 981)
uaArchiveGetFieldLength (Página 983)
Descripción
Establece la conexión con una receta a través del nombre. uaQueryArchiveByName crea el
handle phArchive.
Declaración
BOOL uaQueryArchiveByName (
UAHCONNECT hConnect,
LPCSTR pszName,
UAHARCHIVE* phArchive )
Parámetros
hConnect
Handle para receta en Runtime. Este handle se establece con uaConnect.
pszName
Nombre de la receta.
phArchive
Puntero sobre el handle de la receta conectada.
Valor de retorno
TRUE
Conexión establecida.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Observaciones
Si solo hay disponible un índice de ficheros, el nombre del fichero puede determinarse con la
función de configuración uaGetArchive.
Funciones relacionadas
Consulte también
uaConnect (Página 951)
uaReleaseArchive (Página 958)
uaArchiveClose (Página 961)
uaArchiveDelete (Página 962)
uaArchiveExport (Página 963)
uaArchiveGetID (Página 965)
uaArchiveGetName (Página 966)
uaArchiveGetSort (Página 967)
uaArchiveImport (Página 968)
uaArchiveOpen (Página 969)
Descripción
Establece la conexión con una receta para la configuración.
Declaración
BOOL uaQueryConfiguration (
UAHCONFIG* phConfig )
Parámetros
phConfig
Puntero sobre el handle de la receta.
Valor de retorno
TRUE
Conexión establecida.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Consulte también
uaReleaseConfiguration (Página 960)
uaGetArchive (Página 972)
uaGetNumArchives (Página 973)
uaGetNumFields (Página 982)
uaGetField (Página 997)
Sinopsis de las funciones (Página 938)
Descripción
Establece la conexión con la receta actualmente conectada.
Declaración
BOOL uaReleaseArchive (
UAHARCHIVE hArchive )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
TRUE
Conexión interrumpida.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Observación
En la interrupción exitosa de la conexión debe aplicarse el handle hArchive en NULL. En caso
de una utilización posterior del handle que ya no está válido, se genera el error
UA_ERROR_INVALID_HANDLE. Se evita una carga innecesaria de la memoria.
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Interrumpe la conexión después de la configuración de la receta.
Declaración
BOOL uaReleaseConfiguration (
UAHCONFIG hConfig,
BOOL bSave )
Parámetros
hConfig
Handle sobre la receta. Este handle se establece con uaQueryConfiguration.
bSave
Determina que las modificaciones en la configuración se guardan antes de interrumpir la
conexión.
Nota
¡bSave = TRUE se debe usar solamente cuando la receta no se utiliza en un WinCC Runtime
activado! Con la función uaIsActive se comprueba si Runtime está activo.
Valor de retorno
TRUE
Conexión interrumpida.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryConfiguration (Página 957)
Sinopsis de las funciones (Página 938)
Descripción
Cierra una receta abierta.
Declaración
BOOL uaArchiveClose (
UAHARCHIVE hArchive )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
TRUE
Receta cerrada.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
uaArchiveOpen (Página 969)
Sinopsis de las funciones (Página 938)
Descripción
Borra los datos de una receta. La receta proyectada se conserva.
Declaración
BOOL uaArchiveDelete (
UAHARCHIVE hArchive,
LPCSTR pszWhere )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
pszWhere
String con selección SQL de los registros de datos a borrar. El string corresponde a la
instrucción SQL DELETE FROM <archive> WHERE pszWhere.
Nota
Cuando pszWhere está vacío, se borra todo el fichero de usuario.
Valor de retorno
TRUE
Datos borrados.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Exporta los datos de una receta en un archivo CSV.
Declaración
BOOL uaArchiveExport (
UAHARCHIVE hArchive,
LPCSTR pszDestination,
LONG lType,
LONG lOptions )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
pszDestination
Nombre del archivo de destino. En caso de llamada de la función en un cliente, la indicación
de ruta se refiere al servidor.
lType
Formato de nombre del archivo de destino. Los dos formatos disponibles son:
lOptions
El parámetro está reservado para extensiones posteriores y debe predeterminarse con 0.
Valor de retorno
TRUE
Datos exportados.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaArchiveImport (Página 968)
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Lee el ID de una receta
Valor de retorno
"ID" del fichero de usuario
Declaración
LONG uaArchiveGetID (
UAHARCHIVE hArchive )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
ID de la receta
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Lee el nombre de una receta.
Declaración
VOID uaArchiveGetName (
UAHARCHIVE hArchive,
LPSTR pszName,
LONG cMaxLen )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
pszName
Puntero sobre el búfer para el nombre de la receta.
cMaxLen
Longitud máxima.
Valor de retorno
Sin valor de retorno.
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Ejemplo
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Lee el criterio de clasificación de la receta.
Declaración
VOID uaArchiveGetSort (
UAHARCHIVE hArchive,
LPSTR pszSort,
LONG cMaxLen )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
pszSort
Criterio de clasificación como instrucción SQL.
cMaxLen
Longitud máxima.
Valor de retorno
Sin valor de retorno
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Importa los datos de un archivo CSV en una receta. La estructura de la receta debe ser idéntica
al fichero CSV importado.
Declaración
BOOL uaArchiveImport (
UAHARCHIVE hArchive,
LPCSTR pszSource,
LONG lType,
LONG lOptions )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
pszSource
Nombre del archivo con los datos a importar.
lType
Formato de datos del archivo de origen. Los dos formatos disponibles son:
lOptions
El parámetro está reservado para extensiones posteriores y debe predeterminarse con 0.
Valor de retorno
TRUE
Datos importados.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaArchiveExport (Página 963)
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Abre una receta. La llamada de uaArchiveOpen se requiere para las operaciones de lectura
o escritura en la receta. Por ejemplo para la llamada de las funciones uaArchiveMoveNext,
uaArchiveDelete o uaArchiveUpdate.
Declaración
BOOL uaArchiveOpen (
UAHARCHIVE hArchive )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
TRUE
Receta abierta.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaArchiveClose (Página 961)
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Actualiza una receta abierta. Los datos de receta modificados se adoptan en la base de datos.
La estructura de la receta permanece inalterada.
Declaración
BOOL uaArchiveUpdate (
U AHARCHIVE hArchive )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
TRUE
Datos de receta actualizados.
FALSE
En caso de una violación de consistencia se presenta el error Update_failed = 106. Una
violación de consistencia surge p. ej. cuando para un campo se ha activado la propiedad
"Campo debe poseer un valor", pero no se encuentra un valor en el campo.
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Lee la configuración de una receta.
Declaración
BOOL uaGetArchive (
UAHCONFIG hConfig,
Long lArchive,
UACONFIGARCHIVE* pArchive )
Parámetros
hArchive
Handle sobre la receta. Este handle se establece con uaQueryConfiguration.
lArchive
Índice de la receta. Valor: 0... uaGetNumArchives() -1
pArchive
Puntero sobre el búfer para los datos de configuración.
Valor de retorno
TRUE
Acceso exitoso.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryConfiguration (Página 957)
Sinopsis de las funciones (Página 938)
Descripción
Lee el número de las recetas actualmente configuradas.
Declaración
LONG uaGetNumArchives (
UAHCONFIG hConfig )
Parámetros
hConfig
Handle sobre la receta. Este handle se establece con uaQueryConfiguration.
Valor de retorno
Número de recetas configuradas. En caso de un error se retorna -1.
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryConfiguration (Página 957)
Sinopsis de las funciones (Página 938)
Descripción
Determina el número de las recetas abiertas en Runtime.
Declaración
LONG uaOpenArchives (
UAHCONNECT hConnect )
Parámetros
hArchive
Handle sobre la receta. Este handle se establece con uaConnect.
Valor de retorno
Número de recetas abiertas.
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaConnect (Página 951)
Sinopsis de las funciones (Página 938)
Descripción
Lee la cantidad de registros de datos.
Valor de retorno
Cantidad de registros de datos. Con "0", el fichero está vacío o se ha producido un error. Con
consulta se requiere con "uaGetLastError".
Declaración
LONG uaArchiveGetCount(
UAHARCHIVE hArchive,
LONG * plCount )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
plCount
Puntero sobre una variable, en el cual se deposita el número de registros de datos.
Valor de retorno
Cantidad de registros de datos. Con 0, el fichero está vacío o se ha producido un error. La
consulta debe realizarse con uaGetLastError.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Lee los criterios de selección del registro actual de datos.
Declaración
VOID uaArchiveGetFilter (
UAHARCHIVE hArchive,
LPSTR pszFilter,
LONG cMaxLen )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
pszFilter
Criterio de selección como instrucción SQL.
cMaxLen
Longitud máxima.
Valor de retorno
Sin valor de retorno.
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Añade el búfer local de registro de datos a la receta. Para que en el registro de datos se
encuentren datos apropiados, antes de acceder a uaArchiveInsert, se tienen que escribir los
campos del búfer local de registro de datos con las funciones uaArchiveSetFieldValue....
El campo "ID" debe escribirse con la función uaArchiveSetFieldValueLong con un ID todavía
no existente en el fichero o bien con 0."
Declaración
BOOL uaArchiveInsert (
UAHARCHIVE hArchive )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
TRUE
Registro de datos añadido.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Va al primer registro.
Declaración
BOOL uaArchiveMoveFirst (
UAHARCHIVE hArchive )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
TRUE
Salto exitoso.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Va al último registro.
Declaración
BOOL uaArchiveMoveLast (
UAHARCHIVE hArchive )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
TRUE
Salto exitoso.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Ir al siguiente registro de datos.
Declaración
BOOL uaArchiveMoveNext (
UAHARCHIVE hArchive )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
TRUE
Salto exitoso.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Ir al registro de datos anterior.
Declaración
BOOL uaArchiveMovePrevious (
UAHARCHIVE hArchive )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
TRUE
Salto exitoso.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Lista del número de campos configurados. Los campos "ID", "Último usuario" y "Último acceso"
no se cuentan. En los accesos de configuración se indican los índices con
"0 … uaGetNumFields() -1".
Declaración
LONG uaGetNumFields (
UAHCONFIG honfig,
long lArchive )
Parámetros
hConfig
Handle sobre la receta. Este handle se establece con uaQueryConfiguration.
lArchive
Índice de la receta. Valor: 0... uaGetNumArchives() -1
Valor de retorno
Cantidad de campos configurados. En caso de un error se retorna -1.
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryConfiguration (Página 957)
Sinopsis de las funciones (Página 938)
Descripción
Lee la longitud de un campo en el registro de datos actual.
Declaración
LONG uaArchiveGetFieldLength(
UAHARCHIVE hArchive,
LONG lField )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
lField
El número de campo, donde iField = 1 es el primer campo direccionado configurado. Con
lField = 0 se direcciona el campo "ID".
Valor de retorno
Longitud del campo actual.
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Lee el nombre de un campo en el registro de datos actual.
Declaración
VOID uaArchiveGetFieldName (
UAHARCHIVE hArchive,
LONG lField,
LPCSTR pszName,
LONG cMaxLen )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
lField
El número de campo, donde iField = 1 es el primer campo direccionado configurado. Con
lField = 0 se direcciona el campo "ID".
pszName
Nombre de campo
cMaxLen
Longitud máxima
Valor de retorno
TRUE
Nombre leído.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Lee la cantidad de registros de datos configurados. Los campos "ID", "Último usuario" y "Último
acceso" se cuentan. En los accesos de Runtime se indican los índices de los campos
configurados con 1 ... N. El campo "ID" tiene el índice "0". Los campos "Último usuario" y
"Último acceso" se añaden al final de los campos configurados.
Declaración
LONG uaArchiveGetFields (
UAHARCHIVE hArchive )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
Cantidad de campos configurados.
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Lee el tipo de un campo en el registro de datos actual.
Declaración
LONG uaArchiveGetFieldType (
UAHARCHIVE hArchive,
LONG lField )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
lField
El número de campo, donde iField = 1 es el primer campo direccionado configurado. Con
lField = 0 se direcciona el campo "ID".
Valor de retorno
Tipo del campo actual. Las denominaciones simbólicas para los tipos de campo son:
UA_FIELDTYPE_INTEGER
UA_FIELDTYPE_FLOAT
UA_FIELDTYPE_DOUBLE
UA_FIELDTYPE_STRING
UA_FIELDTYPE_DATETIME
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Lee la fecha y la hora de un campo en el registro de datos actual.
Declaración
BOOL uaArchiveGetFieldValueDate (
UAHARCHIVE hArchive,
LONG lField,
LPSYSTEMTIME pstDateTime )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
lField
El número de campo, donde iField = 1 es el primer campo direccionado configurado. Con
lField = 0 se direcciona el campo "ID".
pstDateTime
Puntero sobre la variable del tipo SYSTEMTIME.
Valor de retorno
TRUE
Fecha y hora leídas.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Lee un valor del tipo de datos Double de un campo del registro actual de datos.
Declaración
BOOL uaArchiveGetFieldValueDouble (
UAHARCHIVE hArchive,
LONG lField,
double* pdValue )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
lField
El número de campo, donde iField = 1 es el primer campo direccionado configurado. Con
lField = 0 se direcciona el campo "ID".
pdValue
Puntero sobre la variable para el valor del campo.
Valor de retorno
TRUE
Valor leído.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Lee un valor del tipo de datos Long de un campo del registro actual de datos.
Declaración
BOOL uaArchiveGetFieldValueLong (
UAHARCHIVE hArchive,
LONG lField,
LONG* pdValue )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
lField
El número de campo, donde iField = 1 es el primer campo direccionado configurado. Con
lField = 0 se direcciona el campo "ID".
pdValue
Puntero sobre la variable para el valor del campo.
Valor de retorno
TRUE
Valor leído.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Lee un valor del tipo de datos String de un campo del registro actual de datos.
Declaración
BOOL uaArchiveGetFieldValueString (
UAHARCHIVE hArchive,
LONG lField,
LPSTR pszString,
LONG cMaxLen )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
lField
El número de campo, donde iField = 1 es el primer campo direccionado configurado. Con
lField = 0 se direcciona el campo "ID".
pszString
Puntero sobre la variable para el valor del campo.
pdValue
Longitud máxima del string.
Valor de retorno
TRUE
Valor leído.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Escribe la fecha y la hora en un campo en el registro de datos actual.
Declaración
BOOL uaArchiveSetFieldValueDate (
UAHARCHIVE hArchive,
LONG lField,
LPSYSTEMTIME pstDateTime )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
lField
El número de campo, donde iField = 1 es el primer campo direccionado configurado. Con
lField = 0 se direcciona el campo "ID".
pstDateTime
Fecha y hora.
Valor de retorno
TRUE
Valor escrito.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Escribe un valor del tipo de datos Double en un campo en el registro actual de datos.
Declaración
BOOL uaArchiveSetFieldValueDouble (
UAHARCHIVE hArchive,
LONG lField,
double dValue )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
lField
El número de campo, donde iField = 1 es el primer campo direccionado configurado. Con
lField = 0 se direcciona el campo "ID".
dValue
Valor que se va a escribir.
Valor de retorno
TRUE
Valor escrito.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Escribe un valor del tipo de datos Long en un campo en el registro actual de datos.
Declaración
BOOL uaArchiveSetFieldValueLong (
UAHARCHIVE hArchive,
LONG lField,
LONG dValue )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
lField
El número de campo, donde iField = 1 es el primer campo direccionado configurado. Con
lField = 0 se direcciona el campo "ID".
dValue
Valor que se va a escribir.
Valor de retorno
TRUE
Valor escrito.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Escribe un valor del tipo de datos String en un campo en el registro actual de datos.
Declaración
BOOL uaArchiveSetFieldValueString (
UAHARCHIVE hArchive,
LONG lField,
LPCSTR pszString )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
lField
El número de campo, donde iField = 1 es el primer campo direccionado configurado. Con
lField = 0 se direcciona el campo "ID".
pszString
Cadena de caracteres que se va a escribir.
Valor de retorno
TRUE
Valor escrito.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Lee la configuración de un campo.
Declaración
BOOL uaGetField (
UAHCONFIG hConfig,
Long lArchive,
Long lField,
UACONFIGFIELD* pField )
Parámetros
hConfig
Handle sobre la receta. Este handle se establece con uaQueryConfiguration.
lArchive
Índice de la receta. Valor: 0... uaGetNumArchives() -1
lField
El número de campo, donde iField = 1 es el primer campo direccionado configurado. Con
lField = 0 se direcciona el campo "ID".
pField
Puntero sobre el búfer para los datos de configuración.
Valor de retorno
TRUE
Configuración leída.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryConfiguration (Página 957)
Sinopsis de las funciones (Página 938)
Descripción
Después de la llamada de uaArchiveSetFilter y uaArchiveSetSort debe cargarse la receta con
uaArchiveRequery.
Nota
Las funciones uaArchiveSetSort y uaArchiveSetFilter pueden usarse sin abrir la receta con
uaArchiveOpen. En este caso no debe acceder a uaArchiveRequery.
Declaración
BOOL uaArchiveRequery(
UAHARCHIVE hArchive )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
Valor de retorno
TRUE
Receta nuevamente cargada.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Observación
Accede también a uaArchiveRequery cuando ha ingresado vlaores en la indicación de receta
en Runtime.
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Configura los criterios de selección para la receta. Las funciones pueden accederse también
sin abrir la receta con uaArchiveOpen.
Cuando ha abierto el fichero de usuario con uaArchiveOpen, debe cargar la receta
nuevamente con uaArchiveRequery después de la filtración.
Declaración
VOID uaArchiveSetFilter (
UAHARCHIVE hArchive,
LPSTR pszFilter )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
pszFilter
Criterio de selección como criterio SQL.
Valor de retorno
TRUE
Criterios de selección modificados.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Configura la clasificación de una receta. Las funciones pueden accederse también sin abrir
la receta con uaArchiveOpen.
Cuando ha abierto una receta con uaArchiveOpen, debe cargar la receta nuevamente con
uaArchiveRequery después de la clasificación.
Declaración
BOOL uaArchiveSetSort (
UAHARCHIVE hArchive,
LPSTR pszSort )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
pszSort
Criterio de clasificación como instrucción SQL.
Valor de retorno
TRUE
Clasificación exitosa.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
Sinopsis de las funciones (Página 938)
Descripción
Entrega el número de vistas abiertas en Runtime.
Declaración
LONG uaOpenViews (
UAHCONNECT hConnect )
Parámetros
hArchive
Handle sobre la receta. Este handle se establece con uaConnect.
Valor de retorno
Número de vistas actualmente abiertas.
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaConnect (Página 951)
Sinopsis de las funciones (Página 938)
Descripción
Lee los valores actuales de las variables de campos.
Declaración
BOOL uaArchiveReadTagValues (
UAHARCHIVE hArchive,
LONG* pnFields,
LONG cFields,
LONG lOptions )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
pnFields
El parámetro está reservado para extensiones posteriores y debe predeterminarse con 0.
cFields
El parámetro está reservado para extensiones posteriores y debe predeterminarse con 0.
lOptions
El parámetro está reservado para extensiones posteriores y debe predeterminarse con 0.
Valor de retorno
TRUE
Datos leídos.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
uaArchiveWriteTagValues (Página 1005)
Sinopsis de las funciones (Página 938)
Descripción
Lee los valores actuales de las variables.
Declaración
BOOL uaArchiveReadTagValuesByName (
UAHARCHIVE hArchive,
LPCSTR pszFields,
LONG lOptions )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
pszFields
El parámetro está reservado para extensiones posteriores y debe predeterminarse con NULL.
lOptions
El parámetro está reservado para extensiones posteriores y debe predeterminarse con 0.
Valor de retorno
TRUE
Datos leídos.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
uaArchiveWriteTagValuesByName (Página 1007)
Sinopsis de las funciones (Página 938)
Descripción
Escribe los valores del registro de datos actual en la variable.
Declaración
BOOL uaArchiveWriteTagValues (
UAHARCHIVE hArchive,
LONG* pnFields,
LONG cFields,
LONG lOptions )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
pnFields
El parámetro está reservado para extensiones posteriores y debe predeterminarse con 0.
cFields
El parámetro está reservado para extensiones posteriores y debe predeterminarse con 0.
lOptions
El parámetro está reservado para extensiones posteriores y debe predeterminarse con 0.
Valor de retorno
TRUE
Escribir datos.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
uaArchiveReadTagValues (Página 1003)
Sinopsis de las funciones (Página 938)
Descripción
Escribe los valores del registro de datos actual en la variable.
Declaración
BOOL uaArchiveWriteTagValuesByName (
UAHARCHIVE hArchive,
LPCSTR pszFields,
LONG lOptions )
Parámetros
hArchive
Handle sobre la receta. Este handle se crea con uaQueryArchive o uaQueryArchiveByName.
pszFields
El parámetro está reservado para extensiones posteriores y debe predeterminarse con NULL.
lOptions
El parámetro está reservado para extensiones posteriores y debe predeterminarse con 0.
Valor de retorno
TRUE
Escribir datos.
FALSE
Error
Archivos requeridos
ccuacapi.h
ccuacapi.lib
ccuacapi.dll
Funciones relacionadas
Consulte también
uaQueryArchive (Página 953)
uaQueryArchiveByName (Página 955)
uaArchiveReadTagValuesByName (Página 1004)
Sinopsis de las funciones (Página 938)
Sinopsis
Consulte también
MSRTEnumMsgRTDataPlus (Página 1074)
MSRTLockGroupPlus (Página 1093)
Sinopsis
Sinopsis
Las funciones API pueden devolver los siguientes mensajes de error en la estructura de error
CMN_ERROR:
Alarm Logging CS
Alarm Logging RT
Especificaciones generales
Estados de aviso
Autómatas finitos
Avisos de grupo
Avisos individuales
Categorías de avisos
Bloques de aviso
En HIWORD está el tipo principal de los bloques de aviso. LOWORD contiene los subtipos
de los bloques de avisos.
Formato de fecha
Formato de hora
Opciones de ventana
Criterios de filtro
Selección rápida
El momento final de la selección rápida se refiere a la hora actual del sistema del equipo local.
El momento de inicio es n * (meses, días, horas de retroceso).
Tipos de fichero
Flags de ficheros
ID de bloqueo de avisos
ID de informes
Declaración
typedef struct {
DWORD dwMsgState;
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
DWORD dwFlags;
SYSTEMTIME stMsgTime;
double dPValue[MSG_MAX_PVALUE];
WORD wPValueUsed;
MSG_TEXTVAL256_STRUCT_PLUS mtTextValueW[MSG_MAX_PVALUE]
WORD wTextValueUsed;
}
MSG_RTCREATE_STRUCT_PLUS;
Members
dwMsgState
Estado del aviso en función de las constantes en el archivo "m_global.h":
dwMsgNrLow
dwMsgNrLow Número del primer aviso
dwMsgNrHigh
dwMsgHigh Número del último aviso.
dwFlags
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
stMsgTime
Fecha y hora para visualización y ocultación de aviso. En el acuso se utiliza el tiempo de
sistema del PLC o del OS.
Si se requiere una hora actual para transferir un parámetro SYSTEMTIME, se debe utilizar la
función GetLocalTime y no GetSystemTime. Normalmente existe una diferencia de tiempo
considerable entre estas dos funciones.
dPValue
Valores numéricos de proceso.
wPValueUsed
Valores utilizados de proceso en representación bitcodificada.
Cada bit debe activarse solamente en uno de los dos member wPValueUsed o
wTextValueUsed, ya que técnicamente un valor acompañante puede ser solamente un
número o texto. En caso de un suministro doble erróneo se trata dPValue prioritariamente.
mtTextValue
Estructura del tipo MSG_TEXTVAL256_STRUCT_PLUS (Página 1048) con los valores
asociados al texto.
wTextValueUsed
Valores de texto utilizados de proceso en representación bitcodificada.
Cada bit debe activarse solamente en uno de los dos member wPValueUsed o
wTextValueUsed, ya que técnicamente un valor acompañante puede ser solamente un
número o texto. En caso de un suministro doble erróneo se trata dPValue prioritariamente.
Observación
Antes de llenar la estructura, ésta debe inicializarse con "0" .
Archivos necesarios
CCMSRTCLIPlus.h
Funciones API
Consulte también
MSG_TEXTVAL256_STRUCT_PLUS (Página 1048)
Sinopsis de las estructuras (Página 1009)
Declaración
typedef struct {
DWORD dwMsgState;
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
SYSTEMTIME stMsgTime;
DWORD dwTimeDiff;
DWORD dwCounter;
DWORD dwFlags;
WORD wPValueUsed;
WORD wTextValueUsed;
double dPValue[MSG_MAX_PVALUE];
MSG_TEXTVAL256_STRUCT_PLUS mtTextValue[MSG_MAX_PVALUE];
WCHAR szInstance[MSG_MAX_INSTANCE+1];
WCHAR szComment[MSG_MAX_TB_CONTENT+1];
WCHAR szUser[MSG_MAX_USERNAME+1];
WCHAR szComputerName[MAX_COMPUTERNAME_LENGTH+1];
WCHAR szApplicationName[MSG_MAX_APPLNAME+1];
WCHAR szServerPrefix[_MAX_PATH+1];
}
MSG_RTDATA_INSTANCECOMMENT_STRUCTPlus;
Members
dwMsgState
Estado del aviso en función de las constantes en el archivo "m_global.h":
Los estados listados se utilizan sólo internamente por el sistema y pueden activarse
exclusivamente por API con MSRTCreateMsgInstanceWithCommentPlus.
dwMsgNrLow
dwMsgNrLow Número del primer aviso
dwMsgNrHigh
dwMsgHigh Número del último aviso.
stMsgTime
Fecha y hora para visualización y ocultación de aviso.
dwTimeDiff
Duración de tiempo de visualización o ocultación, tiempo de telegrama en segundos.
dwCounter
Contador de avisos interno.
dwFlags
Flags en función de las constantes en el archivo "m_global.h":
wPValueUsed
Valores utilizados de proceso en representación bitcodificada.
Cada bit debe activarse solamente en uno de los dos member wPValueUsed o
wTextValueUsed, ya que técnicamente un valor acompañante puede ser solamente un
número o texto. En caso de un suministro doble erróneo se trata dPValue prioritariamente.
wTextValueUsed
Valores de texto utilizados, bitcodificados.
Cada bit debe activarse solamente en uno de los dos member wPValueUsed o
wTextValueUsed, ya que técnicamente un valor acompañante puede ser solamente un
número o texto.
En caso de un suministro doble erróneo se trata dPValue prioritariamente.
dPValue
Valores de proceso.
mtTextValue
Estructura del tipo MSG_TEXTVAL256_STRUCT_PLUS (Página 1048) con los valores
asociados al texto.
szInstance
Nombre de instancia. Cuando no se suministra szInstance (string vacío), se crea un aviso
normal
szComment
Nombre de comentario
szUser
Nombre de usuario.
szComputerName
Nombre de ordenador.
szApplicationName
Nombre de aplicación.
szServerPrefix
Prefijo de servidor.
Observación
Antes de llenar la estructura, ésta debe inicializarse con "0" .
Archivos necesarios
CCMSRTCLIPlus.h
Funciones API
Consulte también
MSRTCreateMsgInstanceWithCommentPlus (Página 1066)
MSRTGetLastMsgWithCommentPlus (Página 1077)
MSG_SERVICE_NOTIFY_PROCPlus (Página 1057)
MSRTGetSelectedMsgPlus (Página 1086)
MSRTCheckWinFilterPlus (Página 1097)
Sinopsis de las estructuras (Página 1009)
Declaración
typedef struct {
WCHAR szFilterName[MSG_MAX_TEXTLEN+1];
DWORD dwFilter;
SYSTEMTIME st[2];
DWORD dwMsgNrLow[2];
DWORD dwMsgNrHigh[2];
VARIANT vMsgClasses;
DWORD dwMsgState;
WORD wAGNr[2];
WORD wAGSubNr[2];
DWORD dwArchivMode;
WCHAR szTB[MSG_MAX_TB][MSG_MAX_TB_CONTENT+1]
DWORD dwTB;
double dPValue[MSG_MAX_PVALUE][2];
DWORD dwPValue[2];
ULONGLONG uMsgCounter[2];
DWORD dwQuickSelect;
DWORD dwPriority[2];
WCHAR szInstance[MSG_MAX_INSTANCE+1];
}
MSG_FILTER_STRUCT_PLUS;
Members
szFilterName
Nombre del filtro
dwFilter
Las condiciones de filtración se determinan con las siguientes constantes del archivo
"m_global.h":
st
st[0] Fecha y hora del momento de inicio, st[1] fecha y hora del momento final
Usted debe asignar st cuando utiliza los criterios de filtro MSG_FILTER_DATE,
MSG_FILTER_DATE_FROM, MSG_FILTER_DATE_TO, MSG_FILTER_TIME,
MSG_FILTER_TIME_FROM, o MSG_FILTER_TIME_To.
Si se requiere una hora actual para transferir un parámetro SYSTEMTIME, se debe utilizar la
función GetLocalTime y no GetSystemTime. Normalmente existe una diferencia de tiempo
considerable entre estas dos funciones.
dwMsgNrLow
dwMsgNrLow Número del primer aviso
dwMsgNrHigh
dwMsgHigh Número del último aviso.
Hay que asignar dwMsgNrLow y dwMsgNrHigh cuando se utilicen los criterios de filtro
MSG_FILTER_NR, MSG_FILTER_NR_FROM o MSG_FILTER_NR_TO.
vMsgClasses
Clases de aviso bitcodificadas
0x0001 = Clase 1, 0x0002 = Clase 2, 0x0004 = Clase 3, ... 0x0040= Clase 7
0x0204 = Clases 3 y 10
Usted debe asignar dwMsgClass y dwMsgType cuando utiliza el criterio de
filtroMSG_FILTER_CLASS.
dwMsgState
Estado del aviso codificado en binario
Asigne este campo cuando utiliza el criterio de filtro MSG_FILTER_STATE.
Los siguientes valores de estado son comprobados por MSRTCheckWinFilter:
wAGNr
wAGNr [0] Número del primer PLC, wAGNr [1] número del último PLC.
Usted debe asignarwAGNr b, cuando utiliza los criterios de filtro MSG_FILTER_AG_FROM o
MSG_FILTER_AG_TO.
wAGSubNr
wAGSubNr [0] Número del primer PLC, wAGSubNr [1] número del último PLC.
Usted debe asignarwAGSubNr b, cuando utiliza los criterios de filtro
MSG_FILTER_AGSUB_FROM o MSG_FILTER_AGSUB_TO.
dwArchivMode
Identificación para fichero o informe. El parámetro debe asignarse con 0.
szTB
Textos de bloques de texto
Usted debe asignar szTB cuando utiliza el criterio de filtro MSG_FILTER_TEXT.
dwTB
Bloques de texto activos, codificados en binario
Usted debe asignar dwTB cuando utiliza el criterio de filtro MSG_FILTER_TEXT
dPValue
Valores de proceso de - hasta
Usted debe asignar dPValue cuando utiliza el criterio de filtro MSG_FILTER_PVALUE.
dwPValue
Valores de proceso activos, codificados en binario
Usted debe asignar dwPValue cuando utiliza el criterio de filtro MSG_FILTER_PVALUE.
uMgCounter
Contador de avisos interno
Usted debe asignar dwMsgCounter cuando utiliza un criterio de filtro
MSG_FILTER_COUNTER_....
dwQuickSelect
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
dwPriority
Prioridad del aviso
szInstance
Nombre de instancia. Si szInstance no recibe valores (string vacío), se crea un aviso normal.
Observación
MSG_FILTER_STRUCT_PLUS también es utilizado por la estructura AUTOHOTSPOT.
Archivos necesarios
CCMsRTCliPlus.h
Funciones API
Consulte también
MSRTGetLastMsgWithCommentPlus (Página 1077)
MSRTSetMsgWinFilterPlus (Página 1100)
MSRTStartMsgServicePlus (Página 1051)
MSRTSetMsgFilterPlus (Página 1099)
MSRTCheckWinFilterPlus (Página 1097)
MSRTGetFilterDataPlus (Página 1096)
MSRTEnumProtDataPlus (Página 1062)
Sinopsis de las estructuras (Página 1009)
Declaración
typedef struct {
DWORD dwMsgState;
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
SYSTEMTIME stMsgTime;
DWORD dwTimeDiff;
ULONGLONG ullCounter;
DWORD dwFlags;
WORD wPValueUsed;
WORD wTextValueUsed;
double dPValue[MSG_MAX_PVALUE];
MSG_TEXTVAL256_STRUCT_PLUS mtTextValue[MSG_MAX_PVALUE]
TCHAR szInstance[MSG_MAX_INSTANCE+1];
}
MSG_RTDATA_INSTANCE_STRUCT_PLUS;
Members
dwMsgState
Estado del aviso en función de las constantes en el archivo "m_global.h":
Los estados listados se utilizan sólo internamente por el sistema y pueden activarse
exclusivamente por API con MSRTCreateMsgInstanceWithCommentPlus.
dwMsgNrLow
dwMsgNrLow Número del primer aviso
dwMsgNrHigh
dwMsgHigh Número del último aviso.
stMsgTime
Fecha y hora para visualización y ocultación de aviso.
dwTimeDiff
Duración de tiempo de visualización o ocultación, tiempo de telegrama en segundos.
ullCounter
Contador de avisos interno.
dwFlags
Flags en función de las constantes en el archivo "m_global.h":
wPValueUsed
Valores utilizados de proceso en representación bitcodificada.
Cada bit debe activarse solamente en uno de los dos member wPValueUsed o
wTextValueUsed, ya que técnicamente un valor acompañante puede ser solamente un
número o texto. En caso de un suministro doble erróneo se trata dPValue prioritariamente.
wTextValueUsed
Valores de texto utilizados, bitcodificados.
Cada bit debe activarse solamente en uno de los dos member wPValueUsed o
wTextValueUsed, ya que técnicamente un valor acompañante puede ser solamente un
número o texto.
En caso de un suministro doble erróneo se trata dPValue prioritariamente.
dPValue
Valores de proceso.
mtTextValue
Estructura del tipo MSG_TEXTVAL256_STRUCT_PLUS (Página 1048) con los valores
asociados al texto.
szInstance
Nombre de instancia. Cuando no se suministra szInstance (string vacío), se crea un aviso
normal
Archivos necesarios
CCMSRTCLIPlus.h
Funciones API
Consulte también
MSRTCreateMsgInstancePlus (Página 1068)
MSG_SERVICE_NOTIFY_PROCPlus (Página 1057)
MSG_TEXTVAL256_STRUCT_PLUS (Página 1048)
Sinopsis de las estructuras (Página 1009)
Declaración
typedef struct {
WCHAR szName[MSG_MAX_TEXTLEN+1];
DWORD dwName;
DWORD dwClassID;
COLORREF crStateCome[2];
COLORREF crStateGo[2];
COLORREF crStateQuit[2];
WORD wQuitType;
WORD wHornQuit;
DWORD dwHornVar;
WCHAR szState[MSG_MAX_STATE][MSG_MAX_TEXTLEN+1];
DWORD dwState[MSG_MAX_STATE];
WCHAR szStateQuit[MSG_MAX_TEXTLEN+1];
DWORD dwStateQuit;
DWORD dwClassTyp;
DWORD dwCreatorID;
}
MSG_CLASS_STRUCT_PLUS;
Members
szName
El nombre de la categoría que debe indicarse depende del lenguaje de datos ajustado.
dwName
Si el nombre de la categoría está contenido en los textos del proyecto, aquí puede indicarse
la ID.
dwClassID
ID de la categoría ( 1..18(MSG_MAX_CLASS) )
crStateCome
Color para el estado "Aparecido".
crStateGo
Color para el estado "Desaparecido".
crStateQuit
Color para el estado "Acusado".
wQuitType
El autómata de estado se define con las siguientes constantes del archivo "m_global.h":
Las constantes del autómata finito pueden combinarse lógicamente bit a bit con "O" siempre
que no se contradigan.
wHornQuit
Acuse de avisador central
dwHornVar
Variable de avisador central
szState
Texto para los estados "Aparecido", "Desaparecido", "Aparecido y desaparecido".
dwState
TextID
szStateQuit
Texto para el estado "Acusado".
dwStateQuit
TextID
dwClassTyp
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
dwCreatorID
CreatorID
Observación
A diferencia de la estructura MSG_CLASS_STRUCT_EX, MSG_CLASS_STRUCTPlus no
dispone de identificador de autor.
Archivos necesarios
CCMSRTCLIPlus.h
Funciones API
Consulte también
MSRTGetClassInfoPlus (Página 1075)
Sinopsis de las estructuras (Página 1009)
Declaración
typedef struct {
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
DWORD dwStatus;
WORD wClass;
WORD wTyp;
DWORD dwTextID[MSG_MAX_TB];
DWORD dwQuitVar;
WORD wQuitBit;
DWORD dwStateVar;
WORD wStateBit;
DWORD dwMsgVar;
WORD wMsgBit;
WORD wAGNr;
WORD wAGSubNr;
DWORD dwGroupID;
DWORD dwPriority;
DWORD dwHidingMask;
}
MSG_CSDATA_STRUCT_PLUS;
Members
dwMsgNrLow
dwMsgNrLow Número del primer aviso
dwMsgNrHigh
dwMsgHigh Número del último aviso.
dwStatus
Los parámetros del aviso individual se determinan con las siguientes constantes del archivo
"m_global.h":
Usted puede enlazar estas constantes con OR cuando no se contradicen entre sí.
wClass
Categoría de aviso
wTyp
Tipo de aviso
dwTextID
Referencia a bloques de texto
dwQuitVar
Variable de acuse. Utilice la dwID de DM_VARKEY (Página 242).
wQuitBit
Bit de la variable de acuse
dwStateVar
Estado del aviso como variable. Utilice la dwID de DM_VARKEY (Página 242)
wStateBit
Con wStateBit se determinan cuales son los bits de dwStateVar que caracterizan el estado
del aviso.
Cuando wStateBit = 1 y dwStateVar corresponden al tipo de datos "8 Bit unsigned", el bit 1
de dwStateVar define el estado Aparecido / Desaparecido y el bit 5 caractiza la obligación de
acuse.
Cuando wStateBit = 2 y dwStateVar son una variable de palabra, el bit 2 de dwStateVar
determina el estado Aparecido / Desaparecido y el bit 10 caracteriza la obligación de acuse.
dwMsgVar
Variable de aviso. Utilice la dwID de DM_VARKEY (Página 242).
wMsgBit
Bit de la variable de aviso
wAGNr
Número PLC
wAGSubNr
Subnúmero PLC
dwGroupID
ID del grupo de avisos (interno)
dwPriority
Prioridad del aviso
dwHidingMask
Máscara de inhibición de visualización
Observación
Mediante esta estructura, su aplicación puede determinar los datos de configuración de un
aviso individual bajo utilización de las funciones API.
Archivos necesarios
CCMSRTCLIPlus.h
Funciones API
Consulte también
MSRTGetMsgCSDataPlus (Página 1080)
DM_VARKEY (Página 242)
Sinopsis de las estructuras (Página 1009)
Declaración
typedef struct {
BOOL fIDUsed;
DWORD dwID;
TCHAR szName[MSG_MAX_TEXTLEN+1];
DWORD dwMsgCount;
DWORD dwMsg[MSG_MAX_GROUPITEMS];
}
MSG_RTGROUPENUM_STRUCT_PLUS;
Members
fIDUsed
Determina si para la especificación del grupo de avisos se utiliza el ID del grupo
(fIDUsed = TRUE) o el nombre (fIDUsed = FALSE).
dwID
ID del grupo
szName
Nombre del grupo
dwMsgCount
Cantidad de avisos individuales en dwMsg
dwMsg
Avisos individuales bloqueados
Archivos necesarios
CCMSRTCLIPlus.h
Funciones API
Consulte también
MSG_SERVICE_NOTIFY_PROCPlus (Página 1057)
MSRTEnumGroupMsgPlus (Página 1091)
Sinopsis de las estructuras (Página 1009)
Declaración
typedef struct {
BOOL fIDUsed;
DWORD dwID;
WCHAR szName[MSG_MAX_TEXTLEN+1];
SYSTEMTIME stTime;
DWORD dwData;
}
MSG_RTGROUPSET_STRUCT_PLUS;
Members
fIDUsed
Determina si para la especificación del grupo de avisos se utiliza la ID del grupo
(fIDUsed = TRUE) o el nombre (fIDUsed = FALSE).
dwID
ID del grupo (en categorías, tipos de aviso)
szName
Nombre del grupo
stTime
Momento en que apareció
dwData
Si la estructura se utiliza en el contexto de MSRTLockGroupPlus, dwData = 1 significa
bloquear y dwData = 0 habilitar
Archivos necesarios
CCMSRTCLIPlus.h
Funciones API
Consulte también
MSRTEnumGroupMsgPlus (Página 1091)
MSRTLockGroupPlus (Página 1093)
MSRTQuitGroupPlus (Página 1094)
Sinopsis de las estructuras (Página 1009)
Declaración
typedef struct {
SYSTEMTIME stTime;
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
WCHAR szText[MSG_MAX_TB_CONTENT+1];
WCHAR szUser[MSG_MAX_USERNAME+1];
WCHAR szComputerName[MAX_COMPUTERNAME_LENGTH+1];
WCHAR szApplicationName[MSG_MAX_APPLNAME+1];
WCHAR szInstance[MSG_MAX_INSTANCE+1];
}
MSG_COMMENT_INSTANCE_STRUCT_PLUS;
Members
stTime
Fecha/hora
dwMsgNrLow
dwMsgNrLow Número del primer aviso
dwMsgNrHigh
dwMsgHigh Número del último aviso.
szText
Comentario
szUser
Nombre de usuario
szComputerName
Nombre del equipo
szApplicationName
Nombre de aplicación
szInstance
Nombre de instancia
Observación
Si se requiere una hora actual para transferir un parámetro SYSTEMTIME, se debe utilizar la
función GetLocalTime y no GetSystemTime. Normalmente existe una diferencia de tiempo
considerable entre estas dos funciones.
Archivos necesarios
CCMSRTCLIPlus.h
Funciones API
Consulte también
MSRTSetCommentInstancePlus (Página 1105)
MSRTGetCommentInstancePlus (Página 1104)
Sinopsis de las estructuras (Página 1009)
Declaración
typedef struct {
DWORD dwMsgNrLow;
DWORD dwMsgNrHigh;
WCHAR szText[MSG_MAX_TB_CONTENT+1];
}
MSG_INFOTEXT_STRUCT_PLUS;
Members
dwMsgNrLow
dwMsgNrLow Número del primer aviso
dwMsgNrHigh
dwMsgHigh Número del último aviso.
szText
Texto informativo
Archivos necesarios
CCMSRTCLIPlus.h
Funciones API
Consulte también
MSRTGetInfotextPlus (Página 1107)
MSRTSetInfotextPlus (Página 1108)
Sinopsis de las estructuras (Página 1009)
Declaración
typedef struct {
SYSTEMTIME stFrom;
SYSTEMTIME stTo;
WCHAR szArchivFile[MAX_PATH+1];
WCHAR szArchivTextFile[MAX_PATH+1];
WCHAR szCommentFile[MAX_PATH+1];
WCHAR szInstanceFile[MAX_PATH+1];
WCHAR szComment[MAX_PATH+1];
DWORD dwFlags;
DWORD dwFormat;
}
MSG_BACKUP_STRUCTPlus;
Members
stFrom
Fecha desde
stTo
Fecha hasta
szArchivFile
Nombre de archivo y ruta del archivo de trasvase del fichero
szArchivTextFile
Nombre de archivo y ruta del archivo de trasvase para textos de fichero
szCommentFile
Nombre de archivo y ruta del archivo de trasvase de comentarios
szInstanceFile
Nombre de archivo y ruta del archivo de trasvase de instancias
szComment
Comentario de libre definición
dwFlags
dwFormat
Para el formato del archivo de exportación se pueden utilizar las siguientes constantes del
archivo "m_global.h":
Observación
Si se requiere una hora actual para transferir un parámetro SYSTEMTIME, se debe utilizar la
función GetLocalTime y no GetSystemTime. Normalmente existe una diferencia de tiempo
considerable entre estas dos funciones.
Archivos necesarios
CCMSRTCLIPlus.h
Funciones API
Consulte también
MSRTEnumBackupListPlus (Página 1110)
MSRTExportPlus (Página 1111)
Sinopsis de las estructuras (Página 1009)
Declaración
typedef struct {
WCHAR szName[MSG_MAX_TEXTLEN+1];
WCHAR szParent[MSG_MAX_TEXTLEN+1];
DWORD dwLockID;
BOOL fLock;
DWORD dwMsgNum;
DWORD dwMsgLock[MSG_MAX_LOCKITEMS];
}
MSG_RTLOCK_STRUCT_PLUS;
Members
szName
Nombre del bloqueo
szParent
Grupo paternal
dwLockID
ID del bloqueo
fLock
Bloquar o bien habilitar
dwMsgNum
Cantidad de avisos bloqueados
dwMsgLock
Avisos individuales bloqueados
Archivos necesarios
CCMSRTCLIPlus.h
Funciones API
Consulte también
MSG_SERVICE_NOTIFY_PROCPlus (Página 1057)
Sinopsis de las estructuras (Página 1009)
Declaración
typedef struct {
WCHAR szText[MSG_MAX_TEXTVAL256+1];
}
MSG_TEXTVAL256_STRUCT_PLUS;
Observación
La estructura se utiliza dentro de las siguientes estructuras:
Members
szText
Texto
Archivos necesarios
CCMSRTCLIPlus.h
Funciones API
Consulte también
MSG_RTDATA_INSTANCE_STRUCT_PLUS (Página 1033)
MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS (Página 1026)
MSG_RTCREATE_STRUCT_PLUS (Página 1024)
Sinopsis de las estructuras (Página 1009)
Descripción
Enuma todos los avisos del fichero indicado. Su función callback
MSG_SERVICE_NOTIFY_PROCPlus se llama con el tipo de notificación
MSG_NOTIFY_ARCHIVENUM. lpbyData refiere a datos de la estructura
MSG_RTARCHIV_STRUCTPlus.
Las funciones de enumeración funcionan asíncronamente. A causa de ello deben
sincronizarse los accesos son semáforos.
Declaración
BOOL MSRTEnumArchivDataPlus(
DWORD dwServiceID,
BOOL fArchiv,
DWORD dwMaxRecords
DWORD dwParams
LPDWORD lpdwTAID
LPCMN_ERROR lpError );
Parámetros
dwServiceID
Número de identificación del servicio de envío y recepción, como se devuelve en la llamada
de MSRTStartMsgServicePlus.
fArchiv
Identifica el tipo de fichero.
dwMaxRecords
Cantidad de registros de datos que deben listarse como máximo. En caso de un exceso de
dwMaxRecords se interrumpe la enumeración. Cuando dwMaxRecords = 0xFFFFFFFF, se
listan todos los avisos.
dwParams
Parámetros para el orden de clasificación:
lpdwTAID
Puntero a la TransactionID con procesamiento asíncrono.
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERRORW. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Avisos listados.
FALSE
Error
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSG_SERVICE_NOTIFY_PROCPlus (Página 1057)
MSRTStartMsgServicePlus (Página 1051)
Sinopsis de las funciones (Página 1008)
Descripción
Inicia un servicio para el envío y la recepción de mensajes al sistema de avisos.
Declaración
BOOL MSRTStartMsgService (
LPDWORD lpdwServiceID,
LPWSTR lpszServer,
DWORD dwFlags,
DWORD dwFilterCount
LPMSG_FILTER_STRUCT_PLUS* lpMsgFilter,
DWORD dwNotifyMask,
MSG_SERVICE_NOTIFY_PROC_PLUS lpfnNotifyProcPlus
LPVOID lpvUserNotify,
MSG_TAID_COMPLETION_PROC_PLUS lpfnTAIDProcPlus
LPVOID lpvUserTAID
LPCMN_ERRORW lpError );
Parámetros
dwServiceID
Contiene después de la llamada exitosa de la función, el número de identificación del servicio
de envío y recepción que se requiere de muchas funciones.
lpszServer
Prefijo de servidor
dwFlags
El parámetro se reserva para futuras ampliaciones y se debe preasignar con 0.
dwFilterCount
Puntero a las condiciones de filtrado (NULL = todos los avisos)
lpMsgFilter
Puntero a los datos del filtro de avisos en la estructura MSG_FILTER_STRUCT_PLUS
(Página 1029).
dwNotifyMask
Identifica el tipo de mensaje, según la definición de constante en el archivo "msrtapi.h":
lpfnNotifyProcPlus
Puntero a su función Callback del tipo MSG_SERVICE_NOTIFY_PROCPlus. Para la
transferencia de mensajes a través del servicio.
Nota
Si un programa activa una rutina Notify, deberá vaciar periódicamente su cola de mensajes.
Los mensajes no recogidos pueden bloquear las notificaciones de WinCC y, con ello, todo
WinCC.
En algunos casos excepcionales puede ocurrir que se devuelva Notify antes de que retorne
la llamada de función.
lpvUserNotify
Puntero a datos específicos de la aplicación. Este puntero no es evaluado por la función, sino
que se proporciona de nuevo en la función Callback.
lpfnTAIDProcPlus
Función de rellamada para procesamiento asíncrono respuesta.
lpvUserTAID
Puntero a datos específicos de la aplicación. Este puntero no es evaluado por la función, sino
que se proporciona de nuevo en la función Callback.
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Servicio iniciado.
FALSE
Error
Observación
Su aplicación puede instalar un máximo de 16 servicios. En total pueden instalarse hasta 128
servicios.
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSRTCreateMsgInstanceWithCommentPlus (Página 1066)
MSRTCreateMsgInstancePlus (Página 1068)
MSRTExportPlus (Página 1111)
MSRTEnumBackupListPlus (Página 1110)
MSRTGetInfotextPlus (Página 1107)
MSRTSetInfotextPlus (Página 1108)
MSRTGetClassInfoPlus (Página 1075)
MSRTSetMsgFilterPlus (Página 1099)
MSG_FILTER_STRUCT_PLUS (Página 1029)
MSRTGetMsgCSDataPlus (Página 1080)
MSRTCheckWinFilterPlus (Página 1097)
MSRTGetMsgPriorityPlus (Página 1082)
MSRTGetMsgQuitPlus (Página 1083)
MSRTGetMsgTextPlus (Página 1085)
MSRTGetSelectedMsgPlus (Página 1086)
MSRTResetMsgPlus (Página 1088)
MSRTLoopInAlarmPlus (Página 1090)
MSRTGetFilterDataPlus (Página 1096)
MSRTEnumArchivDataPlus (Página 1049)
MSRTStopMsgServicePlus (Página 1055)
MSRTSetCommentInstancePlus (Página 1105)
MSG_SERVICE_NOTIFY_PROCPlus (Página 1057)
MSRTQuitHornPlus (Página 1056)
MSRTGetCommentInstancePlus (Página 1104)
Descripción
Detiene el servicio de envío y recepción de notificaciones.
Declaración
BOOL MSRTStopMsgServicePlus (
DWORD dwServiceID,
LPCMN_ERRORW lpError );
Parámetros
dwServiceID
Número de identificación del servicio de envío y recepción, como se devuelve en la llamada
de MSRTStartMsgServicePlus.
LPCMN_ERRORW
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Servicio terminado.
FALSE
Error
Observación
Nota
La llamada no debe usarse en el destructor de una aplicación (EXE, DLL, OCX, ...) porque
eventualmente se colgaría la llamada y por lo tanto del programa debido a los mecanismos
específicos de Microsoft.
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSRTEnumBackupListPlus (Página 1110)
MSRTStartMsgServicePlus (Página 1051)
Sinopsis de las funciones (Página 1008)
Descripción
Acusa el aviso central según la especificación de clase.
Declaración
BOOL MSRTQuitHornPlus(
DWORD dwServiceID,
LPDWORD lpdwTAID,
LPCMN_ERRORW lpError );
Parámetros
dwServiceID
Número de identificación del servicio de envío y recepción, como se devuelve en la llamada
de MSRTStartMsgServicePlus.
lpdwTAID
Puntero a la TransactionID para el procesamiento asíncrono.
LPCMN_ERRORW
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERRORW. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Aviso acusado.
FALSE
Error
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSRTStartMsgServicePlus (Página 1051)
Sinopsis de las funciones (Página 1008)
Descripción
Su función callback para funciones de enumeración. Las funciones de enumeración funcionan
asíncronamente. A causa de ello deben sincronizarse los accesos son semáforos.
Declaración
BOOL ( * MSG_SERVICE_NOTIFY_PROC) (
DWORD dwNotify,
LPBYTE lpbyData,
DWORD dwItems,
LPVOID lpvUserNotify);
Parámetros
dwNotify
El tipo de notificación se determina con las constantes en el archivo "MSRTAPI.h":
lpbyData
Según el tipo de notificación, lpbyData contiene un puntero a los datos.
dwItems
Contiene la cantidad de los objetos retornados en lpbyData. Cuando dwItems = 0, luego es
también lpbyData = NULL. El notify se termina y se habilita el semáforo.
lpvUserNotify
Puntero a datos específicos de la aplicación. Este puntero vuelve a estar disponible en la
función callback.
Valor de retorno
TRUE
Se ha detectado y procesado la notificación.
FALSE
Error
Observación
Nota
A ser posible, aquí sólo deberían copiarse datos. Los siguientes tipos de llamadas de función
dentro de la Callback pueden dar lugar a interbloqueos o desbordamiento de pila:
● Funciones en las que se accede a un Message Loop, p. ej.: GetMessage
● Funciones API de la misma DLL
● Enumeraciones que llaman más enumeraciones
Si un programa activa una rutina Notify, deberá vaciar periódicamente su cola de mensajes.
Los mensajes no recogidos pueden bloquear las notificaciones de WinCC y, con ello, todo
WinCC.
En algunos casos excepcionales puede ocurrir que se devuelva Notify antes de que retorne
la llamada de función.
Archivos necesarios
CCMSRTCLIPlus.h
Funciones relacionadas
Consulte también
MSG_RTDATA_INSTANCE_STRUCT_PLUS (Página 1033)
MSG_RTGROUPENUM_STRUCT_PLUS (Página 1041)
MSG_RTLOCK_STRUCT_PLUS (Página 1047)
MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS (Página 1026)
MSRTStartMsgServicePlus (Página 1051)
MSG_TEXTVAL256_STRUCT_PLUS (Página 1048)
MSRTEnumGroupMsgPlus (Página 1091)
Sinopsis de las funciones (Página 1008)
Descripción
Inicializa la DLL para un WebClient
Declaración
Parámetros
pszProjectPath
Ruta al WebProjekt
dwDataLocale
Valor de retorno
Descripción
Detener o continuar el servicio de informes para la emisión de un informe de avisos de
continuación.
Declaración
BOOL MSRTActivateMProtPlus(
BOOL fActive,
LPCMN_ERROR lpError );
Parámetros
fActive
Determina cómo debe tratarse el servicio de informes:
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Función finalizada correctamente.
FALSE
Error
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Descripción
Enumeración de los datos de informe. Los diferentes datos de informe se separan mediante
una coma. Ya no se da soporte a la función.
Las funciones de enumeración funcionan asíncronamente. A causa de ello deben
sincronizarse los accesos son semáforos.
Declaración
BOOL MSRTEnumProtDataPlus (
DWORD dwProtID,
MSG_PROT_NOTIFY_PROC lpfnEnum,
LPMSG_FILTER_STRUCT lpMsgFilter,
LPVOID lpvUser,
LPCMN_ERROR lpError );
Parámetros
dwProtService
ID de servicio para el intercambio de datos de informe.
lpfnEnum
Su función callback que recibe los datos de informe.
lpMsgFilter
Puntero a los datos del filtro de avisos en la estructura MSG_FILTER_STRUCT_PLUS
(Página 1029).
lpvUser
Puntero a datos específicos de la aplicación. Este puntero no es evaluado por la función, sino
que vuelve a estar disponible en la función Callback.
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Datos de informe listados.
FALSE
Error
Observación
ADVERTENCIA
Con esta función, su aplicación puede acusar avisos sin asegurar que el operador de planta
se haya enterado de esto. ¡A causa de ello puede surgir un riesgo para la vida e integradidad
o bien un peligro para valores materiales!
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSG_FILTER_STRUCT_PLUS (Página 1029)
Descripción
Imprime los avisos actualmente pendientes del informe de avisos de continuación, incluso con
la página todavía no está llena.
Declaración
BOOL MSRTPrintMProtPlus(
DWORD* pdwLines,
LPCMN_ERRORW lpError );
Parámetros
pdwLines
Puntero al número de líneas. Aquí se retorna la cantidad de líneas impresas. Es por ello que
el parámetro debe asignarse con NULL previamente a la llamada.
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Avisos actualmente pendientes impresos.
FALSE
Error
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Descripción
Enumera con nombres de instancia todos los avisos del fichero especificado. Se devuelve la
estructura MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS.
Declaración
Parámetros
dwServiceID
ID del servicio instalado
fArchiv
Fichero circular o secuencial
dwMaxRecords
Máximo número de registros para enumeración\n. En caso de sobrepasarse el número
máximo, se interrumpe la enumeración.
dwParams
Parámetro adicional, MSG_ENUM_ARCHIV_DESC = clasificación descendente
lpdwTAID
Puntero a la TransactionID para respuesta a procesamiento asíncrono
lpError
Puntero a la estructura ampliada de errores
Valor de retorno
TRUE
Función ejecutada con éxito
FALSE
Error
Descripción
Crea un aviso con el número de aviso indicado, con nombre de instancia y comentario. A
diferencia de la mayoría de las llamadas de Create, los valores asociados de texto pueden
contener hasta 256 caracteres (255 + EndOfString). El aviso se ingresa en la lista actual de
avisos con los datos indicados.
Declaración
Parámetros
dwServiceID
ID del servicio
lpMsgCreatePlus
Puntero a Createstruct para generar el aviso
Utilice siempre etiquetas de fecha/hora distintas para los diferentes avisos.
lpdwTAID
Puntero a la TransactionID de respuesta a procesamiento asíncrono
lpError
Puntero que recoge el mensaje de error ampliado
Valor de retorno
TRUE
Función ejecutada con éxito
FALSE
Error
Observación
Las funciones Create trabajan asincrónicamente. A causa de ello deben sincronizarse los
accesos eventualmente son semáforos.
Al utilizar la llamada para el acuse de un aviso, debe indicarse el tiempo Aparecido con
precisión en milisegundos.
ADVERTENCIA
Con esta función, su aplicación puede acusar avisos sin asegurar que el operador de planta
se haya enterado de esto. ¡A causa de ello puede surgir un riesgo para la vida e integridad
o bien un peligro para bienes materiales!
Mensajes de error
Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS (Página 1026)
MSRTStartMsgServicePlus (Página 1051)
MSRTCreateMsgInstancePlus (Página 1068)
MSRTSetCommentInstancePlus (Página 1105)
MSG_TEXTVAL256_STRUCT_PLUS (Página 1048)
Descripción
Crea un aviso con el número de aviso indicado. El aviso se ingresa en la lista actual de avisos
con los datos indicados.
Declaración
Parámetros
dwServiceID
ID del servicio instalado
lpMsgCreatePlus
Puntero a Createstruct para generar el aviso
Utilice siempre etiquetas de fecha/hora distintas para los diferentes avisos.
lpdwTAID
Puntero a la TransactionID para respuesta a procesamiento asíncrono
lpError
Puntero a la estructura ampliada de errores
Valor de retorno
TRUE
Función ejecutada con éxito
FALSE
Error
Observación
Las funciones Create trabajan asincrónicamente. A causa de ello deben sincronizarse los
accesos eventualmente son semáforos.
Al utilizar la llamada para el acuse de un aviso, debe indicarse el tiempo Aparecido con
precisión en milisegundos.
ADVERTENCIA
Con esta función, su aplicación puede acusar avisos sin asegurar que el operador de planta
se haya enterado de esto. ¡A causa de ello puede surgir un riesgo para la vida e integridad
o bien un peligro para bienes materiales!
Mensajes de error
Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSRTCreateMsgInstanceWithCommentPlus (Página 1066)
MSRTStartMsgServicePlus (Página 1051)
MSG_RTDATA_INSTANCE_STRUCT_PLUS (Página 1033)
MSRTSetCommentInstancePlus (Página 1105)
Descripción
Diálogo para bloqueo o habilitación de avisos.
Declaración
BOOL MSRTDialogMsgLockPlus(
HWND hwndParent,
LPCMN_ERRORW lpError );
Parámetros
hwndParent
Ventana padre que contiene el diálogo.
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERRORW. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Diálogo exitosamente terminado.
FALSE
Error o se ha cancelado el diálogo.
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Descripción
Crea un aviso con el número de aviso indicado. El aviso se ingresa en la lista actual de avisos
con los datos indicados.
Declaración
Parámetros
dwServiceID
ID del servicio instalado
lpMsgCreatePlus
Puntero a Createstruct para generar el aviso
Utilice siempre etiquetas de fecha/hora distintas para los diferentes avisos.
IpdwTAID
Puntero a la TransactionID para procesamiento asíncrono
lpError
Puntero a la estructura ampliada de errores
Valor de retorno
TRUE
Función ejecutada con éxito
FALSE
Error
Observación
Las funciones Create trabajan asincrónicamente. A causa de ello deben sincronizarse los
accesos eventualmente son semáforos.
ADVERTENCIA
Con esta función, su aplicación puede acusar avisos sin asegurar que el operador de planta
se haya enterado de esto. ¡A causa de ello puede surgir un riesgo para la vida e integridad
o bien un peligro para bienes materiales!
Mensajes de error
Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSRTCreateMsgInstanceWithCommentPlus (Página 1066)
MSRTCreateMsgInstancePlus (Página 1068)
MSRTStartMsgServicePlus (Página 1051)
Descripción
Enumera todos los avisos bloqueados.
Las funciones de enumeración funcionan asíncronamente. A causa de ello deben
sincronizarse los accesos son semáforos.
Declaración
Parámetros
dwServiceID
ID del servicio instalado
lpdwTAID
Puntero a la TransactionID para el procesamiento asíncrono
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR.
Valor de retorno
TRUE
Avisos enumerados.
FALSE
Error.
Descripción
Enumera todos los avisos disponibles en la lista actual de avisos. Su función de callback
MSG_SERVICE_NOTIFY_PROCPlus se accede con el tipo de notificación
MSG_NOTIFY_MSGENUM, enumeración de avisos. lpbyData refiere a los datos de la
estructura MSG_RTDATA_STRUCTPlus.
Las funciones de enumeración funcionan asíncronamente. A causa de ello deben
sincronizarse los accesos son semáforos.
Declaración
BOOL MSRTEnumMsgRTData(
DWORD dwServiceID,
LPDWORD pdwTAID
LPCMN_ERRORW lpError );
Parámetros
dwServiceID
Número de identificación del servicio de envío y recepción, como se devuelve en la llamada
de MSRTStartMsgServicePlus.
lpdwTAID
Puntero a la TransactionID para el procesamiento asíncrono
LPCMN_ERRORW
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Avisos enumerados.
FALSE
Error.
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSRTStartMsgServicePlus (Página 1051)
Descripción
Obtener información acerca de una categoría.
Declaración
Parámetros
dwServiceID
ID del servicio con cuyo servidor se desea conectar
lpszServer
Servidor al que se desea conectar
dwMsgNrLow
Número de aviso DWORD inferior
dwMsgNrHigh
Número de aviso DWORD WinCC superior
lpClassPlus
Puntero que recoge la información
lpError
Puntero que recoge el mensaje de error ampliado
Valor de retorno
TRUE
Función ejecutada con éxito
FALSE
Error
Observación
La función MSRTGetClassInfoPlus puede accederse también sin MSRTStartMsgServicePlus.
No obstante, estos accesos son mucho más lentos. El rendimiento mejora si primero se
ejecuta un MSRTStartMsgServicePlus y se conserva en todas las llamadas. En este caso,
solamente el primero acceso de MSRTGetClassInfoPlus resulta más lento.
Mensajes de error
Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSG_CLASS_STRUCT_PLUS (Página 1036)
MSRTStartMsgServicePlus (Página 1051)
Descripción
Busca el último aviso del fichero sobre la base de la condición de filtro y el nombre de instancia.
Declaración
Parámetros
lpszServer
Prefijo de servidor sin '::'. En caso de indicar un string vacío o CERO, se utiliza el servidor
predeterminado ajustado.
lpszInstance
Nombre de instancia. Se añade un string vacío o también NULL a la condición de filtro.
lppFilter
Puntero al puntero de filtro ARRAY para seleccionar el tipo de aviso.
dwFilterCount
Número de avisos filtrados.
lpMsg
Devuelve los datos del aviso.
lpError
Puntero en los datos del mensaje de error ampliado en la estructura CMN_ERROR.
Valor de retorno
TRUE
Aviso consultado.
FALSE
Error.
Mensajes de error
Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Consulte también
MSG_FILTER_STRUCT_PLUS (Página 1029)
MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS (Página 1026)
MSG_TEXTVAL256_STRUCT_PLUS (Página 1048)
Descripción
La función determina la cantidad de avisos actualmente pendientes en la lista de avisos.
Declaración
BOOL MSRTGetMsgActualPlus (
LPDWORD lpdwCount,
LPCMN_ERRORW lpError );
Parámetros
lpdwCount
Puntero a un búfer en el cual se guarda la cantidad de los avisos actualmente pendientes.
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Cantidad determinada.
FALSE
Error
Observación
La función MSRTGetMsgActualPlus puede accederse también sin
MSRTStartMsgServicePlus. No obstante, estos accesos son mucho más lentos. El
rendimiento mejora si primero se ejecuta un MSRTStartMsgServicePlus y se conserva en
todas las llamadas. En este caso, solamente el primero acceso de MSRTGetMsgActualPlus
resulta más lento.
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSRTStartMsgServicePlus (Página 1051)
Descripción
Consultar datos de configuración de un aviso.
Declaración
BOOL MSRTGetMsgCSDataPlus (
DWORD dwServiceNr,
LPCWSTR lpszServer,
DWORD dwMsgNrLow,
DWORD dwMsgNrHigh,
LPMSG_CSDATA_STRUCT_PLUS lpmCSDataPlus,
LPCMN_ERRORW lpError );
Parámetros
dwServiceID
Número de identificación del servicio de envío y recepción, como se devuelve en la llamada
de MSRTStartMsgService.
lpszServer
Nombre del servidor.
dwMsgNrLow
dwMsgNrLow Número del primer aviso
dwMsgNrHigh
dwMsgHigh Número del último aviso.
lpmCSDataPlus
Puntero a los datos de configuración (categoría, tipo de aviso, índices de bloque de texto, etc.)
de este aviso en la estructura MSG_CSDATA_STRUCT_PLUS (Página 1039).
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Datos de configuración consultados.
FALSE
Error
Observación
La función MSRTGetMsgCSDataPlus puede accederse también sin
MSRTStartMsgServicePLus. No obstante, estos accesos son mucho más lentos. El
rendimiento mejora si primero se ejecuta un MSRTStartMsgServicePlus y se conserva en
todas las llamadas. En este caso, solamente el primero acceso de MSRTGetMsgCSDataPlus
resulta más lento.
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSG_CSDATA_STRUCT_PLUS (Página 1039)
MSRTStartMsgServicePlus (Página 1051)
Descripción
Consultar prioridad del aviso indicado.
Declaración
BOOL MSRTGetMsgPriorityPlus (
DWORD dwServiceID,
LPCWSTR lpszServer,
DWORD dwMsgNrLow,
DWORD dwMsgNrHigh,
long* plPriority,
LPCMN_ERRORW lpError );
Parámetros
dwServiceID
Número de identificación del servicio de envío y recepción, como se devuelve en la llamada
de MSRTStartMsgService.
lpszServer
Nombre del servidor.
dwMsgNrLow
dwMsgNrLow Número del primer aviso
dwMsgNrHigh
dwMsgHigh Número del último aviso.
plPriority
Puntero a una variable del tipo de datoslong, en la cual se guarda la prioridad.
¡Este parámetro no debe ser NULL!
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERRORW. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Prioridad consultada.
FALSE
Error
Observación
La función MSRTGetMsgPriorityPlus puede accederse también sin
MSRTStartMsgServicePlus. No obstante, estos accesos son mucho más lentos. El
rendimiento mejora si primero se ejecuta un MSRTStartMsgServicePlus y se conserva en
todas las llamadas. En este caso, solamente el primero acceso de MSRTGetMsgPriorityPlus
resulta más lento.
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSRTStartMsgServicePlus (Página 1051)
Descripción
Consultar cantidad de avisos sujetos a acuse.
Declaración
BOOL MSRTGetMsgQuitPlus(
LPDWORD lpdwCount,
LPCMN_ERRORW lpError );
Parámetros
lpdwCount
Puntero para la cantidad de avisos sujetos a acuse
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERRORW. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Cantidad determinada.
FALSE
Error
Observación
La función MSRTGetMsgPriorityPlus puede accederse también sin
MSRTStartMsgServicePlus. No obstante, estos accesos son mucho más lentos. El
rendimiento mejora si primero se ejecuta un MSRTStartMsgServicePlus y se conserva en
todas las llamadas. En este caso, solamente el primero acceso de MSRTGetMsgPriorityPlus
resulta más lento.
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSRTStartMsgServicePlus (Página 1051)
Descripción
Obtener texto para un bloque de texto
Declaración
Parámetros
wTextBlock
Número de bloque de texto
dwTextNr
ID del bloque de texto
lpszMsgText
Puntero al string del bloque de texto
IpdwCount
Puntero a la longitud del string del bloque de texto. La longitud se indica en forma de número
de caracteres.
lpError
Puntero que recoge el mensaje de error ampliado
Valor de retorno
TRUE
Función ejecutada con éxito
FALSE
Error
Observación
La función MSRTGetMsgPriorityPlus puede llamarse también sin MSRTStartMsgServicePlus.
No obstante, estos accesos son mucho más lentos. El rendimiento mejora si primero se
ejecuta un MSRTStartMsgServicePlus y se conserva en todas las llamadas. En este caso,
solamente el primero acceso de MSRTGetMsgPriorityPlus resulta más lento.
Mensajes de error
Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSRTStartMsgServicePlus (Página 1051)
Descripción
La función determina el número de aviso para un mensaje para un mensaje seleccionado en
una ventana de aviso o un visor de avisos. La especificación del visor se realiza con
lpszTemplate.
En los proyectos de puesto(s) único o múltiples, las consultas en las plantillas funcionan sin
restricciones. Las consultas en el visor no funcionan para datos de ingeniería y sólo para
valores de proceso disponibles en el visor.
Declaración
BOOL MSRTGetSelectedMsgPlus(
LPCWSTR lpszTemplate,
LPMSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS lpMsgRTPlus,
LPCMN_ERROR lpError );
Parámetros
lpszTemplate
Puntero al nombre del visor en el que se ha seleccionado un aviso.
lpMsgRTPlus
Puntero a una estructura del tipo MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS
(Página 1026), en la que se retorna el número de aviso.
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Datos consultados.
FALSE
Error
Observación
La función MSRTGetMsgPriorityPlus puede accederse también sin
MSRTStartMsgServicePlus. No obstante, estos accesos son mucho más lentos. El
rendimiento mejora si primero se ejecuta un MSRTStartMsgServicePlus y se conserva en
todas las llamadas. En este caso, solamente el primero acceso de MSRTGetMsgPriorityPlus
resulta más lento.
Nota
En función de la vista ajustada en el visor, se asignan los indicadores en dwFlags de la
estructuraMSG_RTDATA_INSTANCECOMMENT_STRUCTPlus de manera diferente:
● para la vista online: Indicadores MSG_RT_FLAG_xxx,
● para la vista de fichero: Indicadores MSG_FLAG_, así como
● para la lista de hits: Sin asignación posible, indicadores son ignorados
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Ejemplos
Get selected Msg"MS02.cpp"
Consulte también
MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS (Página 1026)
MSRTStartMsgServicePlus (Página 1051)
Descripción
El aviso indicado se acusará.
Declaración
BOOL MSRTResetMsgPlus(
DWORD dwServiceID,
DWORD dwMsgNrLow,
DWORD dwMsgNrHigh,
LPDWORD lpdwTAID
LPCMN_ERRORW lpError );
Parámetros
dwServiceID
Número de identificación del servicio de envío y recepción, como se devuelve en la llamada
de MSRTStartMsgService.
dwMsgNrLow
dwMsgNrLow Número del primer aviso
dwMsgNrHigh
dwMsgHigh Número del último aviso.
Hay que asignar dwMsgNrLow y dwMsgNrHigh cuando se utilicen los criterios de filtro
MSG_FILTER_NR, MSG_FILTER_NR_FROM o MSG_FILTER_NR_TO.
lpdwTAID
Puntero a la TransactionID para el procesamiento asíncrono
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERRORW. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Aviso acusado.
FALSE
Error
Observación
ADVERTENCIA
Con esta función, su aplicación puede acusar avisos sin asegurar que el operador de planta
se haya enterado de esto. ¡A causa de ello puede surgir un riesgo para la vida e integradidad
o bien un peligro para valores materiales!
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSRTStartMsgServicePlus (Página 1051)
Descripción
API: Función para Loop-In-Alarm. El criterio decisivo es el número de aviso.
Declaración
BOOL MSRTLoopInAlarmPlus(
DWORD dwServiceID,
LPCWSTR lpszServer,
DWORD dwMsgNrLow,
DWORD dwMsgNrHigh,
LPCMN_ERRORW lpError );
Parámetros
dwServiceID
ID del servicio con cuyo servidor se desea conectar
lpszServer
Servidor al que se desea conectar
dwMsgNrLow
Número de aviso DWORD inferior
dwMsgNrHigh
Número de aviso DWORD WinCC superior
lpError
Puntero que recoge el mensaje de error ampliado
Valor de retorno
TRUE
Función ejecutada con éxito
FALSE
Error
Mensajes de error
Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSRTStartMsgServicePlus (Página 1051)
Descripción
Enumerar todos los avisos individuales del grupo de avisos. Como máximo se enumeran
MSG_MAX_GROUPITEMS avisos individuales. La función Callback
MSG_SERVICE_NOTIFY_PROCPlus se llama con el tipo de notificación
MSG_NOTIFY_GROUPENUM. lpbyData hace referencia a datos de la estructura
MSG_RTGROUPENUM_STRUCTPlus.
Las funciones de enumeración del sistema de avisos trabajan de forma asíncrona. A causa
de ello deben sincronizarse los accesos son semáforos.
Declaración
Parámetros
dwServiceID
ID del servicio
lpmGroupPlus
Puntero a información de grupos de avisos
IpdwTAID
Puntero a la TransactionID para respuesta a procesamiento asíncrono
lpError
Puntero que recoge el mensaje de error ampliado
Valor de retorno
TRUE
Función ejecutada con éxito
FALSE
Error
Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSG_RTGROUPSET_STRUCT_PLUS (Página 1042)
MSRTStartMsgServicePlus (Página 1051)
MSG_SERVICE_NOTIFY_PROCPlus (Página 1057)
MSG_RTGROUPENUM_STRUCT_PLUS (Página 1041)
Descripción
Bloqueo de un grupo configurado de aviso. Se bloquean también todos los avisos individuales
del grupo de aviso, así como los avisos individuales de los grupos subordenados.
Declaración
BOOL MSRTLockGroupPlus (
DWORD dwServiceID,
LPMSG_RTGROUPSET_STRUCTPlus lpmGroup,
LPDWORD pdwTAID
LPCMN_ERRORW lpError );
Parámetros
dwServiceID
Número de identificación del servicio de envío y recepción, como se retorna en el acceso de
MSRTStartMsgServicePlus.
lpmGroup
Puntero sobre la estructura MSG_RTGROUPSET_STRUCT_PLUS (Página 1042) con la
información de los grupos de aviso.
Bloquear: dwData != 0; habilitar: dwData = 0
pdwTAID
lpError
Puntero sobre los datos del aviso extendido de error en la estructura CMN_ERRORW. En
caso de un error, el sistema escribe la información de error en esta estructura.
Valor de retorno
TRUE
Avisos del grupo de avisos bloqueados.
FALSE
Error
Observación
Se bloquean o habilitan solamente los grupos configurados de aviso. Los grupos definidos en
Runtime no se registran y la función no tiene ningún efecto.
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSG_RTGROUPSET_STRUCT_PLUS (Página 1042)
MSRTStartMsgServicePlus (Página 1051)
Descripción
Acusar un grupo de avisos. Se acusan todos los avisos individuales del grupo de avisos, así
como los avisos de los grupos subordinados.
Declaración
BOOL MSRTQuitGroupPlus (
DWORD dwServiceID,
LPMSG_RTGROUPSET_STRUCTPlus lpmGroupPlus,
LPDWORD pdwTAID
LPCMN_ERRORW lpError );
Parámetros
dwServiceID
Número de identificación del servicio de envío y recepción, como se devuelve en la llamada
de MSRTStartMsgServicePlus.
lpmGroup
Puntero a una estructura del tipo MSG_RTGROUPSET_STRUCT_PLUS (Página 1042) con
la información de los grupos de avisos.
pdwTAID
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERRORW. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Avisos del grupo acusados
FALSE
Error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Consulte también
MSG_RTGROUPSET_STRUCT_PLUS (Página 1042)
Descripción
Lee los criterios de selección del visor de avisos y deposita el resultado en la estructura
MSG_FILTER_STRUCT_PLUS.
Declaración
Parámetros
dwServiceID
ID del servicio
lpszName
Nombre del visor de avisos. El nombre se define en las propiedades del visor de avisos.
lpMsgFilterPlus
Puntero al puntero de filtro array a estructuras de filtro
lpdwFilterCount
lpError
Puntero que recoge el mensaje de error ampliado
Valor de retorno
TRUE
Función ejecutada con éxito
FALSE
Error
Observación
Se determinan solamente los filtros de aviso configurados. No se registran los filtros de aviso
que han sido aplicados con MSRTStartMsgServicePlus o con MSRTSetMsgFilterPlus.
Mensajes de error
Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSG_FILTER_STRUCT_PLUS (Página 1029)
MSRTStartMsgServicePlus (Página 1051)
MSRTSetMsgFilterPlus (Página 1099)
Descripción
Comprueba si el aviso indicado cumple con la condición de filtro.
Declaración
BOOL MSRTCheckWinFilterPlus (
DWORD dwServiceID,
LPCWSTR lpszServer,
LPMSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS lpMsgRTPlus,
LPMSG_FILTER_STRUCT_PLUS* lppMsgFilter,
DWORD dwFilterCount,
LPWORD lpwReturn,
LPCMN_ERRORW lpError );
Parámetros
dwServiceID
Número de identificación del servicio de envío y recepción, como se devuelve en la llamada
de MSRTStartMsgServicePlus.
lpszServer
Puntero al nombre de servidor. El nombre se indica sin caracteres separadores de servidor ::.
En caso de indicar un string vacío o CERO, se utiliza el servidor predeterminado ajustado
lpMsgRTPlus
Puntero a una estructura del tipo MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS
(Página 1026) con los datos Runtime de un aviso.
lpMsgFilter
Puntero a una estructura del tipo MSG_FILTER_STRUCT_PLUS (Página 1029) con los datos
del filtro de avisos.
lpwReturn
Puntero al resultado de öa función.
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Se ha realizado la comprobación.
FALSE
Error
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSG_FILTER_STRUCT_PLUS (Página 1029)
MSRTStartMsgServicePlus (Página 1051)
MSG_RTDATA_INSTANCECOMMENT_STRUCT_PLUS (Página 1026)
Descripción
Restablece el filtro para el servicio especificado.
Declaración
Parámetros
dwServiceID
Número de identificación del servicio de envío y recepción, como se devuelve en la llamada
de MSRTStartMsgServicePlus.
lppMsgFilterPlus
Puntero al puntero ARRAY para condiciones de filtro
dwFilterCount
Número de filtros en el ARRAY
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERRORW. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Función ejecutada con éxito
FALSE
Error
Mensajes de error
Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSRTStartMsgServicePlus (Página 1051)
MSG_FILTER_STRUCT_PLUS (Página 1029)
MSRTGetFilterDataPlus (Página 1096)
Descripción
Define nuevas condiciones de filtro para el visor de avisos. Se actualizan todos los visores de
avisos actuales con este nombre.
Declaración
BOOL MSRTSetMsgWinFilterPlus (
LPMSG_FILTER_STRUCT_PLUS lppMsgFilterPlus,
DWORD dwFilterCount,
LPCMN_ERRORW lpError );
Parámetros
lppMsgFilterPlus
Puntero a una estructura del tipo MSG_FILTER_STRUCT_PLUS (Página 1029) con los datos
del filtro de avisos. El nombre de la estructura de filtro es igual al nombre de filtro.
dwFilterCount
Número de filtros
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Se ha aplicado el filtro
FALSE
Error
Mensajes de error
Consulte también
MSG_FILTER_STRUCT_PLUS (Página 1029)
Descripción
Ejecuta una función de operador en un visor de avisos. Si utiliza esta función, utilice una
plantilla de ventana de avisos solo una vez dentro de una imagen. Los comandos se transfieren
a controles con el nombre del título (Caption) igual que el nombre de la plantilla (Template).
(Debido a la conversión de imágenes con plantillas de avisos en imágenes con controles se
crean controles con el nombre del título (Caption) iigual al nombre de la plantilla (Template).
Declaración
BOOL MSRTMsgWinCommand(
LPTSTR lpszTemplate,
DWORD dwCommandID,
LPCMN_ERROR lpError );
Parámetros
lpszTemplate
Puntero al nombre de ventana
dwCommandID
La ID de la función de operador se determina con las constantes en el archivo "m_global.h":
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Función de operador ejecutada
FALSE
Error
Observación
Todos los visores de avisos abiertos con el nombre indicado ejecutan la función de operador.
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Descripción
Determina el texto de comentario de un aviso archivado.
Declaración
BOOL MSRTGetCommentInstancePlus (
DWORD dwServiceID,
LPMSG_COMMENT_INSTANCE_STRUCT_PLUS lpmCommentPlus,
LPCMN_ERRORW lpError );
Parámetros
dwServiceID
Número de identificación del servicio de envío y recepción, como se devuelve en la llamada
de MSRTStartMsgServicePlus.
lpmCommentPlus
Puntero a una estructura del tipo MSG_COMMENT_INSTANCE_STRUCT_PLUS
(Página 1043) con los datos de un comentario. Son necesarios los siguientes valores de la
estructura: Número de aviso, fecha y hora y nombre de instancia.
Nota
La fecha y la hora deben coincidir exactamente al milisegundo en la etiqueta de fecha y hora
del aviso para el cual se debe determinar el texto de comentario.
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR W. En caso
de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
Texto de comentario encontrado.
Si no hay ningún comentario, la llamada se devuelve con TRUE, pero el elemento szText está
vacío.
FALSE
Error
Mensajes de error
Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSRTStartMsgServicePlus (Página 1051)
MSG_COMMENT_INSTANCE_STRUCT_PLUS (Página 1043)
Descripción
Determina el texto de comentario de un aviso archivado.
Declaración
Bool MSRTSetCommentInstancePlus (
DWORD dwServiceID,
LPMSG_COMMENT_INSTANCE_STRUCT_PLUS lpmCommentPlus,
LPDWORD pdwTAID,
LPCMN_ERRORW lpError );
Parámetros
dwServiceID
Número de identificación del servicio de envío y recepción, como se devuelve en la llamada
de MSRTStartMsgServicePlus.
lpmCommentPlus
Puntero a una estructura del tipo MSG_COMMENT_INSTANCE_STRUCT_PLUS
(Página 1043) con los datos de un comentario. Son necesarios los siguientes valores de la
estructura: Número de aviso, nombre de instancia, fecha, hora, texto y nombre de usuario.
pdwTAID
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Enviado con éxito al servidor.
FALSE
Error
Observación
Los datos de la función MSRTSetCommentPlus se escriben de forma asíncrona. Esto hace
que no se devuelvan todos los errores al usuario. Compruebe la notación con
MSRTGetCommentInstancePlus.
Si MSRTSetCommentInstancePlus se ejecuta después de MSRTCreateMsgPlus o
MSRTCreateMsgInstancePlus, debido al asincronismo y dependiendo del grado de carga de
la instalación pueden darse procesos de adelantamiento. Eso significa que el comentario se
define antes de que se genere el aviso.
Utilice la función MSRTCreateMsgInstanceWithCommentPlus en lugar de esta combinación
de llamada.
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSG_COMMENT_INSTANCE_STRUCT_PLUS (Página 1043)
MSRTStartMsgServicePlus (Página 1051)
MSRTCreateMsgInstanceWithCommentPlus (Página 1066)
MSRTCreateMsgInstancePlus (Página 1068)
Descripción
Obtiene el texto de información para un aviso. Para ello deben transferirse los siguientes
valores: Número del aviso
Declaración
Parámetros
dwServiceID
ID del servicio
lpmInfotext
Puntero de la estructura del texto de información
lpError
Puntero que recoge el mensaje de error ampliado
Valor de retorno
TRUE
Función ejecutada con éxito
FALSE
Error
Mensajes de error
Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSG_INFOTEXT_STRUCT_PLUS (Página 1045)
MSRTStartMsgServicePlus (Página 1051)
Descripción
Establece el texto de información para un aviso.
Declaración
Parámetros
dwServiceID
ID del servicio
lpmInfotextPlus
Puntero de la estructura del texto de información
lpdwTAID
Puntero a la TransactionID con la respuesta para el procesamiento asíncrono.
lpError
Puntero que recoge el mensaje de error ampliado.
Valor de retorno
TRUE
Función ejecutada con éxito
FALSE
Error
Observación
El nuevo texto de información se vuelve efectivo a partir del subsiguiente cambio de minuto.
Hasta este momento se utiliza el texto de información anterior.
Mensajes de error
Archivos requeridos
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSG_INFOTEXT_STRUCT_PLUS (Página 1045)
MSRTStartMsgServicePlus (Página 1051)
Descripción
Lista las entradas del archivo de intercambio para el fichero de secuencia.
Declaración
BOOL MSRTEnumBackupListPlus (
DWORD dwServiceID,
LPCMN_ERROR lpError );
Parámetros
dwServiceID
Número de identificación del servicio de envío y recepción, como se devuelve en la llamada
de MSRTStartMsgServicePlus.
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Lista de intercambio creada.
FALSE
Error
Observación
Las funciones Enum trabajan asincrónicamente. A causa de ello deben sincronizarse los
accesos eventualmente son semáforos
La función callback MSG_SERVICE_NOTIFY_PROCPlus se accede con el parámetro
MSG_NOTIFY_BACKUPENUM. El parámetro lpbyData indica sobre los datos de la estructura
MSG_BACKUP_STRUCT_PLUS (Página 1046).
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSG_BACKUP_STRUCT_PLUS (Página 1046)
MSRTStartMsgServicePlus (Página 1051)
MSG_SERVICE_NOTIFY_PROCPlus (Página 1057)
Descripción
Exporta avisos desde el fichero circular y los archivos de backup de archivo enlazados.
Declaración
BOOL MSRTExportPlus (
DWORD dwServiceID,
LPMSG_BACKUP_STRUCT_PLUS lpMsgBackup,
LPCMN_ERRORW lpError );
Parámetros
dwServiceID
Número de identificación del servicio de envío y recepción, como se devuelve en la llamada
de MSRTStartMsgServicePlus.
lpMsgBackup
Puntero a una estructura del tipo MSG_BACKUP_STRUCT_PLUS (Página 1046).
lpError
Puntero a los datos del mensaje de error avanzado en la estructura CMN_ERROR. En caso
de error, el sistema escribe información de error en esta estructura.
Valor de retorno
TRUE
Avisos exportados.
FALSE
Error
Mensajes de error
Archivos necesarios
CCMSRTCLIPlus.h
CCMSRTCLIPlus.lib
CCMSRTCLIPlus.dll
Funciones relacionadas
Consulte también
MSRTStartMsgServicePlus (Página 1051)
MSG_BACKUP_STRUCT_PLUS (Página 1046)
Generalidades
Estas funciones permiten pasar directamente de una imagen en WinCC Runtime a la ubicación
de una variable de proceso en el código de programa de STEP 7. De este modo es posible
diagnosticar fallos de manera rápida y sencilla. Para acelerar las funciones de salto, existe la
posibilidad de iniciar el TIA Portal y abrir un proyecto. Esto se realiza típicamente durante el
arranque de WinCC Runtime.
En el momento del salto se comprueba en primer lugar si el TIA Portal ya está abierto. De no
ser así, se inicia automáticamente el TIA Portal. En el TIA Portal se abre el correspondiente
editor y se busca el punto de aplicación, la asignación, la llamada o el paso.
Archivos header
La declaración de las funciones y estructuras que se explican aquí se realiza en los archivos
header:
Librerías
El vínculo a DLL de las funciones que se explican aquí se realiza en los archivos de librería
kopapi.dll.
kopapi.lib Library
kopapi.dll
Consulte también
OpenTIAPortalProject (Página 1114)
OpenTIAPortalIECPLByCall (Página 1116)
OpenTIAPortalIECPLByAssignment (Página 1118)
Descripción
Con esta función se puede iniciar el TIA Portal y abrir un proyecto. De este modo se aceleran
las distintas funciones de destino. Sin embargo, tenga en cuenta que los programas abiertos
en segundo plano consumen memoria y tiempo de cálculo.
Declaración
BOOL OpenTIAPortalProject (
DWORD dwFlags,
LPCTSTR lpszTiaPortalProjectPath,
LPCTSTR lpszErrorTag,
LPCMN_ERROR lpdmError);
Parámetros
dwFlags
Campo de bits en el que los distintos valores se combinan bit a bit con el operador lógico O.
dwFlags debe ser por defecto 0.
● IECPLVIEWER_PIN_SUBSTRING_SEARCH=0x0001: En la búsqueda del nombre de pin
se busca una cadena parcial, es decir, el nombre de pin empieza con la cadena de
caracteres enviada en lpszPin. Si este bit no está activado, se compara el nombre de pin
completo con lpszPin.
● KOPAPI_FLAG_TIAPORTAL_SUPPRESS_PROGRAM_STATUS=0x0004: después de
abrirse el bloque, el TIA Portal no pasa al modo online. Si este bit no está activado, después
de abrirse el bloque se inicia el modo online.
lpszTiaPortalProjectPath
Nombre del archivo de proyecto, incluida la ruta absoluta, p. ej., "D:\TIAProjects
\Project1\Project1.ap12"
Tenga en cuenta que dentro de un C script es obligatorio escribir la barra invertida con una
secuencia de escape:
FunctionX(…, "D:\\TIAProjects\\Project1\\Project1.ap12", …);
lpszErrorTag
Nombre de una variable WinCC interna del tipo de datos String. Al llamar funciones asíncronas
que no devuelven un resultado inmediatamente, se devuelve la información de error en
lpszErrorTag (Página 1136).
lpdmError
Puntero hacia los datos del mensaje de error ampliado en la estructura CMN_ERROR. En
caso de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
La función se ha ejecutado correctamente.
FALSE
Se ha producido un error.
Archivos requeridos
kopapi.h
kopapi.lib
kopapi.dll
Consulte también
Principios básicos (Página 1113)
Descripción
Esta función se utiliza para los lenguajes KOP y FUP y muestra la preconexión de una entrada
de red de un bloque estándar.
Declaración
BOOL OpenTIAPortalIECPLByCall (
DWORD dwFlags,
LPCTSTR lpszTiaPortalProjectPath,
LPCTSTR lpszCpuName,
LPCTSTR lpszContainingBlock,
LPCTSTR lpszCalledBlock,
LPCTSTR lpszPin,
LPCTSTR lpszErrorTag,
LPCMN_ERROR lpdmError);
Parámetros
dwFlags
Campo de bits en el que los distintos valores se combinan bit a bit con el operador lógico O.
dwFlags debe ser por defecto 0.
● IECPLVIEWER_PIN_SUBSTRING_SEARCH=0x0001: En la búsqueda del nombre de pin
se busca una cadena parcial, es decir, el nombre de pin empieza con la cadena de
caracteres enviada en lpszPin. Si este bit no está activado, se compara el nombre de pin
completo con lpszPin.
● KOPAPI_FLAG_TIAPORTAL_SUPPRESS_PROGRAM_STATUS=0x0004: después de
abrirse el bloque, el TIA Portal no pasa al modo online. Si este bit no está activado, después
de abrirse el bloque se inicia el modo online
● KOPAPI_FLAG_TIAPORTAL_DONT_USE_MODIFIED_PROJECT 0x0008L: si este bit
está activado, se cancela la llamada si el proyecto ya está abierto y contiene cambios.
lpszTiaPortalProjectPath
Nombre del archivo de proyecto, incluida la ruta absoluta, p. ej., "D:\TIAProjects
\Project1\Project1.ap12"
Tenga en cuenta que dentro de un C script es obligatorio escribir la barra invertida con una
secuencia de escape:
FunctionX(…, "D:\\TIAProjects\\Project1\\Project1.ap12", …);
lpszCpuName
Nombre de la CPU S7. El nombre es idéntico al nombre de estación que se muestra en el
árbol de proyecto en el TIA Portal.
lpszContainingBlock
Nombre del bloque que se abrirá y visualizará o nombre de la instancia de un FB.
Pueden usarse como nombre:
● El nombre de un DB de instancia individual. En ese caso se mostrará su FB. Ejemplo
"Station1"
● El nombre de una multiinstancia en un DB de instancia. En ese caso se mostrará su FB.
Al indicar la ruta del nombre de la multiinstancia, se trata de la jerarquía de datos que se
muestra, p. ej., en el editor DB, y no de la Call Structure. La primera parte del nombre
("Line1") no debe ir entre comillas, ya que del contexto se deduce que se trata de un
símbolo global. Las comillas son necesarias para los distintos componentes del nombre
en los que aparezcan caracteres especiales como espacios en blanco, puntos u otros.
Ejemplo: "Line1.Cell1.Station1"
● El nombre de un FC u OB
No se permite usar el nombre de un FB.
lpszCalledBlock
Nombre de la instancia local o global que se llama en el bloque de código correspondiente a
lpszContainingBlock.
● En las instancias locales debe agregarse aquí el carácter almohadilla (#), p. ej., "#feeder1".
● En los DB de instancia global debe especificarse el nombre global sin #, p. ej., "feeder3".
Se permite usar el nombre de un FC.
Si se llama varias veces lpszCalledBlock dentro de lpszContainingBlock o de su FB, se salta
siempre a la primera llamada de lpszCalledBlock.
Con lpszCalledBlock=NULL, lpszContainingBlock solo se abre y se muestra en el estado, pero
no se busca una determinada llamada de bloque ni un determinado segmento. En este caso
se omite lpszPin.
lpszPin
El nombre de un pin de entrada de lpszCalledBlock. Este parámetro sirve para que en el editor
se muestre de manera visible el pin especificado dentro de un segmento.
Con lpszPin=NULL solo se muestra de manera visible lpszCalledBlock.
lpszErrorTag
Nombre de una variable WinCC interna del tipo de datos String. Al llamar funciones asíncronas
que no devuelven un resultado inmediatamente, se devuelve la información de error en
lpszErrorTag (Página 1136).
lpdmError
Puntero hacia los datos del mensaje de error ampliado en la estructura CMN_ERROR. En
caso de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
La función se ha ejecutado correctamente.
FALSE
Se ha producido un error.
Archivos requeridos
kopapi.h
kopapi.lib
kopapi.dll
Consulte también
Principios básicos (Página 1113)
Descripción
Esta función se utiliza para los lenguajes KOP y FUP y muestra la asignación a un operando
y su preconexión.
Declaración
BOOL OpenTIAPortalIECPLByAssignment (
DWORD dwFlags,
LPCTSTR lpszTiaPortalProjectPath,
LPCTSTR lpszCpuName,
LPCTSTR lpszContainingBlock,
LPCTSTR lpszOperand,
LPCTSTR lpszErrorTag,
LPCMN_ERROR lpdmError);
Parámetros
dwFlags
Campo de bits en el que los distintos valores se combinan bit a bit con el operador lógico O.
dwFlags debe ser por defecto 0.
● KOPAPI_FLAG_TIAPORTAL_SUPPRESS_PROGRAM_STATUS=0x0004: después de
abrirse el bloque, el TIA Portal no pasa al modo online. Si este bit no está activado, después
de abrirse el bloque se inicia el modo online
● KOPAPI_FLAG_TIAPORTAL_DONT_USE_MODIFIED_PROJECT 0x0008L: si este bit
está activado, se cancela la llamada si el proyecto ya está abierto y contiene cambios.
lpszTiaPortalProjectPath
Nombre del archivo de proyecto, incluida la ruta absoluta, p. ej., "D:\TIAProjects
\Project1\Project1.ap12"
Tenga en cuenta que dentro de un C script es obligatorio escribir la barra invertida con una
secuencia de escape:
FunctionX(…, "D:\\TIAProjects\\Project1\\Project1.ap12", …);
lpszCpuName
Nombre de la CPU S7. El nombre es idéntico al nombre de estación que se muestra en el
árbol de proyecto en el TIA Portal.
lpszContainingBlock
Nombre del bloque que se abrirá y visualizará o nombre de la instancia de un FB.
Pueden usarse como nombre:
● El nombre de un DB de instancia individual. En ese caso se mostrará su FB. Ejemplo
"Station1"
● El nombre de una multiinstancia en un DB de instancia. En ese caso se mostrará su FB.
Al indicar la ruta del nombre de la multiinstancia, se trata de la jerarquía de datos que se
muestra, p. ej., en el editor DB, y no de la Call Structure. La primera parte del nombre
("Line1") no debe ir entre comillas, ya que del contexto se deduce que se trata de un
símbolo global. Las comillas son necesarias para los distintos componentes del nombre
en los que aparezcan caracteres especiales como espacios en blanco, puntos u otros.
Ejemplo: "Line1.Cell1.Station1"
● El nombre de un FC u OB
No se permite usar el nombre de un FB.
lpszOperand
Nombre de un operando local o global al que se hace referencia.
Nombre de la instancia local o global que se llama en el bloque de código correspondiente a
lpszContainingBlock.
● En los operandos locales debe agregarse aquí el carácter almohadilla (#).
● En los operandos globales debe especificarse el nombre global sin #.
Si se escribe varias veces lpszOperand dentro de lpszContainingBlock o de su FB, se salta
siempre al primer acceso de escritura de lpszOperand.
lpszErrorTag
Nombre de una variable WinCC interna del tipo de datos String. Al llamar funciones asíncronas
que no devuelven un resultado inmediatamente, se devuelve la información de error en
lpszErrorTag (Página 1136).
lpdmError
Puntero hacia los datos del mensaje de error ampliado en la estructura CMN_ERROR. En
caso de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
La función se ha ejecutado correctamente.
FALSE
Se ha producido un error.
Archivos requeridos
kopapi.h
kopapi.lib
kopapi.dll
Consulte también
Principios básicos (Página 1113)
Descripción
La función se utiliza para los lenguajes S7 Graph y muestra un paso en una cadena secuencial.
Declaración
BOOL OpenTIAPortalS7GraphByBlock (
DWORD dwFlags,
LPCTSTR lpszTiaPortalProjectPath,
LPCTSTR lpszCpuName,
LPCTSTR lpszBlock,
DWORD dwStepNumber,
LPCTSTR lpszErrorTag,
LPCMN_ERROR lpdmError);
Parámetros
dwFlags
Campo de bits en el que los distintos valores se combinan bit a bit con el operador lógico O.
dwFlags debe ser por defecto 0.
● KOPAPI_FLAG_TIAPORTAL_SUPPRESS_PROGRAM_STATUS=0x0004: después de
abrirse el bloque, el TIA Portal no pasa al modo online. Si este bit no está activado, después
de abrirse el bloque se inicia el modo online
● KOPAPI_FLAG_TIAPORTAL_DONT_USE_MODIFIED_PROJECT 0x00000008L: Si este
bit está activado, se cancela la llamada si el proyecto ya está abierto y contiene cambios.
lpszTiaPortalProjectPath
Nombre del archivo de proyecto, incluida la ruta absoluta, p. ej., "D:\TIAProjects
\Project1\Project1.ap12"
Tenga en cuenta que dentro de un C script es obligatorio escribir la barra invertida con una
secuencia de escape:
FunctionX(…, "D:\\TIAProjects\\Project1\\Project1.ap12", …);
lpszCpuName
Nombre de la CPU S7. El nombre es idéntico al nombre de estación que se muestra en el
árbol de proyecto en el TIA Portal.
lpszBlock
Nombre de instancia del bloque S7-Graph que se desea mostrar.
dwStepNumber
Número del paso que se desea mostrar
Con dwStepNumber=0 se busca automáticamente el paso activo y se activa el modo "Track
active step".
lpszErrorTag
Nombre de una variable WinCC interna del tipo de datos String. Al llamar funciones asíncronas
que no devuelven un resultado inmediatamente, se devuelve la información de error en
lpszErrorTag (Página 1136).
lpdmError
Puntero hacia los datos del mensaje de error ampliado en la estructura CMN_ERROR. En
caso de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
La función se ha ejecutado correctamente.
FALSE
Se ha producido un error.
Archivos requeridos
kopapi.h
kopapi.lib
kopapi.dll
Consulte también
Principios básicos (Página 1113)
Descripción
El ejemplo muestra la integración de las llamadas a función en una función definida por el
usuario. Para un mantenimiento más fácil, es recomendable transferir la llamada a una función
Global Script en la que también se definirán la ruta al TIA Portal y el nombre de la estación
PLC.
BOOL useTiaPortal = TRUE; // use the TIA Portal or the viewer control?
char* pTiaPortalProject = "c:\\Projects\\myproject\\myproject.ap12";
char* pStationName = "OW063IZ1M01_PLC2_STD"; // TODO: read from internal
tag
char* pContainingBlock = "SG01_FG02_ST001+FX001_IDB"; // TODO: get from
current selection
char* pOperand = "#HOME_SEQ1.HOME_MISC[8]"; // TODO: get from current
selection
char* pErrorTag = "IECPLViewerErrorTag"; // TODO: define an own tag
CMN_ERROR error;
BOOL result;
if(useTiaPortal)
{
result = OpenTIAPortalIECPLByAssignment(0, pTiaPortalProject,
pStationName, pContainingBlock, pOperand, pErrorTag, &error);
}
else
{
char *pServerPrefix = NULL, *pTagPrefix = NULL, *pWindowPrefix =
NULL;
// determine ServerPrefix of the current environment
GetServerTagPrefix(&pServerPrefix, &pTagPrefix, &pWindowPrefix);
// make the screen which contains the viewer control visible
SetVisible("SYSTEM#Basic_Screen", "Screen_window_IECPLViewer",
TRUE);
result = OpenViewerIECPLByAssignment(0, pServerPrefix,
"SYSTEM#IECPLViewer", "IECPLViewerObject", pStationName, pContainingBlock,
pOperand, pErrorTag, &error);
}
}
Consulte también
Principios básicos (Página 1113)
Generalidades
Estas funciones permiten representar el estado actual de los programas de PLC en un visor
de código PLC.
La imagen que contiene el visor de código PLC debe abrirse, p. ej., con OpenPicture() o
SetPictureName().
Archivos header
La declaración de las funciones y estructuras que se explican aquí se realiza en los archivos
header:
Librerías
El vínculo a DLL de las funciones que se explican aquí se realiza en los archivos de librería:
pdecscli.dll
kopapi.lib Library
kopapi.dll
Consulte también
OpenViewerIECPLByCall (Página 1127)
OpenViewerIECPLByAssignment (Página 1134)
OpenViewerS7GraphByBlock (Página 1125)
Descripción
La función muestra una etapa de una cadena secuencial en el lenguaje de PLC S7 Graph en
el visor de código PLC.
Declaración
BOOL OpenViewerS7GraphByBlock (
DWORD dwFlags,
LPCTSTR lpszServerPrefix,
LPCTSTR lpszPictureName,
LPCTSTR lpszObjectName,
LPCTSTR lpszCpuName,
LPCTSTR lpszBlock,
DWORD dwStepNumber,
LPCMN_ERROR lpdmError);
Parámetros
dwFlags
Campo de bits en el que los distintos valores se combinan bit a bit con el operador lógico O.
dwFlags debe ser por defecto 0.
lpszServerPrefix
El parámetro se reserva para futuras ampliaciones.
lpszPictureName
Nombre de la imagen con el visor de código PLC.
lpszObjectName
Nombre del visor de código PLC.
lpszCpuName
Nombre de la CPU S7. El nombre es idéntico al nombre de estación que se muestra en el
árbol de proyecto en el TIA Portal.
lpszBlock
Nombre de instancia del bloque S7-Graph que se desea mostrar. Si el nombre contiene
caracteres especiales tales como espacios, puntos etc., deben utilizarse comillas.
dwStepNumber
Número del paso que se desea mostrar.
Con dwStepNumber=0 se busca automáticamente el paso activo y se activa el modo "Track
active step".
lpdmError
Puntero hacia los datos del mensaje de error ampliado en la estructura CMN_ERROR. En
caso de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
La función se ha ejecutado correctamente.
FALSE
Se ha producido un error.
Archivos requeridos
kopapi.h
kopapi.lib
kopapi.dll
Ejemplo
El ejemplo muestra la integración de la llamada a función en una función C definida por el
usuario. Para un mantenimiento más fácil, es recomendable transferir la llamada a una función
Global Script en la que también se definirá el nombre de la estación PLC.
Consulte también
Tratamiento de errores (Página 1136)
Principios básicos (Página 1124)
Descripción
La función muestra la preconexión de una entrada de un segmento de un bloque estándar en
los lenguajes de PLC KOP y FUP en el visor de código PLC.
Nota
Si la entrada está ocupada con una constante (TRUE, FALSE), este valor no se muestra en
el visor de código PLC. Para mostrar el valor correctamente en el visor de código PLC, debe
ocupar la entrada con una variable que tenga el valor correspondiente.
Declaración
BOOL OpenViewerIECPLByCall (
DWORD dwFlags,
LPCTSTR lpszServerPrefix,
LPCTSTR lpszPictureName,
LPCTSTR lpszObjectName,
LPCTSTR lpszCpuName,
LPCTSTR lpszContainingBlock,
LPCTSTR lpszCalledBlock,
LPCTSTR lpszPin,
LPCMN_ERROR lpdmError);
Parámetros
dwFlags
Campo de bits en el que los distintos valores se combinan bit a bit con el operador lógico O.
dwFlags debe ser por defecto 0.
● IECPLVIEWER_PIN_SUBSTRING_SEARCH=0x0001: en la búsqueda del nombre de pin
se busca una cadena parcial, es decir, el nombre de pin empieza con la cadena de
caracteres enviada en lpszPin. Si este bit no está activado, se compara el nombre de pin
completo con lpszPin.
lpszServerPrefix
El parámetro se reserva para futuras ampliaciones.
lpszPictureName
Nombre de la imagen con el visor de código PLC.
lpszObjectName
Nombre del visor de código PLC.
lpszCpuName
Nombre de la CPU S7. El nombre es idéntico al nombre de estación que se muestra en el
árbol de proyecto en el TIA Portal.
lpszContainingBlock
Nombre del bloque que se abrirá y visualizará o nombre de la instancia de un FB.
Pueden usarse como nombre:
● El nombre de un DB de instancia individual. En ese caso se mostrará su FB. Ejemplo
"Station1"
● El nombre de una multiinstancia en un DB de instancia. En ese caso se mostrará su FB.
La especificación de la ruta del nombre de la multiinstancia está sujeta a una jerarquía de
datos que se muestra, p. ej., en el editor DB, y no a la Call Structure. La primera parte del
nombre ("Line1") no debe ir entre comillas, ya que del contexto se deduce que se trata de
un símbolo global. Las comillas son necesarias para los distintos componentes del nombre
en los que aparezcan caracteres especiales como espacios en blanco, puntos u otros.
Ejemplo: "Line1.Cell1.Station1"
● El nombre de un FC u OB
No se permite usar el nombre de un FB.
lpszCalledBlock
Nombre de la instancia local o global que se llama en el bloque de código correspondiente a
lpszContainingBlock.
● En las instancias locales debe agregarse aquí el carácter almohadilla (#), p. ej., "#feeder1".
● En los DB de instancia global debe especificarse el nombre global sin #, p. ej., "feeder3".
Se permite usar el nombre de un FC.
Si se llama varias veces lpszCalledBlock dentro de lpszContainingBlock o de su FB, se salta
siempre a la primera llamada de lpszCalledBlock.
lpszPin
El nombre de un pin de entrada de lpszCalledBlock. Este parámetro sirve para que en el visor
de código PLC se muestre el segmento que está conectado con el pin de entrada.
lpdmError
Puntero hacia los datos del mensaje de error ampliado en la estructura CMN_ERROR. En
caso de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
La función se ha ejecutado correctamente.
FALSE
Se ha producido un error.
Archivos requeridos
kopapi.h
kopapi.lib
kopapi.dll
Ejemplo
El ejemplo muestra la integración de la llamada a función en una función C definida por el
usuario. Para un mantenimiento más fácil, es recomendable transferir la llamada a una función
Global Script en la que también se definirá el nombre de la estación PLC.
Consulte también
Tratamiento de errores (Página 1136)
Principios básicos (Página 1124)
Descripción
La función muestra en los lenguajes de PLC KOP y FUP, la preconexión de una entrada de
segmento de un bloque estándar en el visor de código PLC considerando la instancia UDT.
Nota
Si la entrada está ocupada con una constante (TRUE, FALSE), este valor no se muestra en
el visor de código PLC. Para mostrar el valor correctamente en el visor de código PLC, debe
ocupar la entrada con una variable que tenga el valor correspondiente.
Declaración
BOOL OpenViewerIECPLByFCCall (
DWORD dwFlags,
LPCTSTR lpszServerPrefix,
LPCTSTR lpszPictureName,
LPCTSTR lpszObjectName,
LPCTSTR lpszCpuName,
LPCTSTR lpszContainingBlock,
LPCTSTR lpszCalledBlock,
LPCTSTR lpszPin,
LPCTSTR lpszUdtInstance
LPCMN_ERROR lpdmError);
Parámetros
dwFlags
Campo de bits en el que los distintos valores se combinan bit a bit con el operador lógico O.
dwFlags debe ser por defecto 0.
● IECPLVIEWER_PIN_SUBSTRING_SEARCH=0x0001: en la búsqueda del nombre de pin
se busca una cadena parcial, es decir, el nombre de pin empieza con la cadena de
caracteres enviada en lpszPin. Si este bit no está activado, se compara el nombre de pin
completo con lpszPin.
lpszServerPrefix
El parámetro se reserva para futuras ampliaciones y debe consistir en una cadena vacía ("").
lpszPictureName
Nombre de la imagen con el visor de código PLC.
lpszObjectName
Nombre del visor de código PLC.
lpszCpuName
Nombre de la CPU S7. El nombre es idéntico al nombre de estación que se muestra en el
árbol de proyecto en el TIA Portal.
lpszContainingBlock
Nombre del bloque que se abrirá y visualizará o nombre de la instancia de un FB.
Pueden usarse como nombre:
● El nombre de un DB de instancia individual. En ese caso se mostrará su FB. Ejemplo
"Station1"
● El nombre de una multiinstancia en un DB de instancia. En ese caso se mostrará su FB.
La especificación de la ruta del nombre de la multiinstancia está sujeta a una jerarquía de
datos que se muestra, p. ej., en el editor DB, y no a la Call Structure. La primera parte del
nombre ("Line1") no debe ir entre comillas, ya que del contexto se deduce que se trata de
un símbolo global. Las comillas son necesarias para los distintos componentes del nombre
en los que aparezcan caracteres especiales como espacios en blanco, puntos u otros.
Ejemplo: "Line1.Cell1.Station1"
● El nombre de un FC u OB
No se permite usar el nombre de un FB.
lpszCalledBlock
Nombre de la instancia local o global que se llama en el bloque de código correspondiente a
lpszContainingBlock.
● En las instancias locales debe agregarse aquí el carácter almohadilla (#), p. ej., "#feeder1".
● En los DB de instancia global debe especificarse el nombre global sin #, p. ej., "feeder3".
Se permite usar el nombre de un FC.
Si se llama varias veces lpszCalledBlock dentro de lpszContainingBlock o de su FB, se salta
siempre a la primera llamada de lpszCalledBlock.
lpszPin
El nombre de un pin de entrada de lpszCalledBlock. Este parámetro sirve para que en el visor
de código PLC se muestre el segmento que está conectado con el pin de entrada.
lpszUdtInstance
El parámetro permite limitar la visualización de FB o FC llamados varias veces. La limitación
se efectúa por medio de la instancia UDT interconectada con un pin de entrada o pin de
entrada y salida cualquiera.
lpdmError
Puntero hacia los datos del mensaje de error ampliado en la estructura CMN_ERROR. En
caso de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
La función se ha ejecutado correctamente.
FALSE
Se ha producido un error.
Archivos requeridos
kopapi.h
kopapi.lib
kopapi.dll
Ejemplo
El ejemplo muestra la integración de la llamada a función en una función C definida por el
usuario. Para un mantenimiento más fácil, es recomendable transferir la llamada a una función
Global Script en la que también se definirá el nombre de la estación PLC.
Descripción
La función muestra, en los lenguajes de PLC KOP y FUP, la asignación a un operando y su
preconexión en el visor de código PLC.
Declaración
BOOL OpenViewerIECPLByAssignment (
DWORD dwFlags,
LPCTSTR lpszServerPrefix,
LPCTSTR lpszPictureName,
LPCTSTR lpszObjectName,
LPCTSTR lpszCpuName,
LPCTSTR lpszContainingBlock,
LPCTSTR lpszOperand,
LPCMN_ERROR lpdmError);
Parámetros
dwFlags
Campo de bits en el que los distintos valores se combinan bit a bit con el operador lógico O.
dwFlags debe ser por defecto 0.
lpszServerPrefix
El parámetro se reserva para futuras ampliaciones.
lpszPictureName
Nombre de la imagen con el visor de código PLC.
lpszObjectName
Nombre del visor de código PLC.
lpszCpuName
Nombre de la CPU S7. El nombre es idéntico al nombre de estación que se muestra en el
árbol de proyecto en el TIA Portal.
lpszContainingBlock
Nombre del bloque que se abrirá y visualizará o nombre de la instancia de un FB.
lpszOperand
Nombre de un operando local o global al que se hace referencia.
Nombre de la instancia local o global que se llama en el bloque de código correspondiente a
lpszContainingBlock.
● En los operandos locales debe agregarse aquí el carácter almohadilla (#).
● En los operandos globales debe especificarse el nombre global sin #.
Si se escribe varias veces lpszOperand dentro de lpszContainingBlock o de su FB, se salta
siempre al primer acceso de escritura de lpszOperand.
lpdmError
Puntero hacia los datos del mensaje de error ampliado en la estructura CMN_ERROR. En
caso de error, el sistema escribe informaciones de error en esta estructura.
Valor de retorno
TRUE
La función se ha ejecutado correctamente.
FALSE
Se ha producido un error.
Archivos requeridos
kopapi.h
kopapi.lib
kopapi.dll
Ejemplo
El ejemplo muestra la integración de la llamada a función en una función C definida por el
usuario. Para un mantenimiento más fácil, es recomendable transferir la llamada a una función
Global Script en la que también se definirá el nombre de la estación PLC.
Consulte también
Tratamiento de errores (Página 1136)
Principios básicos (Página 1124)
Generalidades
El procesamiento de las funciones para el salto de red se divide entre una parte síncrona y
una parte asíncrona. La parte síncrona comprueba los parámetros y los transfiere a la parte
asíncrona.
El valor de retorno de las funciones indica si en la parte síncrona de la función se ha producido
un error. En caso de error, el valor de retorno es FALSE. Este tipo de errores se producen
cuando no se envían datos (o se envían datos erróneos) a los parámetros, p. ej., el parámetro
lpszErrorTag.
Los errores que se producen en la parte asíncrona de las funciones se devuelven con el
parámetro lpszErrorTag. Este tipo de errores pueden ser, p. ej.: proyecto no encontrado,
bloque no disponible... lpszErrorTag contiene el nombre de una variable del tipo de datos
String. Para poder responder al valor de retorno, debe configurarse una función que se dispare
con el ciclo "Por cambio" al cambiar el valor de la variable de error. La variable de error también
debe utilizarse para impedir otras llamadas a funciones o la activación de un botón, p. ej.,
mientras la variable de error tenga el valor "RUNNING".
lpszErrorTag
Nombre de una variable del tipo de datos String. Si la variable no es necesaria, puede
transferirse NULL como parámetro. En caso necesario, el nombre de la variable puede incluir
un prefijo de servidor.
El valor de las variables de error se modifica del siguiente modo:
● Cuando se inicia la parte asíncrona, se ajusta el valor de la variable de error a "RUNNING".
● Si la parte asíncrona finaliza sin errores, se ajusta el valor de la variable de error a "OK".
● Si la parte asíncrona finaliza con error, la variable de error contiene una cadena de varias
líneas separadas por caracteres de salto de línea ('\n').
En caso de error, la variable de error presenta la siguiente estructura:
● Línea 1: "ERROR"
● Línea 2 - línea 6: números decimales, tipo de datos: 32 bits sin signo; DWORD
● Línea 7: texto de error
Texto de error
Si la parte asíncrona finaliza con error, la variable de error contiene una cadena de varias
líneas separadas por caracteres de salto de línea ('\n'). La séptima línea contiene uno de los
siguientes textos de error:
Descripción
La estructura de error avanzada CMN_Error contiene el código de error y un texto sobre el
error ocurrido. Cada aplicación puede utilizar la estructura de error para la evaluación o para
la emisión de mensajes de error.
Declaración
Typedef struct {
DWORD dwError1;
DWORD dwError2;
DWORD dwError3;
DWORD dwError4;
DWORD dwError5;
Char szErrorText[512];
}
CMN_ERROR;
Members
dwError1 .. dwError5
Las descripciones API contienen en cada caso la información acerca de qué valores contienen
las entradas en caso de error. Si no se indica lo contrario, los códigos de error se encuentran
en dwError1.
szErrorText
Búfer para la descripción textual de la causa del error. El contenido se determina a partir de
los recursos y suele depender del idioma.
Observación
Dependiendo de la necesidad, algunos módulos utilizan las siguientes asignaciones de los
códigos de error
Consulte también
Mensajes de error (Página 206)
Descripción
Acusa todos los avisos seleccionados.
Utilice esta función de sistema si el panel de operador no tiene ninguna tecla de acuse o si
no debe emplearse la tecla integrada del visor de avisos.
Esta función de sistema sólo se puede utilizar para teclas de función.
Parámetros
--
Descripción
Cambia a la imagen que estaba activada antes de cambiar a la imagen actual. El cambio de
imagen no se ejecuta si antes no había ninguna imagen activa.
Se guardan las últimas 10 imágenes activadas. Si cambia a una imagen que ya no está
guardada, aparecerá un aviso del sistema.
Nota
Si desea utilizar la función de sistema, la imagen a la que desea cambiar deberá estar
contenida en la estructura de navegación.
Parámetros
--
Descripción
Efectúa un cambio de imagen para visualizar la imagen indicada.
Para conmutar entre la imagen raíz y la ventana permanente, y viceversa, utilice la función
de sistema "ActivarImagenConNúmero".
Parámetros
Nombre de imagen
Nombre de la imagen a la que se cambia.
Ejemplo
El siguiente código de programa activa la imagen "Screen_2" con la función ActivateScreen
al pulsar cualquier tecla.
Descripción
Dependiendo del valor de una variable, cambia a una imagen determinada.
La imagen se identifica por su número de imagen.
Parámetros
Número de imagen
Variable que contiene el número de imagen a la que se cambia.
Si desea conmutar entre la imagen raíz y la ventana permanente, y viceversa, introduzca "0"
o "-1", respectivamente.
0 = Cambia de la imagen raíz a la ventana permanente.
-1 = Cambia de la ventana permanente a la imagen raíz.
Descripción
Activa el visor de diagnóstico del sistema. El visor de diagnóstico del sistema muestra la vista
detallada del dispositivo afectado.
Utilizable, siempre que el dispositivo configurado soporte funciones definidas por el usuario.
Encontrará más información al respecto en "Dependencia del dispositivo".
Parámetros
Nombre de imagen
Nombre de la imagen que contiene el visor de diagnóstico del sistema.
Objeto de imagen
Nombre de objeto del visor de diagnóstico del sistema.
Descripción
Esta función de sistema desplaza o copia un fichero para archivarlo a largo plazo en una
ubicación diferente.
Utilice en el caso de los Audit Trails siempre el modo "Desplazar (hmiMove)", puesto que de
lo contrario se infringirá la directiva FDA debido a la doble gestión de datos.
Antes de"ArchivarArchivoDeInforme" ejecute siempre la función de sistema
"CerrarTodosLosFicheros".
Tras concluir esta función de sistema, ejecute la función de sistema "AbrirTodosLosFicheros".
En el modo "Copiar fichero", los ficheros se vuelven a abrir sólo tras haberse copiado
correctamente el fichero, o bien si se excede el tiempo previsto para la operación de copia.
En el modo "Desplazar fichero" se cambia el nombre de los ficheros a desplazar y se abren
de inmediato los nuevos ficheros. Para desplazar los ficheros cuyo nombre ha cambiado, se
lanza una petición que intenta desplazarlos cada 300 segundos en caso de que el servidor
no esté disponible. Dicha petición permanece activa hasta ser ejecutada, incluso después de
un rearranque completo del runtime.
Parámetros
Tipo de fichero
Determina el tipo de fichero:
0 (hmiTagArchive) = Fichero de variables
1 (miAlarmArchive) = Fichero de avisos
2 (hmiAudittrailArchive)= Fichero Audit Trail disponible en proyectos conformes a GMP.
Encontrará más información en "Activar configuración conforme a GMP".
Fichero
Nombre del fichero a archivar.
Modo
0 (hmiCopy) = Copiar fichero
1 (hmiMove) = Desplazar fichero
Ejemplo de aplicación
Hay que desplazar un fichero del medio de almacenamiento local al servidor con el fin de crear
una copia de seguridad en intervalos regulares.
Indicaciones relativas a la configuración
En el planificador de tareas, cree una tarea que se ejecute cada día a una hora determinada.
Asocie la lista de funciones siguiente a la tarea:
Descripción
Guarda el sistema de archivos RAM en el soporte de memoria del panel de operador.
Tras reiniciar el panel de operador volverán a cargarse automáticamente los datos en el
sistema de archivos RAM.
Las aplicaciones como el Internet Explorer guardan datos temporalmente en el sistema de
archivos DRAM del panel de operador (p.ej. las últimas páginas web llamadas).
Parámetros
--
Descripción
Llama un programa para calibrar la pantalla táctil.
Durante la calibración se pedirá al operador que toque cinco posiciones en la pantalla táctil.
Para confirmar el proceso de calibración, toque la pantalla táctil en un intervalo de 30
segundos. Si no toca la pantalla táctil dentro de ese intervalo, los ajustes de calibrado se
rechazan. La guía del usuario está en inglés.
Utilice esta función de sistema al poner en marcha el panel de operador por primera vez.
Parámetros
--
Nota
La función de sistema CalibrarPantallaTáctil no puede ser simulada.
Descripción
Deshace la conexión con el controlador que se está utilizando y establece una conexión con
un controlador en una dirección distinta. El controlador recién conectado debe pertenecer a
la misma clase de dispositivos (S7-1200, S7-300, ...etc.). Además, en el S7-1200 la utilización
de la función sólo es admisible con direccionamiento absoluto.
Nota
Al cambiar a una dirección diferente, vigile que esta dirección no esté siendo utilizada por otro
panel de operador.
Parámetros
Conexión
Nombre de la conexión que se desconecta. El nombre se establece en el editor "Conexiones"
durante el proceso de configuración.
Dirección
Dirección MPI/PROFIBUS o IP del controlador con el que se establece la conexión.
Nota
La dirección se establece mediante una variable. La lista de objetos muestra variables de todo
los tipos. Seleccione exclusivamente variables de los siguientes tipos:
● Conexión Ethernet: Tipo de datos "String"
● Conexión MPI: Tipos de datos "Int"
Slot
Slot del controlador con el que se establece la conexión.
Rack
Rack del controlador con el que se establece la conexión.
Ejemplo de aplicación
Desea utilizar un panel de operador junto con varias máquinas. Configure para ello en el
proyecto los autómatas necesarios a los que desea cambiar pulsando un botón. Al cambiar
de controlador se deshace la conexión con el controlador utilizado actualmente. A
continuación, la conexión se establece con el nuevo controlador, utilizando parámetros de
direccionamiento diferentes. Para acceder a los valores del nuevo controlador, configure las
mismas variables para el controlador utilizado.
Se utiliza por defecto el controlador especificado al crear el proyecto.
1. En el editor "Conexiones", indique el nombre y la dirección del controlador.
2. Configure un botón en la imagen del proceso.
3. Asocie el evento "Pulsar" a la función de sistema "CambiarConexión".
4. Introduzca como parámetros el nombre de la conexión y la dirección del controlador.
Descripción
Borra avisos del búfer de avisos en el panel de operador.
Nota
Los avisos no acusados también se borran.
Parámetros
Número de categoría
Determina qué avisos se deben borrar del búfer de avisos:
0 (hmiAll) = Todos los avisos
1 (hmiAlarms) = Avisos de la categoría "Errors"
2 (hmiEvents) = Avisos de la categoría "Warnings"
3 (hmiSystem) = Avisos de la categoría "System"
4 (hmiS7Diagnosis) = Avisos de la categoría "Diagnosis Events"
Nota
Dependencia del dispositivo
Los avisos de la categoría "Diagnosis Events" no están disponibles en Basic Panels.
Descripción
Esta función de sistema existe por motivos de compatibilidad.
Parámetros
Número de categoría
Número de la categoría cuyos avisos se borrarán:
-1 (hmiAllProtoolLegacy) = Todos los avisos
0 (hmiAlarmsProtoolLegacy) = Avisos de la categoría "Errors"
1 (hmiEventsProtoolLegacy) = Avisos de la categoría "Warnings"
2 (hmiSystemProtoolLegacy) = Avisos de la categoría "System"
3 (hmiS7DiagnosisProtoolLegacy) = Avisos de la categoría "Diagnosis Events"
Nota
Dependencia del dispositivo
Los avisos de la categoría "Diagnosis Events" no están disponibles en Basic Panels.
Descripción
Borra un registro de receta.
Es posible borrar varios registros en una o varias recetas.
Parámetros
Número/Nombre de receta
Número o nombre de la receta de la que se deben borrar los registros. Indique "0" si desea
borrar registros de todas las recetas disponibles.
Número/Nombre de registro
Número o nombre del registro de receta que se borrará. Indique "0" si desea borrar todos los
registros de receta.
Confirmación
Determina si el operador debe confirmar el borrado:
0 (hmiOff) = OFF: El proceso de borrado se inicia sin confirmación.
1 (hmiOn) = ON: El inicio del proceso de borrado debe confirmarse.
Estado de procesamiento
Indica el estado de procesamiento de la función de sistema. Utilice el valor de retorno p. ej.
para ejecutar otras funciones de sistema solo tras haber ejecutado correctamente esta función:
2 = La función de sistema se está ejecutando actualmente.
4 = La función de sistema se ha ejecutado correctamente.
12 = La función de sistema no se ha ejecutado porque se ha producido un error.
Descripción
Borra todos los registros de receta del medio de almacenamiento indicado.
Parámetros
Ubicación
Determina la ubicación:
0 (hmiFlashMemory) = memoria flash: Memoria flash interna del panel de operador
1 (hmiStorageCard) = Storage Card
2 (hmiStorageCard2) = Storage Card 2
3 (hmiStorageCard3) = Storage Card MultiMediaCard
4 (hmiStorageCard4) = Storage Card USB
Confirmación
Determina si el operador debe confirmar el borrado:
0 (hmiOff) = OFF: El proceso de borrado se inicia sin confirmación.
1 (hmiOn) = ON: El inicio del proceso de borrado debe confirmarse.
Estado de procesamiento
Indica el estado de procesamiento de la función de sistema. Utilice el valor de retorno p. ej.
para ejecutar otras funciones de sistema sólo tras haber ejecutado correctamente esta función:
2 = La función de sistema se está ejecutando actualmente.
4 = La función de sistema se ha ejecutado correctamente.
12 = La función de sistema no se ha ejecutado porque se ha producido un error.
Descripción
Borra todos los registros del fichero indicado.
Parámetros
Tipo de fichero
Determina el tipo de fichero.
0 (hmiTagArchive) = Fichero de variables
1 (hmiAlarmArchive) = Fichero de avisos
2 (hmiAudittrailArchive) = Fichero Audit Trail. Disponible en proyectos conformes a GMP.
Encontrará más información en "Activar configuración conforme a GMP".
Fichero
Nombre del fichero del que se borrarán todas las entradas.
Descripción
Deshace la conexión entre WinCC y todos los ficheros.
Nota
Antes de cerrar un fichero es preciso detener la archivación en dicho fichero. Utilice para ello
la función de sistema "PararArchivar".
Parámetros
--
Ejemplo de aplicación
Desea cambiar en runtime el soporte de datos en el que se archivan los valores de proceso.
Indicaciones relativas a la configuración
Configure las funciones de sistema "PararArchivación" y "CerrarTodosLosFicheros" y
asócielas al botón "Close Archive".
Configure las funciones de sistema "AbrirTodosLosFicheros" e "IniciarArchivación" y asócielas
al botón "Open Archive".
Transfiera como parámetro el nombre del fichero que se debe parar o iniciar, respectivamente.
Proceso en el panel de operador
Cuando pulse el botón "Close Archive" se parará el fichero indicado y se cerrarán los ficheros
abiertos. A continuación podrá cambiar el soporte de datos. Con el botón "Open Archive" se
abren todos los ficheros. La archivación continúa en el fichero indicado.
Descripción
Inicia o detiene el Sm@rtServer.
Parámetros
Modo
Determina si el Sm@rtServer se debe iniciar o detener.
-1 (hmiToggle) = Conmutar: Conmuta entre ambos estados.
0 (hmiStop) = Detener: Detener el Sm@rtServer
1 (hmiStart) = Iniciar: Iniciar el Sm@rtServer
Descripción
Inicia o detiene el servidor web.
Parámetros
Modo
Determina si el servidor web se debe iniciar o detener.
-1 (hmiToggle) = Conmutar: Conmuta entre ambos estados.
0 (hmiStop) = Detener: El servidor web se detiene
1 (hmiStart) = Iniciar: El servidor web se inicia
Descripción
Copia el contenido de un fichero en un fichero diferente. Los valores de variables sólo se
pueden copiar en otros ficheros de variables, en tanto que los avisos sólo se pueden copiar
en otros ficheros de avisos.
Nota
Al copiar un fichero con la función de sistema "CopiarFichero" puede suceder que las
aplicaciones de terceros no puedan leer los caracteres especiales contenidos en los textos
de los avisos archivados en la copia del fichero. WinCC Runtime no se ve afectado. WinCC
Runtime puede leer los ficheros copiados sin problema alguno.
Nota
Al copiar los ficheros circulares, se copia un 80% de las entradas del fichero. El 20% de las
entradas no se copia porque el espacio de memoria está reservado de forma estándar para
el desbordamiento del búfer.
Parámetros
Tipo de fichero
Determina el tipo de fichero:
0 (hmiTagArchive) = Fichero de variables
1 (hmiAlarmArchive) = Fichero de avisos
Fichero de destino
Nombre del fichero al que se copian las entradas (fichero de destino).
Fichero de origen
Nombre del fichero desde el que se copian las entradas (fichero de origen).
Modo
Determina cómo se debe proceder con las entradas en el fichero de destino:
0 (hmiOverwrite) = Sobrescribir: Las entradas existentes se sobrescriben.
2 (hmiAppend) = Agregar: Las entradas se insertan al final del fichero de destino. Una vez
alcanzado el tamaño configurado del fichero de destino, éste se tratará como un fichero
circular.
Descripción
Resta el valor indicado del valor de la variable.
X=X-a
Nota
La función de sistema utiliza la misma variable como valor de entrada y como valor de salida.
Si utiliza esta función de sistema para convertir un valor, deberá utilizar una variable auxiliar.
A la variable auxiliar se le asigna un valor con la función de sistema "DefinirVariable".
Parámetros
Variable
Variable de la que se debe restar el valor indicado.
Valor
Valor que se va a restar.
Descripción
Lanza el evento "Edición" para todos los avisos seleccionados.
Si no ha acusado todavía los avisos a editar, el acuse se efectuará automáticamente al
ejecutarse esta función de sistema.
Esta función de sistema sólo se puede utilizar para teclas de función.
Parámetros
--
Descripción
Adapta el tipo de datos "String" de una variable para la transferencia al sistema de
automatización (AS). La variable del tipo de datos "String" de WinCC se convierte al tipo de
datos del AS "Array of Byte". El resultado se escribe en una variable.
Parámetros
Matriz de bytes
Variable que contiene el valor convertido.
Nota
El tamaño de la matriz de bytes debe doblar la longitud de la cadena +2. Si la cadena tiene
una longitud de 120 caracteres, la matriz de bytes debe comprender 242 elementos.
Si el tamaño no es suficiente, se truncan algunos caracteres o no se convierten.
Cadena de caracteres
Variable del tipo de datos "String" que se debe convertir.
Codificar
0 (hmiEncodeUTF16LE) - String se codifica a UTF16LE (Unicode 16 Little Endian).
Descripción
Adapta el tipo de datos "String" de una variable para la transferencia al sistema de
automatización (AS). La variable del tipo de datos "String" de WinCC se convierte al tipo de
datos del AS "Array of Byte". El resultado se escribe en una variable.
A diferencia de la función de sistema Codificar, es posible definir el parámetro Salto de línea.
El parámetro Salto de línea sirve para borrar los saltos de línea o reemplazarlos por caracteres
predefinidos.
Parámetros
Matriz de bytes
Variable que contiene el valor convertido.
Nota
El tamaño de la matriz de bytes debe doblar la longitud de la cadena +2. Si la cadena tiene
una longitud de 120 caracteres, la matriz de bytes debe comprender 242 elementos.
Si el tamaño no es suficiente, se truncan algunos caracteres o no se convierten.
Cadena de caracteres
Variable del tipo de datos "String" que se debe convertir.
Codificación
0 (hmiEncodeUTF16LE) - String se codifica a UTF16LE (Unicode 16 Little Endian).
Salto de línea
Todos los saltos de línea se borran o se reemplazan por caracteres predefinidos. El ajuste
estándar es que no se reemplacen los saltos de línea.
0 (reemplazar por "\r\n' (0x000D, 0x000A)) - los saltos de línea se reemplazan por "\r\n".
1 (reemplazar por "\n' (0x000A)) - los saltos de línea se reemplazan por "\n".
2 (no reemplazar) - los saltos de línea no se reemplazan.
Descripción
Establece la conexión PROFIsafe para el modo de seguridad positiva entre un KTP Mobile
Panel y el controlador si previamente se ha deshecho con PROFIsafeDesconectar.
Nota
Solo es posible establecer una conexión para la comunicación PROFIsafe si el panel de
operador funciona en modo "online". Utilice para ello la función de sistema
"EstablecerModoDeOperaciónPanel".
Parámetros
--
Descripción
Exporta uno o todos los registros de una receta a un archivo CSV.
Se crea un archivo para cada receta.
Parámetros
Número/nombre de receta
Número/nombre de la receta de la que se deben exportar los registros. Introduzca "0" si desea
exportar registros de todas las recetas disponibles.
Nombre de archivo
Nombre del archivo CSV al que se deben exportar los registros de receta. Introduzca también
la ubicación y la extensión del archivo (*.csv), p. ej. "C:\TEMP\Orange.csv", para Basic Panels
"\USB_X61.1\Orange.csv".
Nota
Almacenamiento del archivo CSV
No vale para Basic Panels:
● Si utiliza una tarjeta de memoria como ubicación, introduzca esta última del siguiente modo:
"\StorageCard\<nombre del archivo>".
● Si define sólo un nombre de archivo y no una ruta, el archivo se guardará en un directorio
del sistema, p. ej. "C:\Documents and Settings\[User]".
● Si sólo se indica una ruta para la exportación, el nombre del archivo se genera
automáticamente a partir del nombre de la receta. Para ello, es imprescindible que la
carpeta esté creada, p. ej. "D:\Temp\". Si la carpeta "D:\Temp" no está creada, se utilizará
su nombre como prefijo para el nombre de archivo, Temp_nombre de receta.csv.
Número/nombre de registro
Número/nombre del registro de receta que se exportará. Introduzca "0" si desea exportar todos
los registros de receta.
Sobrescribir
Determina si se debe sobrescribir un archivo CSV existente de igual nombre:
0 (hmiOverwriteForbidden) = No: El archivo CSV no se sobrescribirá. El proceso de
exportación no se ejecutará.
1 (hmiOverwriteAlways) = Sí: El archivo CSV se sobrescribirá sin consulta previa.
2 (hmiOverwriteWithPrompting) = Tras confirmar: El archivo CSV se sobrescribirá tras haberse
confirmado la consulta de seguridad.
Estado de procesamiento
Indica el estado de procesamiento de la función de sistema. Utilice el valor de retorno p. ej.
para ejecutar otras funciones de sistema sólo tras haber ejecutado correctamente esta función:
2 = La función de sistema se está ejecutando actualmente.
4 = La función de sistema se ha ejecutado correctamente.
12 = La función de sistema no se ha ejecutado porque se ha producido un error.
Ejemplo de aplicación
Desea exportar todos los objetos pulsando una tecla.
Indicaciones relativas a la configuración
Configure la función de sistema "ExportarRegistros" asociada al evento "Pulsar" de la tecla
deseada. Transfiera los parámetros siguientes:
● Número/nombre de receta = 1
● Número/nombre de registro = 0
● Nombre de archivo = c:\temp\orange.csv, para Basic Panels "\USB_X61.1\orange.csv"
● Sobrescribir = 1
● Emitir aviso de estado = 1
Si lo desea, puede indicar variables en lugar de constantes. Dependiendo de la configuración,
el operador puede introducir los valores deseados en los campos E/S, o bien leerlos del
controlador. De este modo, el operador puede determinar qué registros de receta se
exportarán.
Proceso en el panel de operador
La función de sistema se ejecuta tras pulsar la tecla. Las constantes o las variables se evalúan.
Todos los registros de la receta 1 se exportan al archivo orange.csv. Si el archivo ya existe,
éste se sobrescribe.
Descripción
Exporta uno o todos los registros de una receta a un archivo CSV y genera una suma de
verificación para cada fila del archivo.
Se crea un archivo para cada receta.
Parámetros
Número/Nombre de receta
Número/nombre de la receta de la que se deben exportar los registros. Introduzca "0" si desea
exportar registros de todas las recetas disponibles.
Número/Nombre de registro
Número/nombre del registro de receta que se exportará. Introduzca "0" si desea exportar todos
los registros de receta.
Nombre de archivo
Nombre del archivo CSV al que se deben exportar los registros de receta. Introduzca también
la ruta y la extensión del archivo, p. ej., "C:\TEMP\Orange.CSV".
Si utiliza una tarjeta de memoria como ubicación, introduzca esta última del siguiente modo:
"\StorageCard\<nombre del archivo>".
Si define sólo un nombre de archivo y no una ruta, el archivo se guardará en el directorio
desde el que se inició el runtime. Si en el sistema operativo Windows 7 no se dispone de
derechos de escritura para este directorio, el archivo se guardará en el directorio de usuario,
en la carpeta "VirtualStore".
Si solo indica la ruta para la exportación, el nombre del archivo se genera automáticamente
a partir del nombre de la receta. Para ello se tiene que haber creado el directorio, p. ej. "D:
Sobrescribir
Determina si se debe sobrescribir un archivo CSV existente de igual nombre:
0 (hmiOverwriteForbidden) = No: El archivo CSV no se sobrescribirá. El proceso de
exportación no se ejecutará.
1 (hmiOverwriteAlways) = Sí: El archivo CSV se sobrescribirá sin consulta previa.
2 (hmiOverwriteWithConfirmation) = Tras confirmar: El archivo CSV se sobrescribirá tras
haberse confirmado la consulta de seguridad.
Estado de procesamiento
Indica el estado de procesamiento de la función de sistema. Utilice el valor de retorno p. ej.
para ejecutar otras funciones de sistema sólo tras haber ejecutado correctamente esta función:
2 = La función de sistema se está ejecutando actualmente.
4 = La función de sistema se ha ejecutado correctamente.
12 = La función de sistema no se ha ejecutado porque se ha producido un error.
Ejemplo de aplicación
Pulsando una tecla desea exportar todos los registros y asignarles una suma de verificación.
Indicaciones relativas a la configuración
Descripción
Exporta todos los usuarios de la administración de usuarios del proyecto activo en este
momento al archivo indicado, o bien importa los usuarios del archivo indicado al proyecto
activo en este momento.
En la administración de usuarios se guardan usuarios, sus contraseñas y permisos.
Durante la importación se sobrescriben todos los usuarios. Los usuarios importados son
válidos desde el primer momento.
Parámetros
Nombre de archivo
Nombre del archivo que contiene las contraseñas o en el que se guardarán las contraseñas.
Introduzca también la ruta y la extensión del archivo (*.txt), p. ej. "C:\TEMP\Passwords.txt".
Nota
Si utiliza una tarjeta de memoria como ubicación, introduzca ésta última del siguiente modo:
"\StorageCard\<nombre del archivo>".
Dirección
Determina si las contraseñas se exportarán o importarán:
0 (hmiExport) = Exportación: Las contraseñas se exportan.
1 (hmiImport) = Importación: Las contraseñas se importan.
Descripción
Lee el valor del brillo.
Parámetros
Brillo
Variable en la que se escribe el valor.
Descripción
Transfiere el registro de receta indicado del controlador al medio de almacenamiento del panel
de operador.
Parámetros
Número/Nombre de receta
Número o nombre de la receta de la que se deben transferir los registros.
Número/Nombre de registro
Número o nombre del registro de receta que se debe transferir del controlador al medio de
almacenamiento del panel de operador.
Sobrescribir
Determina si se debe sobrescribir un registro de receta existente de igual nombre:
0 (hmiOverwriteForbidden) = No: El registro de receta no se sobrescribe. El proceso de
transferencia no se ejecuta.
1 (hmiOverwriteAlways) = Sí: El registro de receta se sobrescribe sin consulta previa.
2 (hmiOverwriteWithPrompting) = Tras confirmar: El registro de receta se sobrescribe tras
haberse confirmado la consulta de seguridad.
Estado de procesamiento
Indica el estado de procesamiento de la función de sistema. Utilice el valor de retorno p. ej.
para ejecutar otras funciones de sistema sólo tras haber ejecutado correctamente esta función:
Ejemplo de aplicación
Debe transferirse un registro del controlador al medio de almacenamiento del panel de
operador por medio de una tecla.
Indicaciones relativas a la configuración
Configure la función de sistema "LeerRegistroDelControlador" asociada al evento "Pulsar" de
la tecla deseada. Transfiera los parámetros siguientes:
Número/nombre de receta = 1
Número/nombre de registro = 1
Sobrescribir = 1
Emitir aviso de estado = 1
Si lo desea, puede indicar variables en lugar de constantes. Dependiendo de la configuración,
el operador puede introducir los valores deseados en los campos E/S, o bien leerlos del
controlador. De este modo, el operador puede determinar qué registro de receta se transferirá
del controlador.
Proceso en el panel de operador
La función de sistema se ejecuta tras pulsar la tecla. Las constantes o variables se evalúan
y el primer registro de la receta 1 se transfiere del controlador al medio de almacenamiento
del panel de operador. Si dicho registro ya existe, se sobrescribe.
Después de la transferencia se visualiza un aviso de sistema.
Descripción
Escribe los nombres de la receta indicada y del registro de receta indicado en las variables
especificadas.
Nota
Si la receta o el registro de receta no existe, se escriben comodines ("###") en las variables.
Parámetros
Número de receta
Número de la receta cuyo nombre se escribe en la variable indicada.
Número de registro
Número del registro de receta cuyo nombre se escribe en la variable indicada.
Nombre de receta
Variable en la que se escribe el nombre de la receta. La variable debe ser del tipo STRING.
Nombre de registro
Variable en la que se escribe el nombre del registro de receta. La variable debe ser del tipo
STRING.
Estado de procesamiento
Indica el estado de procesamiento de la función de sistema. Utilice el valor de retorno p. ej.
para ejecutar otras funciones de sistema sólo tras haber ejecutado correctamente esta función:
2 = La función de sistema se está ejecutando actualmente.
4 = La función de sistema se ha ejecutado correctamente.
12 = La función de sistema no se ha ejecutado porque se ha producido un error.
Ejemplo de aplicación
Los nombres de la receta indicada y del registro de receta indicado se visualizan en el panel
de operador.
Configure las variables siguientes:
● "RecNumber" del tipo INTEGER
● "RecDataNumber" del tipo INTEGER
● "RecName" del tipo STRING
● "RecDataName" del tipo STRING
Configure un visor de recetas con las variables "RecNumber" para el número de receta y
"RecDataNumber" para el número de registro.
Descripción
Transfiere a las variables de receta los valores del registro de receta cargado en el
controlador.
Utilice esta función de sistema p. ej. en el modo de aprendizaje (Teach-In) en una máquina.
Parámetros
Número/Nombre de receta
Número o nombre del registro de receta cuyos valores se escriben del controlador a la variable.
Estado de procesamiento
Indica el estado de procesamiento de la función de sistema. Utilice el valor de retorno p. ej.
para ejecutar otras funciones de sistema sólo tras haber ejecutado correctamente esta función:
2 = La función de sistema se está ejecutando actualmente.
4 = La función de sistema se ha ejecutado correctamente.
12 = La función de sistema no se ha ejecutado porque se ha producido un error.
Descripción
Lee el número del grupo al que pertenece el usuario registrado en el panel de operador y lo
escribe en la variable indicada.
Parámetros
Variable
Variable en la que se escribe el número del grupo.
Descripción
Lee la contraseña del usuario conectado al panel de operador y la escribe en la variable
indicada.
Nota
Asegúrese de que el valor de la variable indicada no aparece en ningún otro lugar del proyecto.
Nota
Las contraseñas de usuarios de SIMATIC Logon no se pueden leer.
Utilizable, siempre que el dispositivo configurado soporte funciones definidas por el usuario.
Encontrará más información al respecto en "Dependencia del dispositivo".
Parámetros
Variable
Variable en la que se escribe la contraseña.
Descripción
Escribe el nombre del usuario conectado actualmente al panel de operador en la variable
indicada.
Si la variable indicada contiene una conexión con el controlador, el nombre del usuario también
estará disponible en el controlador. Con esta función de sistema se pueden p. ej. liberar
determinadas funciones para usuarios específicos.
Parámetros
Variable
Variable en la que se escribe el nombre del usuario.
Descripción
Ejecuta la función de tecla <Fin> en el panel de operador.
Utilice esta función de sistema si la versión estándar del panel de operador no dispone de
esta funcionalidad.
Esta función de sistema sólo se puede utilizar para teclas de función.
Parámetros
--
Descripción
Ejecuta la función de tecla <Inicio> en el panel de operador.
Utilice esta función de sistema si la versión estándar del panel de operador no dispone de
esta funcionalidad.
Esta función de sistema sólo se puede utilizar para teclas de función.
Parámetros
--
Descripción
Importa uno o todos los registros de una receta de un archivo CSV.
Cuando se indica una ruta, se importan todos los archivos del directorio indicado.
Parámetros
Nombre de archivo
Nombre del archivo CSV del que se deben importar los registros de receta. Introduzca también
la ubicación y la extensión del archivo (*.csv), p. ej. "C:\TEMP\Orange.csv", para Basic Panels
"\USB_X61.1\Orange.csv".
Nota
No vale para Basic Panels: Si utiliza una tarjeta de memoria como ubicación, introduzca ésta
última del siguiente modo: "\StorageCard\<nombre del archivo>".
Número/nombre de registro
Número o nombre del registro de receta que se importará. Introduzca "0" si desea importar
todos los registros de receta.
Sobrescribir
Determina si se deben sobrescribir los registros de receta existentes:
0 (hmiOverwriteForbidden) = No: Los registros de receta no se sobrescriben. El proceso de
importación no se ejecuta.
1 (hmiOverwriteAlways) = Sí: Los registros de receta se sobrescribirán sin consulta previa.
2 (hmiOverwriteWithPrompting) = Tras confirmar: Los registros de receta se sobrescribirán
tras haberse confirmado la consulta de seguridad.
Estado de procesamiento
Indica el estado de procesamiento de la función de sistema. Utilice el valor de retorno p. ej.
para ejecutar otras funciones de sistema sólo tras haber ejecutado correctamente esta función:
2 = La función de sistema se está ejecutando actualmente.
4 = La función de sistema se ha ejecutado correctamente.
12 = La función de sistema no se ha ejecutado porque se ha producido un error.
Objetos configurables
Objeto Evento
Variable Modificación de valor
Límite superior excedido
Límite inferior excedido
Tecla de función (global) Soltar
Pulsar
Tecla de función (local) Soltar
Pulsar
Nombre de imagen Creada
Borrada
Objeto de imagen Pulsar
Soltar
Hacer clic
Modificar (o conmutar con el interruptor)
Conectar
Desconectar
Activar
Desactivar
Planificador de tareas Tiempo agotado
Descripción
Importa uno o todos los registros de una receta de un archivo CSV con suma de verificación
y verifica ésta última.
Parámetros
Nombre de archivo
Nombre del archivo CSV del que se deben importar los registros de receta. Introduzca también
la ruta y la extensión del archivo, p. ej., "C:\TEMP\Orange.CSV".
Si utiliza una tarjeta de memoria como medio de almacenamiento, introduzca la ruta del
siguiente modo: "\StorageCard\<nombre del archivo>".
Si se indica un directorio en lugar de un solo archivo CSV, se importarán todos los archivos
del directorio en cuestión.
Número/Nombre de registro
Número o nombre del registro de receta que se importará. Introduzca "0" si desea importar
todos los registros de receta.
Sobrescribir
Determina si se deben sobrescribir los registros de receta existentes:
0 (hmiOverwriteForbidden) = No: Los registros de receta no se sobrescriben. El proceso de
importación no se ejecuta.
1 (hmiOverwriteAlways) = Sí: Los registros de receta se sobrescribirán sin consulta previa.
2 (hmiOverwriteWithConfirmation) = Tras confirmar: Los registros de receta se sobrescribirán
tras haberse confirmado la consulta de seguridad.
Estado de procesamiento
Indica el estado de procesamiento de la función de sistema. Utilice el valor de retorno p. ej.
para ejecutar otras funciones de sistema sólo tras haber ejecutado correctamente esta función:
2 = La función de sistema se está ejecutando actualmente.
4 = La función de sistema se ha ejecutado correctamente.
12 = La función de sistema no se ha ejecutado porque se ha producido un error.
Descripción
Suma el valor indicado al valor de la variable.
X=X+a
Nota
La función de sistema utiliza la misma variable como valor de entrada y como valor de salida.
Si utiliza esta función de sistema para convertir un valor, deberá utilizar una variable auxiliar.
A la variable auxiliar se le puede asignar un valor con la función de sistema "DefinirVariable".
Parámetros
Variable
Variable a la que se debe agregar el valor indicado.
Valor
Valor que se suma.
Descripción
Asigna a la variable X un valor que se calcula a partir del valor de la variable Y indicada
mediante la función lineal X = (Y - b) / a.
Las variables X e Y no pueden ser idénticas. Esta función de sistema es la función inversa de
"EscalaLineal".
Nota
Las variables X e Y no pueden ser idénticas. Si desea convertir una variable en Sí misma,
debe utilizar una variable auxiliar
Con la función de sistema "DefinirVariable" se puede asignar a la variable auxiliar el valor de
la variable que se va convertir.
Parámetros
X
Variable a la que se asigna el valor calculado en la ecuación lineal.
Y
Variable cuyo valor se utiliza para el cálculo.
b
Valor que se va a restar.
a
Valor por el que se divide.
Ejemplo
El siguiente código de programa asigna un valor a la variable varX con la función
InverseLinearScaling.
{
BYTE varX;
BYTE Yvalue = 10;
BYTE bvalue = 3;
BYTE avalue = 4;
Descripción
Invierte el valor de la variable indicada del tipo "Bool".
● Si la variable tiene el valor 1 (TRUE), se ajusta a 0 (FALSE).
● Si la variable tiene el valor 0 (FALSE), se ajusta a 1 (TRUE).
Parámetros
Variable
Variable cuyo bit se debe ajustar.
Ejemplo
El siguiente código de programa invierte el valor de la variable booleana b_value y muestra
el resultado junto con el valor original b_saved.
{
BOOL b_value = 0;
BOOL b_saved = b_value;
//Invert variable
invertBit(b_value);
Descripción
Invierte un bit en la variable indicada:
● Si el bit de la variable tiene el valor 1 (TRUE), se ajusta a 0 (FALSE).
● Si el bit de la variable tiene el valor 0 (FALSE), se ajusta a 1 (TRUE).
Tras modificar el bit indicado, la función de sistema vuelve a transferir toda la variable al
controlador. No se comprueba si entretanto se han modificado otros bits en la variable. El
operador y el controlador sólo podrán acceder a la variable indicada en modo de lectura hasta
que la variable vuelva a transferirse al controlador.
Nota
No utilice esta función de sistema si el controlador admite variables BOOL. En su lugar utilice
la función de sistema "InvertirBit".
Parámetros
Tag
Variable en la que se debe ajustar el bit indicado.
Bit
Número del bit a ajustar.
Si utiliza esta función de sistema en un script de usuario, los bits de una variable se cuentan
de derecha a izquierda. El contaje comienza a partir de "0".
Ejemplo
El siguiente código de programa invierte un bit en la posición indicada bitposition de la variable
bvalue y muestra el resultado junto con el valor original bsaved.
{
BYTE bvalue;
BYTE bsaved = bvalue;
BYTE bitposition = 2;
Descripción
Asigna a la variable Y un valor que se calcula a partir del valor de las variables X indicadas
mediante la función lineal Y = (a * X) + b.
La función inversa es la función de sistema "InvertirEscalaLineal".
Nota
Las variables X e Y no pueden ser idénticas. Si desea convertir una variable en Sí misma,
debe utilizar una variable auxiliar
Con la función de sistema "DefinirVariable" se puede asignar a la variable auxiliar el valor de
la variable que se va convertir.
Parámetros
Y
Variable a la que se asigna el valor calculado en la ecuación lineal.
a
Valor con el que se multiplica.
X
Variable cuyo valor se utiliza para el cálculo.
b
Valor que se suma.
Ejemplo
El siguiente código de programa asigna con la función LinearScaling un valor a la variable
Yvar.
{
BYTE Yvar;
BYTE Xvalue = 10;
BYTE bvalue = 3;
BYTE avalue = 4;
// linear scaling
LinearScaling ( Yvar, avalue, Xvalue, bvalue);
Descripción
Carga el registro de receta indicado del medio de almacenamiento del panel de operador a
la variable de receta. Utilice esta función de sistema por ejemplo para visualizar un registro
de receta en la imagen de receta.
Parámetros
Número/Nombre de receta
Número o nombre de la receta desde la que se cargará un registro.
Número/Nombre de registro
Número o nombre del registro de receta que se cargará.
Estado de procesamiento
Indica el estado de procesamiento de la función de sistema. Utilice el valor de retorno p. ej.
para ejecutar otras funciones de sistema sólo tras haber ejecutado correctamente esta función:
2 = La función de sistema se está ejecutando actualmente.
4 = La función de sistema se ha ejecutado correctamente.
12 = La función de sistema no se ha ejecutado porque se ha producido un error.
Descripción
Cierra la sesión del usuario actual en el panel de operador.
Parámetros
--
Descripción
Inicia la sesión del usuario actual en el panel de operador.
Parámetros
Contraseña
La variable de la cual se lee la contraseña del usuario que va a iniciar la sesión.
Si el usuario ha iniciado la sesión, se borra la contraseña de la variable.
Nombre de usuario
La variable de la cual se lee el Nombre de usuario que va a iniciar la sesión.
Descripción
Lee el registro de una lista de textos. El resultado depende del valor y del idioma de runtime
seleccionado. El resultado se guarda en una variable del tipo "String".
Parámetros
Texto de salida
Variable en la que se escribe el resultado.
Valor
Variable que determina el valor del registro de la lista.
Idioma
Determina en qué idioma de runtime se debe leer el registro de la lista.
● Idioma de runtime
Abreviatura de idioma conforme a la referencia VBScript, p. ej. "de-DE" para alemán
(Alemania) o "en-ES" para inglés (EE UU). La selección depende de los idiomas runtime
activados.
● Variable
Variable que contiene el idioma. El idioma de runtime se introduce en forma de valor
decimal del indicador de país, p. ej. 1031 para alemán estándar, 1033 para inglés de
EE UU. Encontrará más información al respecto en los conceptos básicos de VBScript bajo
el tema "Cuadro de ID de configuración regional (LCID)".
● Número entero
El número que corresponde al orden de los idiomas de runtime en el cambio de idioma.
La selección depende de los idiomas de runtime activados, p. ej., "0" para el idioma que
aparece al iniciar runtime por primera vez. Encontrará más información al respecto en el
apartado "Idiomas en runtime".
Lista de textos
Establece la lista de textos. El registro se lee de la lista de textos.
Descripción
Esta función de sistema registra en el Audit Trail las acciones del usuario que no se registran
automáticamente en el Audit Trail. Además, con esta función se puede exigir que el usuario
acuse una acción, o bien que la confirme con su firma electrónica y que introduzca un
comentario al respecto. Para utilizar la función de sistema es imprescindible que se active la
configuración conforme a GMP en "Configuración de runtime > GMP".
Si en una función utiliza la función de sistema "NotificarAcciónDeUsuario" y termina la entrada
con el botón "Cancelar" se puede llamar el depurador. Para controlar este comportamiento,
se puede utilizar en una función la instrucción "On Error Resume Next". Esta instrucción hace
que se ejecute la instrucción siguiente tras un error de runtime. Si utiliza la instrucción "On
Error Resume Next" se suprime también la salida de avisos de sistema.
Parámetros
Tipo de confirmación
Determina cómo debe confirmarse la acción
0 = (None): no se requiere confirmación, se crea una entrada en el Audit Trail
1 = (Acknowledgement): acuse, el usuario tiene que acusar la acción; se crea una entrada en
el Audit Trail
2 = (Digital Signature): firma electrónica, aparece un cuadro de diálogo en el que el usuario
debe introducir su firma electrónica; se crea una entrada en el Audit Trail
Comentario obligatorio
Determina si el usuario debe introducir un comentario. El comentario se archiva en el Audit
Trail.
0 = (True): Verdadero, aparece un cuadro de diálogo en el que el usuario debe introducir un
comentario
1 = (False): Falso; no se requiere ningún comentario
Categoría
Categoría o nombre de clase del objeto modificado
Descripción
Texto que describe la acción de usuario que se debe archivar.
Descripción
Restablece la conexión entre WinCC y los ficheros. La archivación puede continuar.
Nota
Para reiniciar el proceso de archivar, ejecute la función de sistema "IniciarArchivación".
Parámetros
--
Ejemplo de aplicación
Desea cambiar en runtime el soporte de datos en el que se archivan los valores de proceso.
Indicaciones relativas a la configuración
Configure las funciones de sistema "PararArchivación" y "CerrarTodosLosFicheros" y
asócielas al botón "Close Archive".
Configure las funciones de sistema "AbrirTodosLosFicheros" e "IniciarArchivación" y asócielas
al botón "Open Archive".
Transfiera como parámetro el nombre del fichero que se debe parar o iniciar, respectivamente.
Proceso en el panel de operador
Cuando pulse el botón "Close Archive" se parará el fichero indicado y se cerrarán todos los
ficheros abiertos. A continuación podrá cambiar el soporte de datos. Con el botón "Open
Archive" se abren todos los ficheros. Se sigue archivando en el fichero indicado.
Descripción
Abre una ventana de comando de Windows.
Utilice esta función de sistema si, p. ej., desea copiar archivos o llamar otra aplicación.
Parámetros
--
Descripción
Abre un diálogo mediante el que se puede modificar la configuración seleccionada en el Panel
de control.
Con esta función de sistema se ajusta en el panel de operador, entre otras cosas, lo siguiente:
● Propiedades y valor de la dirección IP
● Identificación del usuario en la red
● WinCC Internet Settings
Nota
Seguridad en el proyecto
Con la función de sistema "AbrirDiálogoPanelDeControl" se omite el SecureMode en el panel
de operador. Tome las medidas preventivas necesarias para garantizar la seguridad de su
proyecto.
Parámetros
Cuadro de diálogo
Define el diálogo que se abre en el Panel de control.
● PROFINET_X1: ajuste de la dirección IP y de los parámetros de Ethernet.
● PROFINET_X3: ajuste de la dirección IP y de los parámetros de Ethernet, solo con Comfort
Panel KP 1500, TP 1500, TP1900, TP2200.
● WinCC Internet Settings: ajuste de servidor web, notificación por correo electrónico, si el
panel de operador soporta esta función.
● ID de red: ajuste para la identificación en la red, si el panel de operador soporta estas
funciones.
Descripción
Abre Internet Explorer en el panel de operador.
Si Internet Explorer ya está abierto, al llamar esta función de sistema se cerrará y volverá a
abrirse.
Nota
Internet Explorer guarda datos temporalmente en el sistema de archivos DRAM del panel de
operador (p.ej. las últimas páginas web llamadas).
Es posible guardar dichos datos con la función de sistema
"CopiaSeguridadSistemaDeArchivosRAM" para que sigan estando disponibles tras un reinicio
del panel de operador.
Parámetros
Página inicial
Página que se abre cuando se llama Internet Explorer, p. ej. "www.siemens.com".
Descripción
Muestra u oculta el teclado de pantalla.
El teclado de pantalla se mantiene abierto hasta que se cierra expresamente. De este modo
también es posible utilizarlo en otras aplicaciones.
Parámetros
Representación
Determina si la ventana con el teclado de pantalla se abre minimizada o maximizada:
0 (hmiScreenKeyboardMinimized) = Minimizada
1 (hmiScreenKeyboardMaximized) = Maximizada
Descripción
Muestra el administrador de tareas.
El administrador de tareas permite cambiar a otras aplicaciones abiertas en el panel de
operador.
Nota
El aspecto del administrador de tareas depende del sistema operativo instalado.
Parámetros
--
Descripción
Ejecuta la función de tecla <Av Pág> en el panel de operador.
Esta función de sistema sólo se puede utilizar para teclas de función.
Parámetros
-
Descripción
Ejecuta la función de tecla <RePág> en el panel de operador.
Esta función de sistema sólo se puede utilizar para teclas de función y para tareas con
disparador temporal.
Parámetros
-
Descripción
Imprime el informe indicado en la impresora conectada al panel de operador. El informe se
imprime en el idioma ajustado en el panel de operador.
Nota
Si runtime se cierra mientras se están imprimiendo datos de fichero con la ayuda de la función
del sistema, entonces el protocolo no recibe más datos a partir del momento en que se finaliza
runtime.
Parámetros
Informe
Nombre del informe a imprimir.
Nota
Si crea un nuevo informe para la función "ImprimirInforme" en el cuadro de diálogo "Lista de
funciones", aparecerá la siguiente advertencia durante la compilación: "El informe "Informe_1"
no contiene páginas de impresión."
Para eliminar la advertencia, abra el "Informe_1" en la ventana del proyecto y vuelva a compilar
el proyecto.
Descripción
Imprime la imagen visualizada actualmente en el panel de operador en la impresora conectada
a éste último.
Las ventanas abiertas también se imprimen.
Nota
Los ajustes de la impresora se adoptan de los ajustes actuales del sistema operativo Windows.
Parámetros
--
Descripción
Pone a 0 (FALSE) el valor de una variable del tipo "Bool".
Parámetros
Variable
Variable del tipo BOOL que se ajusta a "0" (FALSE).
Ejemplo
El siguiente código de programa pone a 0 el valor de la variable booleana b_value con la
función ResetBit y muestra el resultado junto con el valor original b_saved.
{
BOOL b_value = 1;
BOOL b_saved = b_value;
//Reset bit
ResetBit (b_value);
Descripción
Pone un bit a 0 (FALSE) en las variables indicadas.
Tras modificar el bit indicado, la función de sistema vuelve a transferir toda la variable al
controlador. No se comprueba si entretanto se han modificado otros bits en la variable. El
operador y el controlador sólo podrán acceder a la variable indicada en modo de lectura hasta
que la variable vuelva a transferirse al controlador.
Nota
No utilice esta función de sistema si el controlador admite variables BOOL. En su lugar utilice
la función de sistema "DesactivarBit".
Parámetros
Variable
Variable en la que un bit se ajusta a "0" (FALSE).
Bit
Número del bit que se ajusta a "0" (FALSE).
Si utiliza esta función de sistema en un script de usuario, los bits de la variable indicada se
contarán de derecha a izquierda, independientemente del controlador utilizado. El contaje
comienza a partir de "0".
Ejemplo
El siguiente código de programa pone a 0 un bit en la posición indicada bitposition de la
variable bvalue y muestra el resultado junto con el valor original bsaved.
{
BYTE bvalue;
BYTE bsaved = bvalue;
BYTE bitposition = 2;
Descripción
Comprueba si se llevan a cabo accesos de escritura o lectura al medio de almacenamiento
externo. Si no se realizan accesos, el medio de almacenamiento externo puede retirarse sin
perder datos.
Parámetros
Ruta
Ruta del medio de almacenamiento, p. ej. \Storage Card USB\
Resultado
Variable en la que se registra el resultado.
TRUE: El medio de almacenamiento puede retirarse con seguridad. Se visualiza un aviso de
sistema al efecto.
FALSE: El medio de almacenamiento no puede retirarse. Se visualiza un aviso de sistema al
efecto.
Descripción
Guarda los valores actuales de las variables de receta como registro en el soporte de memoria
del panel de operador.
Utilice esta función de sistema por ejemplo para guardar un registro de receta en la imagen
de recetas.
Parámetros
Número/Nombre de receta
Número o nombre de la receta en la que se deben almacenar los registros.
Número/Nombre de registro
Número o nombre del registro de la receta que se almacena. Si en la receta no existe ningún
registro con este número o nombre, se creará un nuevo registro independientemente del valor
del parámetro "Sobrescribir".
Sobrescribir
Determina si se debe sobrescribir un registro de receta existente.
0 (hmiOverwriteForbidden) = No: El registro de receta no se sobrescribirá ni tampoco se
guardará.
1 (hmiOverwriteAlways) = Sí: El registro de receta se sobrescribirá sin consulta previa.
2 (hmiOverwriteWithConfirmation) = Tras confirmar: El registro de receta se sobrescribirá tras
haberse confirmado la consulta de seguridad.
Estado de procesamiento
Indica el estado de procesamiento de la función de sistema. Utilice el valor de retorno p. ej.
para ejecutar otras funciones de sistema sólo tras haber ejecutado correctamente esta función:
2 = La función de sistema se está ejecutando actualmente.
4 = La función de sistema se ha ejecutado correctamente.
12 = La función de sistema no se ha ejecutado porque se ha producido un error.
Descripción
Envía un correo electrónico desde el panel de operador al destinatario indicado.
Utilice esta función de sistema si p.ej. en caso de mantenimiento o reparación desea transferir
el aviso directamente a los técnicos responsables.
Nota
Para enviar los avisos adicionalmente en forma de correo electrónico, el sistema HMI debe
disponer de un cliente de correo electrónico.
Parámetros
Dirección
Dirección de correo electrónico del destinatario.
Asunto
Línea de asunto del mensaje de correo electrónico.
Texto
Texto que se envía en el mensaje de correo electrónico.
Dirección de respuesta
Dirección de correo electrónico a la que el destinatario debe enviar la respuesta.
Descripción
Configura la notificación acústica del panel de operador al manejar la pantalla táctil.
Nota
Cuando rearranque el panel de operador se restablecerá la configuración que estaba ajustada
al apagarlo.
Parámetros
Volumen
Determina si se debe emitir una señal acústica, así como su volumen.
-1 (hmiToggle) = Conmutar: Conmuta el volumen de salida de la señal acústica como se indica
a continuación: Silenciada > Baja > Alta.
0 (hmiMuted) = Silenciada: Sin señal acústica
1 (hmiQuiet) = Baja: Señal acústica a bajo volumen
2 (hmiLoud) = Alta: Señal acústica a alto volumen
Descripción
Activa o desactiva la generación automática de informes para avisos en la impresora.
Parámetros
Modo
Determina si los avisos se deben imprimir automáticamente en la impresora:
0 (hmiDisablePrinting) = impresión desactivada: Los informes no se imprimen
automáticamente.
Descripción
Define el brillo de la pantalla para un MP 377 Touch daylight readable. Aquí el valor del brillo
puede interpretarse de modo absoluto o relativo con respecto al valor actual.
Nota
Al reiniciar el panel de operador se restablece la configuración que estaba ajustada en el
Control Panel.
Parámetros
Brillo
Valor nuevo del brillo.
Modo
Determina si el nuevo valor del brillo se ajusta de modo absoluto o relativo con respecto al
valor actual.
Valor actual
Variable en la que se deposita el valor actual del brillo.
Descripción
Ajusta a "1" (TRUE) el valor de una variable del tipo "Bool".
Parámetros
Variable
Variable del tipo BOOL que se ajusta a "1" (TRUE).
Ejemplo
El siguiente código de programa pone a 1 el valor de la variable booleana b_value con la
función SetBit y muestra el resultado junto con el valor original b_saved.
{
BOOL b_value = 0;
BOOL b_saved = b_value;
//Set bit
SetBit (b_value);
Descripción
Ajusta un bit a "1" (TRUE) en la variable indicada.
Tras modificar el bit indicado, la función de sistema vuelve a transferir toda la variable al
controlador. No se comprueba si entretanto se han modificado otros bits en la variable. El
operador y el controlador sólo podrán acceder a la variable indicada en modo de lectura hasta
que la variable vuelva a transferirse al controlador.
Nota
No utilice esta función de sistema si el controlador admite variables BOOL. En su lugar utilice
la función de sistema "ActivarBit".
Parámetros
Variable
Variable en la que un bit se ajusta a "1" (TRUE).
Bit
Número del bit que se ajusta a "1" (TRUE).
Si utiliza esta función de sistema en un script de usuario, los bits de la variable indicada se
contarán de derecha a izquierda, independientemente del controlador utilizado. El contaje
comienza a partir de "0".
Nota
Para garantizar una funcionalidad fiable es imprescindible una actualización garantizada de
las variables utilizadas con los valores de proceso actuales. Por tanto, configure la variable
en un campo E/S, o bien asocie la función de sistema a un objeto de imagen (p. ej. un botón).
Si asocia la función de sistema a un evento breve (p. ej. aparición de un mensaje), los valores
de proceso actuales sólo se alcanzarán si la variable puede leerse de forma permanente.
Ejemplo
El siguiente código de programa pone a 1 un bit en la posición indicada bitposition de la
variable bvalue y muestra el resultado junto con el valor original bsaved.
{
BYTE bvalue;
BYTE bsaved = bvalue;
BYTE bitposition = 2;
Descripción
Define el brillo de la pantalla.
Nota
Al reiniciar el panel de operador se restablece la configuración que estaba ajustada en el
Control Panel/Start Center.
Utilizable, siempre que el dispositivo configurado soporte scripts de usuario. Encontrará más
información al respecto en "Dependencia del dispositivo".
Parámetros
Valor
Valor nuevo del brillo.
Descripción
Establece o desconecta la conexión indicada.
Nota
Sólo puede establecerse una conexión con el controlador si el panel de operador funciona en
modo "online". Utilice para ello la función de sistema "EstablecerModoDeOperaciónPanel".
Parámetros
Modo
Determina si la conexión con el controlador se debe establecer o desconectar:
0 (hmiOnline) = Online: Se establece la conexión.
1 (hmiOffline) = Offline: Se deshace la conexión.
Conexión
Controlador que se debe conectar con el panel de operador. El nombre del controlador se
establece en el editor de conexiones.
Ejemplo de aplicación
A continuación se indican dos ejemplos de aplicación típicos de esta función de sistema:
● Test
Mientras que no haya ningún controlador conectado al panel de operador, durante el test
no se indicarán mensajes de error en el panel de operador. Si el panel de operador está
conectado a un controlador, podrá establecer la conexión con éste último pulsando una
tecla.
● Puesta en servicio
Se deben configurar varios controladores para una instalación. Configure primero todos
los controladores "offline", exceptuando uno de ellos. Tras poner en marcha el primer
controlador, establezca la conexión con todos los demás, pulsando para ello la tecla
correspondiente. Así podrá poner en marcha los demás controladores uno tras otro.
Descripción
Transfiere los valores de las variables de receta al controlador. Las variables de receta
contienen los valores del registro que se visualiza en el panel de operador.
Parámetros
Número/Nombre de receta
Número o nombre de la receta desde la que se debe transferir un registro al controlador.
Estado de procesamiento
Indica el estado de procesamiento de la función de sistema. Utilice el valor de retorno p. ej.
para ejecutar otras funciones de sistema sólo tras haber ejecutado correctamente esta función:
2 = La función de sistema se está ejecutando actualmente.
4 = La función de sistema se ha ejecutado correctamente.
12 = La función de sistema no se ha ejecutado porque se ha producido un error.
Descripción
Transfiere el registro de receta indicado directamente desde el soporte de datos del panel de
operador al controlador conectado con el panel de operador.
Nota
A este efecto no es necesario que los valores del registro de receta se visualicen en el panel
de operador.
Parámetros
Número/nombre de receta
Número o nombre de la receta desde la que se debe transferir un registro al controlador.
Número/Nombre de registro
Número o nombre del registro de receta que se debe transferir al controlador.
Estado de procesamiento
Indica el estado de procesamiento de la función de sistema. Utilice el valor de retorno p. ej.
para ejecutar otras funciones de sistema sólo tras haber ejecutado correctamente esta función:
2 = La función de sistema se está ejecutando actualmente.
4 = La función de sistema se ha ejecutado correctamente.
12 = La función de sistema no se ha ejecutado porque se ha producido un error.
Descripción
La función de sistema "AjustarHorarioVerano" cambia la hora del panel de operador a horario
de verano o invierno.
El cambio de horario se efectúa inmediatamente después de ejecutar la función de sistema.
Nota
La función "AjustarHorarioVerano" no soporta zonas horarias sin horario de verano.
Nota
Windows 7
La función de sistema "AjustarHorarioVerano" no se soporta en paneles de operador basados
en PC con Windows 7.
Parámetros
Horario de verano
Determina si se activa el horario de verano en el panel de operador:
0 = Horario de verano no activado
1 = Horario de verano activado
Descripción
Cambia el modo de operación en el panel de operador. Se dispone de los modos de operación
siguientes: "Online", "Offline" y "Cargar".
Parámetros
Modo de operación
Determina el modo de operación del panel de operador:
0 (hmiOnline) = Online: Se establece la conexión con el controlador. Al hacerlo, siempre se
ajusta el estado de conexión configurado. No se tienen en cuenta los estados que se utilizaron
por última vez en runtime.
1 (hmiOffline) = Offline: Se deshace la conexión con el controlador.
2 (hmiTransfer) = Cargar: Permite transferir proyectos desde el equipo de configuración al
panel de operador.
Nota
Si utiliza un PC como panel de operador, al conmutar al modo de operación "Cargar" se cierra
el software runtime.
Descripción
Cambia la configuración de la ventana en la que se ejecuta el software runtime.
Por defecto, el software runtime se ejecuta en modo de pantalla completa. La posibilidad de
conmutar entre las aplicaciones de Windows está desactivada.
Parámetros
Representación
Determina la configuración de la ventana en la que se ejecuta el software runtime.
1 (hmiScreenFull): Pantalla completa: La barra de título de la ventana no se visualiza.
2 (hmiScreenMaximized): Maximizada
3 (hmiScreenRestore): Restablecer: Se utiliza la configuración de ventana que se ha utilizado
de último. Este modo de visualización sólo se puede utilizar si la ventana aparece minimizada
o maximizada.
4 (hmiScreenMinimized): Minimizada
5 (hmiScreenAutoAdjust): Automático: El tamaño de la ventana se ajusta de manera que se
visualicen todos los objetos de imagen que contiene.
6 (hmiScreenOnTop): Primer plano; en función de la configuración de Windows aparecerá la
ventana en primer plano o bien el símbolo del programa en cuestión parpadeará en la barra
de tareas. La configuración puede modificarse en Windows y es válida para todas las
aplicaciones de Windows.
Descripción
Cambia el idioma del panel de operador. Todos los textos y avisos del sistema configurados
aparecerán en el panel de operador en el idioma recién ajustado.
Parámetros
Idioma
Determina qué idioma se debe ajustar en el panel de operador. Se pueden realizar los
siguientes ajustes:
● -1 (hmiToggle) = Conmutar: Cambia al siguiente idioma. El orden se establece en el editor
"Idiomas del proyecto" durante el proceso de configuración.
● Número que se ha especificado en "Idioma y fuente" en el editor "Configuración de
runtime". Cambia al idioma con el número indicado.
● Idioma que se ha especificado en "Idioma y fuente" en el editor "Configuración de runtime".
● Abreviatura del idioma conforme a la referencia VBScript5: Cambia al idioma
correspondiente a la abreviatura indicada, p. ej. "de-DE" para alemán (Alemania) o "en-
US" para inglés (EE.UU.).
En el tema "Cuadro de Id. de configuración regional (LCID)" que forma parte de los
principios básicos de VBScript encontrará una lista de todas las abreviaturas de idioma.
Descripción
Modifica la fecha y la hora del controlador conectado.
La función de sistema "AjustarFechaHoraPLC" solo se puede configurar para los siguientes
controladores:
● SIMATIC S7 1200
● SIMATIC S7 1500
Parámetros
Conexión
Conexión de controlador y panel de operador.
Hora
Transfiere la fecha y la hora del panel de operador al controlador. El controlador aplica la fecha
y la hora del panel de operador.
Descripción
Modifica el estado de las variables de receta de "online" a "offline" y viceversa.
Utilice esta función de sistema si p.ej. desea realizar un ajuste fino de los valores de los
registros de receta al poner en marcha una máquina.
Parámetros
Número/nombre de receta
Número o nombre de la receta en la que está almacenado el registro.
Estado
Determina el estado de las variables de la receta:
0 (hmiOnline) = Online: Los cambios de valores en las variables de receta se transfieren de
inmediato al controlador conectado con el panel de operador.
1 (hmiOffline) = Offline: Los cambios de valores en las variables de la receta se transfieren al
controlador conectado con el panel de operador inmediatamente después de ejecutar p.ej. la
función de sistema "EscribirVariablesDeRegistroEnControlador".
Estado de procesamiento
Indica el estado de procesamiento de la función de sistema. Utilice el valor de retorno p. ej.
para ejecutar otras funciones de sistema sólo tras haber ejecutado correctamente esta función:
2 = La función de sistema se está ejecutando actualmente.
4 = La función de sistema se ha ejecutado correctamente.
12 = La función de sistema no se ha ejecutado porque se ha producido un error.
Descripción
Activa o desactiva la visualización automática del teclado de la pantalla en el panel de
operador.
Utilice esta función de sistema si desea impedir que aparezca el teclado de pantalla por
ejemplo porque dispone de un teclado externo conectado al panel de operador.
Nota
Si utiliza la función de sistema "EstablecerModoTecladoDePantalla"
("SetScreenKeyboardMode") en un panel de operador que carezca de pantalla táctil, en la
configuración del panel deberá activar la opción "Utilizar teclado pantalla" en el área
"Configuración de runtime".
Parámetros
Modo
Determina si el teclado de la pantalla se debe mostrar u ocultar.
0 (hmiOff) = Off: Ocultar el teclado de la pantalla
1 (hmiOn) = On: Mostrar el teclado de la pantalla
Descripción
Asigna un valor nuevo a la variable indicada.
Nota
Dependiendo del tipo de variable, con esta función de sistema puede asignar cadenas de
caracteres y números.
Parámetros
Variable
Variable a la que se debe asignar el valor indicado.
Valor
Valor que se asigna a la variable indicada.
Nota
La función de sistema "DefinirVariable" se ejecuta únicamente tras establecer una conexión.
Ejemplo
El siguiente código de programa ajusta con la función SetTag el valor de las variables
gs_tag_bit a TRUE y guarda el valor de retorno en la variable ok.
{
BOOL ok;
BOOL bvalue;
Descripción
La función de sistema convierte la configuración binaria de entrada de la variable de origen
en una configuración binaria de salida de la variable de destino. Durante este proceso se
desplazan y se enmascaran bits.
Nota
Si las variables de origen y destino tienen un número de bits diferente, la aplicación de la
función de sistema en la variable de destino no puede causar un rebase del rango de valores.
Parámetros
Variable de origen
La variable contiene la configuración binaria de entrada. Se admiten variables de números
enteros, p. ej. "Byte", "Char", "Int", "UInt", "Long" y "ULong".
Ejemplo: La variable de origen del tipo "16 Bit Integer" tiene el valor 72: 0000000001001000.
Variable de destino
En la variable se guarda la configuración binaria de salida. Se admiten variables de tipo entero,
p. ej. "Byte", "Char", "Int", "UInt", "Long" y "ULong".
Ejemplo: La configuración binaria de entrada desplazada se multiplica con la máscara de bits,
bit por bit con la operación lógica Y: 0000000000001001. El resultado tiene el valor decimal
"8" y se guarda en la variable de destino.
Tenga en cuenta lo siguiente:
● Las variables de origen y destino tienen el mismo número de bits.
● La cantidad de bits a desplazar es menor que la cantidad de bits de las variables de origen
y de destino.
● "Bits a enmascarar" no contiene más bits que las variables de origen y destino.
Bits a desplazar
Cantidad de bits según la que se debe desplazar hacia la derecha la configuración binaria de
entrada. Un valor negativo desplaza la configuración binaria de entrada hacia la izquierda.
Ejemplo: "Bits a desplazar" tiene el valor "+3". Al llamar la función de sistema, la configuración
binaria de entrada se desplaza 3 bits hacia la derecha: 0000000000001001.
El lado izquierdo se rellena con "0". En el lado derecho se truncan 3 bits. El nuevo valor decimal
es "9".
Nota
Si la variable de origen tiene un tipo de datos Integer con el signo "-", el bit izquierdo será "1".
Al desplazar hacia la derecha, este bit de signo se rellena con "0". El signo se conmuta a "+".
Bits a enmascarar
Un número del tipo Integer sirve de máscara de bits Con su configuración binaria se multiplica
la configuración binaria de entrada desplazada. Ejemplo: número "2478" con la configuración
binaria "0000100110101110".
Descripción
Muestra u oculta la ventana de avisos en el panel de operador.
Parámetros
Representación
Determina si la ventana de avisos se debe mostrar u ocultar.
0 (hmiOff) = Off: Ocultar el visor de avisos
1 (hmiOn) = On: Mostrar el visor de avisos
-1 (hmiToggle) = Conmutar: Conmuta entre ambos estados.
Utilización
Muestra el tooltip configurado para el objeto seleccionado.
Si la función de sistema se ha asociado a una tecla de función, se mostrará el tooltip
correspondiente al objeto de imagen resaltado en ese momento. Si al mismo tiempo se ha
configurado un tooltip para la imagen, será posible conmutar a ésta bien sea pulsando la tecla
<Intro> o bien haciendo doble clic en la ventana de ayuda.
Si la función de sistema se ha asociado a un botón, se mostrará sólo el tooltip de la imagen
actual. Si se ha configurado también un tooltip asociado al botón, se mostrará primero dicho
texto. Pulsando la tecla <Intro> o haciendo doble clic en la ventana de ayuda se conmuta al
tooltip de la imagen actual.
Nota
Mientras esté abierta la ventana de ayuda, no se podrá operar ningún otro objeto de imagen.
Para operar los objetos de imagen, cierre la ventana de ayuda.
Parámetros
Representación
Determina si el tooltip configurado se debe mostrar u ocultar:
0 (hmiOff) = Off: ocultar el tooltip configurado
Descripción
Llama la imagen emergente, p. ej. al pulsar un botón.
Como coordenadas puede indicar un valor constante o asignar una variable.
Si la imagen emergente configurada no es visible o solo lo es parcialmente, las coordenadas
se ajustan a 0.0.
Parámetros
Nombre de la imagen
Define el nombre de la imagen que aparece en runtime al pulsar el botón.
Coordenada X
Posición de la imagen en el eje X de la imagen actual
Coordenada Y
Posición de la imagen en el eje Y de la imagen actual
Representación
Define el modo para la imagen deslizable:
Conmutar
Off
On
Descripción
Llama la imagen deslizable, p. ej., al pulsar un botón.
Parámetros
Nombre de imagen
Define la imagen deslizable que aparece en runtime al pulsar el botón:
Imagen deslizable arriba
Imagen deslizable abajo
Imagen deslizable a la izquierda
Imagen deslizable a la derecha
Modo
Define el modo para la imagen deslizable:
Conmutar
Off
On
Descripción
Muestra u oculta el número de versión del software runtime.
Utilice esta función de sistema por ejemplo si en caso de reparación o mantenimiento necesita
saber la versión del software runtime utilizado.
Parámetros
Representación
Determina si el número de versión se debe mostrar u ocultar:
0 (hmiOff) = OFF: Ocultar el número de versión
1 (hmiOn) = ON: Mostrar el número de versión
-1 (hmiToggle) = Conmutar: Conmuta entre ambos estados.
Descripción
Muestra el valor del parámetro transferido como aviso del sistema en el panel de
operador.
Parámetros
Texto/valor
Texto o valor a emitir como aviso del sistema.
Descripción
Muestra u oculta la ventana de diagnóstico del sistema en el panel de operador. La ventana
de diagnóstico del sistema sólo está disponible en la imagen general para Comfort Panels y
WinCC Runtime Advanced.
Parámetros
Objeto de imagen
Nombre de la ventana de diagnóstico del sistema que se debe mostrar u ocultar.
Descripción
Inicia la archivación de valores de proceso o avisos en el fichero indicado. La función también
puede aplicarse a los Audit Trails.
La archivación se puede cancelar en runtime utilizando la función de sistema
"PararArchivación".
Parámetros
Tipo de fichero
Determina el tipo de fichero:
0 (hmiTagArchive) = Fichero de variables
1 (hmiAlarmArchive) = Fichero de avisos
2 (hmiAudittrailArchive) = Audit Trail
Fichero
Nombre del fichero a iniciar.
Descripción
Detiene la archivación de valores de proceso o avisos en el fichero indicado.
La archivación continúa en el siguiente fichero del fichero circular segmentado para el que
haya configurado el fichero indicado.
Si no ha configurado ningún fichero circular segmentado para el fichero indicado, esta función
de sistema no tendrá ningún efecto.
Parámetros
Tipo de fichero
Determina el tipo de fichero:
0 (hmiTagArchive) = Fichero de variables
1 (hmiAlarmArchive) = Fichero de avisos
Fichero
Nombre del fichero para el que se ha detenido la archivación y que continuará en el fichero
siguiente.
Descripción
Inicia el programa indicado en el panel de operador.
El software runtime se sigue ejecutando en segundo plano. Los avisos se siguen visualizando
y los valores de proceso se siguen actualizando.
Si finaliza la aplicación indicada, en el panel de operador se visualizará la imagen que estaba
activada al ejecutar la función de sistema.
Utilice esta función de sistema por ejemplo para editar registros de receta en el panel de
operador en MS Excel.
Nota
Si Windows CE está instalado en el panel de operador, compruebe durante la configuración
si la aplicación deseada se puede iniciar con esta función de sistema.
Utilizando esta función de sistema podrá iniciar todas las aplicaciones que se pueden iniciar
en el cuadro de diálogo "Ejecutar" de Windows CE.
La aplicación que desea abrir debe estar instalada en el panel de operador.
Parámetros
Nota
Si la ruta contiene un espacio en blanco, el programa sólo se iniciará correctamente si la ruta
se indica entre comillas, p. ej. "C:\Program Files\START\start.exe".
Representación
Determina cómo se debe visualizar la ventana del programa en el panel de operador:
0 (hmiShowNormal) = Normal
1 (hmiShowMinimized) = Minimizada
2 (hmiShowMaximized) = Maximizada
3 (ShowMinimizedAndInactive) = Minimizada e inactiva
Nota
El parámetro "Esperar fin de programa" sólo está disponible en Runtime Advanced y Panels.
Descripción
Detiene la archivación de valores de proceso o avisos en el fichero indicado. La función
también puede aplicarse a los Audit Trails.
La archivación se puede reiniciar en runtime utilizando la función de sistema
"IniciarArchivación".
Nota
Cuando se detiene la archivación permanece establecida la conexión entre WinCC y los
archivos comprimidos o la base de datos de ficheros. Para deshacer esta conexión, utilice la
función de sistema "CerrarTodosLosFicheros".
Parámetros
Tipo de fichero
Determina el tipo de fichero:
0 (hmiTagArchive) = Fichero de variables
1 (hmiAlarmArchive) = Fichero de avisos
2 (hmiAudittrailArchive) = Audit Trail
Fichero
Nombre del fichero a detener.
Ejemplo de aplicación
Desea cambiar en runtime el soporte de datos en el que se archivan los valores de proceso.
Indicaciones relativas a la configuración
Configure las funciones de sistema "PararArchivación" y "CerrarTodosLosFicheros" y
asócielas al botón "Close Archive".
Configure las funciones de sistema "AbrirTodosLosFicheros" e "IniciarArchivación" y asócielas
al botón "Open Archive".
Transfiera como parámetro el nombre del fichero que se debe parar o iniciar, respectivamente.
Proceso en el panel de operador
Cuando pulse el botón "Close Archive" se parará el fichero indicado y se cerrarán todos los
ficheros abiertos. A continuación podrá cambiar el soporte de datos. Si pulsa el botón "Open
Archive" se abrirán de nuevo todos los ficheros, pudiendo continuar con la archivación en el
fichero indicado.
Descripción
Sale del software runtime y, con ello, del proyecto que se está ejecutando en el panel de
operador.
Parámetros
Modo
Determina si al finalizar el software runtime también se debe cerrar el sistema operativo.
0 (hmiStopRuntime) = Runtime: No cerrar el sistema operativo
1 (hmiStopRuntimeAndOperatingSystem) = Runtime y sistema operativo: Cerrar el sistema
operativo (no en Windows CE)
Ejemplo
El siguiente código de programa cierra Runtime y el sistema operativo.
Descripción
Deshace la conexión PROFIsafe para el modo de seguridad positiva entre un KTP Mobile
Panel y el controlador.
Tras ejecutar la función de sistema "PROFIsafeDesconectar", el conector del KTP Mobile
Panel puede desenchufarse del controlador sin que la instalación notifique un error.
Utilizable, siempre que el dispositivo configurado soporte scripts de usuario. Encontrará más
información al respecto en "Dependencia del dispositivo".
Parámetros
--
Descripción
Lee el valor del número de versión de WinAC MP.
Parámetro
Versión
Variable que contiene el valor.
Actualizar
Determina si el número de versión se debe leer:
0 (SwitchOff) = OFF: El número de versión no se lee.
1 (SwitchOn) = ON: El número de versión se lee.
Descripción
Establece si WinAC MP se inicia automáticamente después de arrancar el panel de operador
o no.
Parámetros
Comportamiento en arranque
Determina si WinAC MP se inicia automáticamente.
0 (StartAtBootOff) = OFF: WinAC MP no se inicia cuando se arranca el panel de operador.
1 (StartAtBootOn) = ON: WinAC MP no se inicia automáticamente cuando se arranca el panel
de operador.
Descripción
Establece el modo de operación después de arrancar el panel de operador de WinAC MP.
Parámetros
Comportamiento en arranque
Determina si se activa la función de inicio automático de WinAC MP.
0 (AutoStartOff) = OFF: WinAC MP permanece en estado operativo STOP después del inicio.
1 (AutoStartOn) = ON: Después del inicio, WinAC MP cambia al mismo estado operativo que
tenía antes de cerrarse.
Descripción
Efectúa un cambio de imagen para visualizar la imagen indicada.
Para conmutar entre la imagen raíz y la ventana permanente, y viceversa, utilice la función
de sistema "ActivarImagenConNúmero".
Parámetros
Nombre de imagen
Nombre de la imagen a la que se cambia.
Ejemplo
El siguiente código de programa activa la imagen "Screen_2" con la función ActivateScreen
al pulsar cualquier tecla.
Descripción
Efectúa un cambio de imagen en la ventana indicada para visualizar la imagen indicada.
Parámetros
Nombre de imagen
Nombre de la imagen que se muestra en la ventana de imagen.
Ventana de imagen
Nombre de la ventana de imagen en la que se muestra la nueva imagen.
Ejemplo
El siguiente código de programa activa la imagen "Screen_2" con la función
ActivateScreenInScreenWindow al pulsar cualquier tecla.
{
// User defined code
// i.e. when pressing a button
ActivateScreenInScreenWindow (GetParentScreen(screenName),
GetParentScreenWindow(screenName), "Screen_2");
...
}
Descripción
Resta el valor indicado del valor de la variable.
X=X-a
Nota
La función de sistema utiliza la misma variable como valor de entrada y como valor de salida.
Si utiliza esta función de sistema para convertir un valor, deberá utilizar una variable auxiliar.
A la variable auxiliar se le puede asignar un valor con la función de sistema "DefinirVariable".
Parámetros
Variable
Variable de la que se debe restar el valor indicado.
Valor
Valor que se va a restar.
Ejemplo
El siguiente código de programa reduce el valor de la variable varX la cantidad que indica la
variable value. El valor introducido se guarda en la variable old_value y se muestra junto con
el nuevo valor varX.
{
BYTE varX;
BYTE value;
//user input
...
BYTE old_value = varX;
//Decrease tag
DecreaseTag(varX, value);
Descripción
Exporta todos los usuarios de la administración de usuarios del proyecto activo en este
momento al archivo indicado, o bien importa los usuarios del archivo indicado al proyecto
activo en este momento.
En la administración de usuarios se guardan usuarios, sus contraseñas y permisos.
Durante la importación se sobrescriben todos los usuarios. Los usuarios importados son
válidos desde el primer momento.
Parámetros
Nombre de archivo
Nombre del archivo que contiene las contraseñas o en el que se guardarán las contraseñas.
Introduzca también la ruta y la extensión del archivo (*.txt), p. ej. "C:\TEMP\Passwords.txt".
Nota
Si utiliza una tarjeta de memoria como ubicación, introduzca ésta última del siguiente modo:
"\StorageCard\<nombre del archivo>".
Dirección
Determina si las contraseñas se exportarán o importarán:
0 (hmiExport) = Exportación: Las contraseñas se exportan.
1 (hmiImport) = Importación: Las contraseñas se importan.
Descripción
Suma el valor indicado al valor de la variable.
X=X+a
Nota
La función de sistema utiliza la misma variable como valor de entrada y como valor de salida.
Si utiliza esta función de sistema para convertir un valor, deberá utilizar una variable auxiliar.
A la variable auxiliar se le puede asignar un valor con la función de sistema "DefinirVariable".
Parámetros
Variable
Variable a la que se debe agregar el valor indicado.
Valor
Valor que se suma.
Ejemplo
El siguiente código de programa aumenta el valor de la variable varX la cantidad que indica
la variable value. El valor introducido se guarda en la variable old_value y se muestra junto
con el nuevo valor varX.
{
BYTE varX;
BYTE value;
//user input
...
BYTE old_value = varX;
//Increase tag
IncreaseTag(varX, value);
Descripción
Asigna a la variable X un valor que se calcula a partir del valor de la variable Y indicada
mediante la función lineal X = (Y - b) / a.
Las variables X e Y no pueden ser idénticas. Esta función de sistema es la función inversa de
"EscalaLineal".
Nota
Las variables X e Y no pueden ser idénticas. Si desea convertir una variable en Sí misma,
debe utilizar una variable auxiliar
Con la función de sistema "DefinirVariable" se puede asignar a la variable auxiliar el valor de
la variable que se va convertir.
Parámetros
X
Variable a la que se asigna el valor calculado en la ecuación lineal.
Y
Variable cuyo valor se utiliza para el cálculo.
b
Valor que se va a restar.
a
Valor por el que se divide.
Ejemplo
El siguiente código de programa asigna un valor a la variable varX con la función
InverseLinearScaling.
{
BYTE varX;
BYTE Yvalue = 10;
BYTE bvalue = 3;
BYTE avalue = 4;
Descripción
Invierte el valor de la variable indicada del tipo "Bool".
● Si la variable tiene el valor 1 (TRUE), se ajusta a 0 (FALSE).
● Si la variable tiene el valor 0 (FALSE), se ajusta a 1 (TRUE).
Parámetros
Variable
Variable cuyo bit se debe ajustar.
Ejemplo
El siguiente código de programa invierte el valor de la variable booleana b_value y muestra
el resultado junto con el valor original b_saved.
{
BOOL b_value = 0;
BOOL b_saved = b_value;
//Invert variable
invertBit(b_value);
Descripción
Invierte un bit en la variable indicada:
● Si el bit de la variable tiene el valor 1 (TRUE), se ajusta a 0 (FALSE).
● Si el bit de la variable tiene el valor 0 (FALSE), se ajusta a 1 (TRUE).
Tras modificar el bit indicado, la función de sistema vuelve a transferir toda la variable al
controlador. No se comprueba si entretanto se han modificado otros bits en la variable. El
operador y el controlador sólo podrán acceder a la variable indicada en modo de lectura hasta
que la variable vuelva a transferirse al controlador.
Nota
No utilice esta función de sistema si el controlador admite variables BOOL. En su lugar utilice
la función de sistema "InvertirBit".
Parámetros
Tag
Variable en la que se debe ajustar el bit indicado.
Bit
Número del bit a ajustar.
Si utiliza esta función de sistema en un script de usuario, los bits de una variable se cuentan
de derecha a izquierda. El contaje comienza a partir de "0".
Ejemplo
El siguiente código de programa invierte un bit en la posición indicada bitposition de la variable
bvalue y muestra el resultado junto con el valor original bsaved.
{
BYTE bvalue;
BYTE bsaved = bvalue;
BYTE bitposition = 2;
Descripción
Asigna a la variable Y un valor que se calcula a partir del valor de las variables X indicadas
mediante la función lineal Y = (a * X) + b.
La función inversa es la función de sistema "InvertirEscalaLineal".
Nota
Las variables X e Y no pueden ser idénticas. Si desea convertir una variable en Sí misma,
debe utilizar una variable auxiliar
Con la función de sistema "DefinirVariable" se puede asignar a la variable auxiliar el valor de
la variable que se va convertir.
Parámetros
Y
Variable a la que se asigna el valor calculado en la ecuación lineal.
a
Valor con el que se multiplica.
X
Variable cuyo valor se utiliza para el cálculo.
b
Valor que se suma.
Ejemplo
El siguiente código de programa asigna con la función LinearScaling un valor a la variable
Yvar.
{
BYTE Yvar;
BYTE Xvalue = 10;
BYTE bvalue = 3;
BYTE avalue = 4;
// linear scaling
LinearScaling ( Yvar, avalue, Xvalue, bvalue);
Descripción
Pone a 0 (FALSE) el valor de una variable del tipo "Bool".
Utilizable, siempre que el dispositivo configurado soporte funciones definidas por el usuario.
Encontrará más información al respecto en "Dependencia del dispositivo".
Parámetros
Variable
Variable del tipo BOOL que se ajusta a "0" (FALSE).
Ejemplo
El siguiente código de programa pone a 0 el valor de la variable booleana b_value con la
función ResetBit y muestra el resultado junto con el valor original b_saved.
{
BOOL b_value = 1;
BOOL b_saved = b_value;
//Reset bit
ResetBit (b_value);
Descripción
Pone un bit a 0 (FALSE) en las variables indicadas.
Tras modificar el bit indicado, la función de sistema vuelve a transferir toda la variable al
controlador. No se comprueba si entretanto se han modificado otros bits en la variable. El
operador y el controlador sólo podrán acceder a la variable indicada en modo de lectura hasta
que la variable vuelva a transferirse al controlador.
Nota
No utilice esta función de sistema si el controlador admite variables BOOL. En su lugar utilice
la función de sistema "DesactivarBit".
Parámetros
Variable
Variable en la que un bit se ajusta a "0" (FALSE).
Bit
Número del bit que se ajusta a "0" (FALSE).
Si utiliza esta función de sistema en un script de usuario, los bits de la variable indicada se
contarán de derecha a izquierda, independientemente del controlador utilizado. El contaje
comienza a partir de "0".
Ejemplo
El siguiente código de programa pone a 0 un bit en la posición indicada bitposition de la
variable bvalue y muestra el resultado junto con el valor original bsaved.
{
BYTE bvalue;
BYTE bsaved = bvalue;
BYTE bitposition = 2;
Descripción
Ajusta a "1" (TRUE) el valor de una variable del tipo "Bool".
Parámetros
Variable
Variable del tipo BOOL que se ajusta a "1" (TRUE).
Ejemplo
El siguiente código de programa pone a 1 el valor de la variable booleana b_value con la
función SetBit y muestra el resultado junto con el valor original b_saved.
{
BOOL b_value = 0;
BOOL b_saved = b_value;
//Set bit
SetBit (b_value);
Descripción
Ajusta un bit a "1" (TRUE) en la variable indicada.
Tras modificar el bit indicado, la función de sistema vuelve a transferir toda la variable al
controlador. No se comprueba si entretanto se han modificado otros bits en la variable. El
operador y el controlador sólo podrán acceder a la variable indicada en modo de lectura hasta
que la variable vuelva a transferirse al controlador.
Nota
No utilice esta función de sistema si el controlador admite variables BOOL. En su lugar utilice
la función de sistema "ActivarBit".
Parámetros
Variable
Variable en la que un bit se ajusta a "1" (TRUE).
Bit
Número del bit que se ajusta a "1" (TRUE).
Si utiliza esta función de sistema en un script de usuario, los bits de la variable indicada se
contarán de derecha a izquierda, independientemente del controlador utilizado. El contaje
comienza a partir de "0".
Nota
Para garantizar una funcionalidad fiable es imprescindible una actualización garantizada de
las variables utilizadas con los valores de proceso actuales. Por tanto, configure la variable
en un campo E/S, o bien asocie la función de sistema a un objeto de imagen (p. ej. un botón).
Si asocia la función de sistema a un evento breve (p. ej. aparición de un mensaje), los valores
de proceso actuales sólo se alcanzarán si la variable puede leerse de forma permanente.
Ejemplo
El siguiente código de programa pone a 1 un bit en la posición indicada bitposition de la
variable bvalue y muestra el resultado junto con el valor original bsaved.
{
BYTE bvalue;
BYTE bsaved = bvalue;
BYTE bitposition = 2;
Descripción
Define el valor de una propiedad de objeto como cadena de caracteres.
Parámetros
Nombre de imagen
Nombre de la imagen en la que está contenido el objeto.
Objeto
Nombre del objeto cuya propiedad se modifica.
Nombre de la propiedad
Nombre de la propiedad que se modifica.
Valor
Valor que se asigna a la propiedad.
Ejemplo
El siguiente código de programa modifica la propiedad de un objeto con la función
SetPropertyByConstant: en la imagen "Trends" se ajusta la propiedad "ToolbarButtonClick"
del objeto incluido "Control_1" al valor 26.
Como alternativa, puede utilizar en lugar del segundo parámetro (Objeto) la contraseña NULL
o bien un string de espacios en blanco.
Descripción
Define el valor de una propiedad de objeto por medio de otra propiedad de objeto.
Parámetros
Nombre de imagen
Nombre de la imagen en la que está contenido el objeto.
Objeto
Nombre del objeto cuya propiedad se transfiere al objeto de destino.
Nombre de la propiedad
Nombre de la propiedad al que se transfiere el objeto de destino.
Objeto de destino
Nombre del objeto de destino al que se transfiere la propiedad.
Ejemplo
El siguiente código de programa transfiere con la función SetPropertyByProperty la propiedad
"ToolbarButtonClick" del objeto "Control_1" en la imagen de salida "Trend_1" a la propiedad
correspondiente de la imagen de destino"Trend_2".
Descripción
Define el valor de una propiedad de objeto por medio de un valor de variable.
Parámetros
Nombre de imagen
Nombre de la imagen en la que está contenido el objeto.
Objeto
Nombre del objeto cuya propiedad se activa por medio del valor de variable.
Nombre de la propiedad
Nombre de la propiedad que se activa por medio del valor de variable.
Nombre de variable
Nombre de la variable que contiene el valor de la propiedad.
Ejemplo
El siguiente código de programa modifica la propiedad de un objeto con la función
SetPropertyByTag: Al hacer clic sobre el objeto se transfieren el nombre del objeto y la imagen
en la que se encuentra el objeto. El título CaptionText de la ventana de imagen contiene el
valor de la variable HMI_value_1.
Ejemplo
El siguiente código de programa modifica la propiedad de un objeto con la función
SetPropertyByTag: en la imagen "Trends" se ajusta la propiedad "ToolbarButtonClick" del
objeto incluido "Control_1" al valor 26.
Descripción
Define el valor de una propiedad de objeto por medio de una variable. La variable contiene el
nombre de variable que determina la propiedad del objeto.
Parámetros
Nombre de imagen
Nombre de la imagen en la que está contenido el objeto.
Objeto
Nombre del objeto cuya propiedad se activa por medio del valor de variable.
Nombre de la propiedad
Nombre de la propiedad que se activa por medio del valor de variable.
Nombre de variable
Nombre de la variable que, a su vez, contiene el nombre de la variable que determina la
propiedad del objeto.
Ejemplo
El siguiente código de programa modifica la propiedad de un objeto con la función
SetPropertyByTagIndirect: .
Descripción
Asigna un valor nuevo a la variable indicada.
Nota
Dependiendo del tipo de variable, con esta función de sistema puede asignar cadenas de
caracteres y números.
Parámetros
Variable
Variable a la que se debe asignar el valor indicado.
Valor
Valor que se asigna a la variable indicada.
Nota
La función de sistema "DefinirVariable" se ejecuta únicamente tras establecer una conexión.
Ejemplo
El siguiente código de programa ajusta con la función SetTag el valor de las variables
gs_tag_bit a TRUE y guarda el valor de retorno en la variable ok.
{
BOOL ok;
BOOL bvalue;
Descripción
Define un valor de variable por medio del valor de una propiedad de objeto. La modificación
se registra adicionalmente en el sistema de avisos.
Parámetros
Nombre de variable
Nombre de la variable cuyo valor se define por medio de la propiedad de objeto.
Nombre de imagen
Nombre de la imagen en la que está contenido el objeto.
Objeto
Nombre del objeto cuya propiedad proporciona el valor de variable.
Nombre de la propiedad
Nombre de la propiedad que proporciona el valor de variable.
Ejemplo
El siguiente código de programa devuelve el valor del texto seleccionado al hacer clic en un
cuadro combinado.
{
char* rt_value;
...
}
Descripción
Define el valor de variable por medio del valor de una variable indirecta. La modificación se
registra adicionalmente en el sistema de avisos.
Parámetros
Nombre de variable
Nombre de la variable cuyo valor se define por medio de una variable indirecta.
Nombre de variable
Nombre de la variable indirecta que proporciona el valor de variable.
Ejemplo
El siguiente código de programa devuelve el valor de la variable "@LocalMachineName" al
hacer clic en cualquier tecla.
{
char* rt_value;
...
}
Descripción
Define el nombre indirecto para una variable.
Parámetros
LpValue
Nombre de la variable en la que se escribe la variable.
Ejemplo
El siguiente código de programa transfiere el valor de la variable "value" a la variable "result"
al hacer clic en cualquier tecla.
{
BYTE result;
BYTE value;
Descripción
Define un nombre de variable por medio del valor de una propiedad de objeto. La modificación
se registra adicionalmente en el sistema de avisos.
Parámetros
Nombre de variable
Nombre de la variable cuyo nombre se define por medio de la propiedad de objeto.
Nombre de imagen
Nombre de la imagen en la que está contenido el objeto.
Objeto de imagen
Nombre del objeto cuya propiedad proporciona el nombre de variable.
Nombre de la propiedad
Nombre de la propiedad que proporciona el nombre de variable.
Ejemplo
El siguiente código de programa ajusta la variable "rt_value_property" al valor de la propiedad
"FlashingEnabled" al hacer clic en la tecla objectName.
{
Int rt_value_property;
SetTagIndirectByProperty ("rt_value_property", screenName, objectName, "FlashingEnabled",
hmiWithoutOperatorEvent);
...
}
Descripción
Define el valor de variable por medio del valor de una variable indirecta. La modificación se
registra adicionalmente en el sistema de avisos.
Parámetros
Nombre de variable
Nombre de la variable indirecta cuyo valor se define por medio de una variable indirecta.
nombre de variable
Nombre de la variable indirecta que proporciona el valor de variable.
Ejemplo
El siguiente código de programa ajusta la variable "rt_value" al valor de la variable "value" al
hacer clic en la tecla objectName.
{
Int rt_value;
Int value;
Descripción
Define el nombre indirecto para una variable. La modificación se registra adicionalmente en
el sistema de avisos.
Parámetros
LpValue
Nombre de la variable en la que se escribe la variable.
Descripción
Define el valor de una variable. La modificación se registra adicionalmente en el sistema de
avisos.
Parámetros
LpValue
El valor que se escribe la variable.
Ejemplo
El siguiente código de programa transfiere el valor de la variable "value" a la variable "result"
al hacer clic en cualquier tecla.
{
BYTE result;
BYTE value;
Descripción
Abre un cuadro de diálogo en el panel de operador con el que el usuario puede iniciar una
sesión en el panel de operador.
Parámetros
--
Descripción
Sale del software runtime y, con ello, del proyecto que se está ejecutando en el panel de
operador.
Parámetros
Modo
Determina si al finalizar el software runtime también se debe cerrar el sistema operativo.
0 (hmiStopRuntime) = Runtime: No cerrar el sistema operativo
1 (hmiStopRuntimeAndOperatingSystem) = Runtime y sistema operativo: Cerrar el sistema
operativo (no en Windows CE)
Ejemplo
El siguiente código de programa cierra Runtime y el sistema operativo.
VBScript
Si ya conoce Visual Basic o Visual Basic para aplicaciones, VBScript le resultará familiar. Y
si no conoce Visual Basic y empieza a trabajar con él, aprenderá al mismo tiempo el
funcionamiento de todos los lenguajes de programación Visual Basic. Encontrará una buena
introducción a la programación en los libros Step by Step de Microsoft Press.
En la página web de Microsoft encontrará también información básica relacionada con los
detalles de VBScript para los elementos del lenguaje.
http://msdn.microsoft.com/en-us/library/t0aew7h6.aspx
Function
This property of the File control returns a number indicating the file mode that was used to
open the file.
Sintaxis
file.Attr
Parameters
File
Reference to a File control.
Return Values
The return values listed in the following table indicate the file access mode. If the return value
is 0, the file is closed.
Constant Value
None 0
fsModeInput 1
fsModeOutput 2
fsModeRandom 4
fsModeAppend 8
fsModeBinary 32
Remarks
The Attr property is read-only. Use the Open method of the File control to set the file mode.
Function
This method closes an open File control.
Syntax
file.Close
Parameters
File
Name of a File control.
Return Values
None.
Remarks
Use the Open method to open a file.
Function
This function creates a reference to an Automation object.
Sintaxis
CreateObject (Object)
Parameters
Object
A string containing the ProgID of the object to create.
Return Values
Returns a reference to an Automation object.
Remarks
Use CreateObject to create non-visible ActiveX controls at runtime. You cannot use
CreateObject to create graphical objects such as a TreeView control or a ListView control.
CreateObject produces objects that cannot respond to events. To produce objects that can
respond to events, use the CreateObjectWithEvents function. The following table lists the
ProgIDs for the ActiveX controls without events.
Control ProgID
Microsoft CE File control 6.0 .file
Microsoft CE FileSystem control 6.0 .filesystem
Microsoft CE ImageList control 6.0 CEimageList.imagelistctrl
Example
Dim f, fwModeAppend
Set f = CreateObject("FileCtl.File")
fwModeAppend=8
f.Open "\Storage Card\testfile.txt", fwModeAppend
f.Close
Function
This method returns the name of a file, directory, or folder that matches a specified pattern or
file attribute.
Sintaxis
File.Dir (Pathname,[Attributes])
Parameters
File
Reference to a FileSystem control.
Pathname
Opcional. String expression that specifies a file name or path.
Attributes
Opcional. Numeric expression whose sum specifies file attributes. If omitted, all files that match
pathname are returned.
Return Values
String File name that matches pathname and attributes. Dir returns a zero-length string ("") if
pathname is not found.
Remarks
Dir supports the use of multiple-character (*) and single-character (?) wildcards to specify
multiple files. You must specify pathname the first time you call the Dir method. In addition, if
you specify file attributes you must include pathname.
The Dir method returns the first file name that matches pathname. To get any additional file
names that match pathname, call Dir again with no parameters. When no more file names
match, Dir returns a zero-length string (" "). Once a zero-length string is returned, you must
specify pathname in subsequent calls.
Function
This property returns True when the end of a file opened for random or sequential input is
reached.
Syntax
File.EOF
Parameters
File
Reference to a File control.
Remarks
Use the EOF property to avoid the error generated by attempting to read past the end of a file.
The EOF property returns False until the end of the file has been reached. For files opened
with a fsModeRandom or fsModeBinary file mode, EOF returns False until the last executed
Get statement is unable to read an entire record.
For files opened with a fsModeBinary file mode, an attempt to read through the file using the
Input function until EOF returns True generates an error. Use the LOF and LOC properties
instead of EOF when reading binary files with Input, or use Get when using the EOF property.
For files opened with a fsModeOutput file mode, EOF always returns True.
Function
This method copies an existing file to a new file.
Syntax
Filesystem.FileCopy PathName, NewPathName
Parameters
Filesystem
Reference to a FileSystem object.
PathName
String that contains the path and file name.
NewPathName
String that contains the file name and path of the new file.
Return Values
None.
Remarks
FileCopy returns an error if the new file does not exist.
Function
This method returns a value specifying the length, in bytes, of a file.
Syntax
Filesystem.FileLen(pathname)
Parameters
Filesystem
Reference to a FileSystem control.
Pathname
Required. String expression that specifies a file. The pathname can include a directory or folder.
Return Values
Returns the number of bytes in a file.
Remarks
If the specified file is open when the FileLen method is called, the value returned represents
the size of the file immediately before it was opened.
Function
This method returns a variant (Date) that indicates the date and time when a file was created
or last modified.
Syntax
filesystem.FileDateTime(pathname)
Parameters
Filesystem
Reference to a FileSystem control.
Pathname
Required. String expression that specifies a file name. The pathname can include a directory
or folder.
Return Values
Returns the date the file was last modified.
Remarks
FileDateTime returns an error if the new file does not exist.
Function
This method reads data from an open disk file into a variable.
Syntax
file.Get Data, [Recnumber]
Parameters
File
Reference to a File control.
Data
Required. Variant variable into which data is read.
Recnumber
Optional. Variant. Record number at which reading begins. For files opened in binary mode,
Recnumber specifies the byte position.
Return Values
None
Remarks
Data read with the Get method usually is written to a file with the Put method. The first record
or byte in a file is at position 1, the second record or byte is at position 2, and so on. If you omit
Recnumber, the next record or byte following the last Get or Put method (or pointed to by the
last Seek function) is read.
Function
This method returns a number representing the attributes of a file, directory, or folder.
Sintaxis
filesystem.GetAttr(pathname)
Parameters
Filesystem
Reference to a FileSystem control.
Pathname
Required. String expression that specifies a file name or directory or a folder name. The
pathname can include the directory or folder.
Return Values
Sum of attribute values. The following table shows the sums that can be returned.
Remarks
To determine which attributes are set, use the And operator to perform a bitwise comparison
of the value returned by the GetAttr method and the value of the individual file attribute you
want. If the result is not zero, that attribute is set for the named file.
Function
This method returns a string containing characters from a file opened in Input or Binary mode.
Syntax
file.Input(number)
Parameters
File
Reference to a File control.
Number
Any valid numeric expression that specifies the number of characters to return.
Return Values
String containing characters read from file.
Remarks
Data read with the Input method usually is written to a file with the LinePrint or Put functions.
Use this method only with files opened in Input or Binary mode.
Unlike the LineInputString method, the Input method returns all the characters it reads,
including commas, carriage returns, line feeds, quotation marks, and leading spaces.
With files opened for Binary access, an attempt to read through the file using the Input method
until the EOF function returns True generates an error. To avoid an error, use the LOF and
Loc functions instead of EOF when reading binary files with the Input method or use Get when
using the EOF function.
Function
This method reads data from an open sequential file and returns a single dimension Variant
array.
Sintaxis
file.InputFields(número)
Parameters
File
Reference to a File control.
Number
Number of comma-delimited fields to read from the file.
Return Values
Array containing the fields read from the file.
Remarks
Data read with the InputFields method usually is written to a file with WriteFields. Use this
method only with files opened in Input or Binary mode.
InputFields reads standard string or numeric data without modification. The following table
shows how InputFields reads other input data.
Function
This method returns bytes from a file opened in Input or Binary mode.
Syntax
file.InputB(number)
Parameters
File
Reference to a File control.
Number
Any valid numeric expression that specifies the number of bytes to return.
Return Values
Array containing bytes read from file.
Remarks
Data read with the InputB method usually is written to a file with the LinePrint or Put functions.
Use this method only with files opened in Input or Binary mode.
Function
This method deletes files from a disk.
Syntax
filesystem.Kill pathname
Parameters
Filesystem
Reference to a FileSystem control.
Pathname
Required. String expression that specifies one or more file names to be deleted. The pathname
can include the directory or folder.
Return Values
None.
Remarks
The Kill method supports the use of multiple-character (*) and single-character (?) wildcards
to specify multiple files.
An error occurs if you try to use Kill to delete an open file.
Function
This method reads a single line from an open sequential file and assigns it to a string variable.
Syntax
file.LineInputString
Parameters
File
Reference to a File control.
Return Values
None.
Remarks
Data read with LineInputString usually is written from a file with LinePrint.
The LineInputString method reads from a file one character at a time until it encounters a
carriage return (Chr(13)) or carriage return/line feed (Chr(13) + Chr(10)) sequence. Carriage
return/line feed sequences are skipped rather than appended to the character string.
Function
This method writes a single line to an open sequential file.
Syntax
file.LinePrint output
Parameters
File
Reference to a File control.
Output
String expression to write to a file.
Return Values
None.
Remarks
Data written with LinePrint is usually read from a file with LineInputString.
A carriage return/line feed (Chr(13) + Chr(10)) sequence is appended to the end of the string.
Function
This property returns a number specifying the current read/write position.
Syntax
file.Loc
Parameters
File
Reference to a File control.
Remarks
For files opened with the fsModeRandom file mode, Loc returns the number of the last record
read or written. For files opened with all other modes, Loc returns the position of the last byte
read or written.
Function
This property returns a number representing the size, in bytes, of a file.
Syntax
file.LOF
Parameters
File
Reference to a File control.
Remarks
The LOF property can be used with the Loc property to guarantee that a read operation does
not continue past the end of a file.
Function
This method creates a new directory.
Syntax
filesystem.MkDir PathName
Parameters
Filesystem
Reference to a FileSystem control.
Pathname
String expression that contains the directory name.
Return Values
None.
Remarks
MkDir generates an error if the directory already exists.
Function
This method renames an existing file or a directory, including all its subdirectories.
Syntax
filesystem.MoveFile PathName, NewPathName
Parameters
Filesystem
Reference to a FileSystem control.
PathName
String that contains the file name.
NewPathName
String that contains the file name to copy to.
Return Values
None.
Function
This method opens a file in either the Input (1), Output (2), Random (4), Append (8), or Binary
mode (32).
Syntax
file.Open pathname, mode, [access], [lock], [reclength]
Parameters
File
Reference to a File control.
Pathname
String expression that specifies a file name.
Mode
Specifies the file mode: Input (1), Output (2), Random (4) , Append (8), or Binary (32).
Access
Operation permitted on the open file: Read, Write, or ReadWrite [Default]. (1, 2, 3)
Lock
Operations permitted on the open file by other processes: Shared, LockRead, LockWrite
[Default], and LockReadWrite. (1, 2, 3, 0)
Reclength
Number, in bytes, that is less than 32,767. For files opened for random access, this value is
the record length. For sequential files, this value is the number of characters buffered.
Return Values
None.
Remarks
The reclength parameter is ignored if the mode is Binary. When opening a file in Random
mode, you must specifiy a record size of greater than zero or an error will occur.
Function
This method writes data from a variable to a disk file.
Syntax
file.Put data, [recnumber]
Parameters
Data
Required. Variant variable that contains data to be written to disk.
Recnumber
Optional. Variant (Long). Record number (Random mode files) or byte number (Binary mode
files) at which writing begins.
Return Values
None.
Remarks
Data written with Put usually is read from a file with Get.
The first record or byte in a file is at position 1, the second record or byte is at position 2, and
so on. If you omit recnumber, the next record or byte after the last Get or Put method or pointed
to by the last Seek function is written.
For files opened in Random mode, the following rules apply:
● If the length of the data being written is less than the length specified in the Len clause of
the Open method, Put writes subsequent records on record-length boundaries. The space
between the end of one record and the beginning of the next record is padded with the
existing contents of the file buffer. Because the amount of padding data cannot be
determined with any certainty, it generally is a good idea to have the record length match
the length of the data being written. If the length of the data being written is greater than
the length specified in the Len clause of the Open method, an error occurs.
● If the variable being written is a Variant of a numeric type, Put writes 2 bytes identifying the
VarType of the Variant and then writes the variable. For example, when writing a Variant
of VarType 3, Put writes 6 bytes: 2 bytes identifying the Variant as VarType 3 (Long) and
4 bytes containing the Long data. The record length specified by the Len clause in the Open
method must be at least 2 bytes greater than the actual number of bytes required to store
the variable.
You can use the Put method to write a Variant array to disk, but you cannot use Put to write
a scalar Variant containing an array to disk. You also cannot use Put to write objects to disk.
If the variable being written is a Variant of VarType 8 (String), Put writes 2 bytes identifying
the VarType and 2 bytes indicating the length of the string. It then writes the string data. The
record length specified by the Len clause in the Open method must be at least 4 bytes greater
than the actual length of the string.
If the variable being written is a dynamic array, Put writes a descriptor whose length equals 2
plus 8 times the number of dimensions, that is, 2 + 8 * NumberOfDimensions. The record length
specified by the Len clause in the Open method must be greater than or equal to the sum of
all the bytes required to write the array data and the array descriptor. For example, the following
array declaration requires 118 bytes when the array is written to disk.
For files opened in Binary mode, the Len clause in the Open method has no effect. Put writes
all variables to disk contiguously; that is, with no padding between records.
Function
This method deletes an existing empty directory.
Syntax
filesystem.RmDir PathName
Parameters
Filesystem
Reference to a FileSystem control.
PathName
String that contains the directory name.
Return Values
None.
Remarks
The directory must be empty before it can be removed. You must specify a complete file path.
Function
This property returns and sets the next position in a file that will be read or written.
Syntax
file.Seek [= position]
Parameters
File
Reference to a File control.
Position
Numeric expression that specifies a position within a file.
Remarks
The Seek property specifies the next file position, whereas the Loc property specifies the
current position. Seek always will be one more than Loc, except when a file is first opened and
Seek and Loc are both 1.
Negative Seek or 0 causes an error.
Function
This method sets attribute data for a file.
Sintaxis
filesystem.SetAttr pathname, attributes
Parameters
Filesystem
Reference to a FileSystem control.
Pathname
Required. String expression that specifies a file name.
Attributes
Required. Numeric expression whose sum specifies file attributes. The following table shows
the parameter settings of attributes.
Return Values
None
Remarks
A run-time error occurs if you try to set the attributes of an open file.
Function
This method writes data to a sequential file.
Syntax
file.WriteFields [data]
Parameters
File
Reference to a File control.
Data
Variant or Variant array of numeric or string expressions to write to a file.
Prinzip
Return Values
None.
Remarks
Data written with WriteFields is usually read from a file with InputFields.
If you omit d ata, a blank line is printed to the file.
● Numeric data is always written using the period as the decimal separator.
● For Boolean data, either #TRUE# or #FALSE# is printed. The True and False keywords
are not translated, regardless of locale.
● Date data is written to the file using the universal date format. When either the date or the
time component is missing or is zero, only the component provided gets written to the file.
● Nothing is written to the file if Data is Empty. However, for Null data, #NULL# is written.
● If d ata is Null, #NULL# is written to the file.
The WriteFields method inserts commas between items and quotation marks around strings
as they are written to the file. You do not have to put explicit delimiters in the list. WriteFields
inserts a newline character—that is, a carriage return/line feed (Chr(13) + Chr(10))—after it
has written the final character in data to the file.
$FWLYH3URMHFW
$FWLYH6FUHHQ
'DWD6HW
'DWD,WHP
+0,5XQWLPH
/RJJLQJ $ODUPORJV
'DWDORJV
$ODUPV 3URFHVVYDOXHV
$ODUP 3URFHVVYDOXH
6FUHHQV
6FUHHQ $FWLYH6FUHHQ,WHP
'DWD6HW
'DWD,WHP
/D\HUV
/D\HU
6FUHHQ,WHPV
6FUHHQ,WHP
7DJV 7DJ6HW
7DJ 7DJ
Por medio del modelo de objeto WinCC del sistema runtime gráfico se accede a objetos y
variables en runtime.
Objetos
A través de los objetos y listados Ud. recibe acceso a todos los objetos del sistema gráfico
Runtime:
● Objetos de indicación y control
● Imágenes
● Niveles
● Variables
Propiedades
Por medio de las propiedades de los objetos individuales se modifican selectivamente objetos
de indicación y control y variables en runtime. Por ejemplo, se habilita un botón con un clic o
se desencadena un cambio de color al cambiar el valor de una variable.
Métodos
Con los métodos que se aplican en los objetos individuales, p. ej., es posible leer valores de
variables para su procesamiento ulterior o visualizar avisos en runtime.
Descripción
+0,5XQWLPH
6FUHHQV 6PDUW7DJV
6FUHHQ 6PDUW7DJ
Utilización
El objeto "HMIRuntime" se utiliza del siguiente modo, p. ej.:
● leer o definir el idioma actual de runtime (propiedad "Language")
● Leer el nombre de la imagen raíz actual o provocar un cambio de imagen básica definiendo
un nuevo nombre de imagen (propiedad "BaseScreenName")
● Acceder a variables (lista "SmartTags")
● Finalizar runtime (método "Stop")
● Visualizar informaciones sobre el seguimiento del proceso (método "Trace")
● Direccionar las imágenes visualizadas en runtime (lista "Screens")
Consulte también
ActiveScreen (Página 1548)
Descripción
+0,5XQWLPH
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
Nota
La ventana de avisos y el indicador de avisos no están contenidos en la lista "Screens", aunque
estén marcados en runtime.
Utilización
Utilice la propiedad "Screens" para retornar la lista "Screens". En el ejemplo siguiente, el color
de fondo se cambia de negro a verde:
Utilice el nombre del objeto en calidad de índice.
'VBS_Example_BackColor
HMIRuntime.Screens("Rootscreen").BackColor = vbGreen
Nota
Al cambiar de imagen, dejan de ser válidas todas las referencias abiertas a la imagen que ya
no existe. Por tanto, no podrá seguir utilizando dichas referencias.
Descripción
+0,5XQWLPH
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
Utilización
El objeto "Screen" permite:
● Leer el ancho y la altura de una imagen (propiedades "Width" y "Height").
● Modificar el color de fondo (propiedad "BackColor").
Utilice el nombre del objeto en calidad de índice.
En el ejemplo siguiente, el color de fondo se cambia de negro a verde:
'VBS_Example_BackColor
HMIRuntime.Screens("Rootscreen").BackColor = vbGreen
Consulte también
ScreenItem (Página 1298)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Utilización
En función de determinados eventos, el objeto "ScreenItem" sirve para acceder a las
propiedades de los objetos gráficos contenidos en una imagen.
El objeto "ScreenItem" se utiliza del siguiente modo, p. ej.:
● Propiedad "Visible"
Activar o desactivar la visibilidad de un objeto
● Propiedades "Height" y "Width"
Averiguar el ancho y la altura de un objeto
● Propiedades "Top" y "Left"
Modificar la posición de un objeto
● Propiedad "ObjectName"
Leer el nombre de un objeto gráfico
● Propiedad "Parent"
Crear una referencia con la imagen de orden superior
Utilice la propiedad "ScreenItems" para retornar un objeto de la imagen. Utilice el nombre del
objeto en calidad de índice.
Ejemplo
En el ejemplo siguiente, el color de fondo del círculo "myCircle" de la imagen "RootScreen"
se ajusta a "verde".
'VBS_Example_ScreenItems
Dim objCircle
Set objCircle = HMIRuntime.Screens("RootScreen").ScreenItems("myCircle")
objCircle.BackColor = vbGreen
Nota
Para ahorrar espacio de memoria en el panel de operador, al cargar el proyecto no se
transfieren nombres de objetos. No obstante, si desea transferir también los nombres, abra
en WinCC la configuración de runtime para el panel de operador en cuestión. En "General"
podrá modificar los ajustes deseados. Los nombres de los objetos se necesitan si desea
acceder a ellos a través de su nombre, o bien para depurar un proyecto.
Descripción
+0,5XQWLPH
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
Esta lista contiene los objetos "ScreenItem", es decir, todos los objetos de imagen que
conforman la imagen de proceso indicada. La lista tiene una propiedad "Parent". Esta
propiedad sirve para indicar la imagen de proceso en la que se encuentra el objeto de imagen.
Utilización
La lista "ScreenItems" permite
● Indicar o editar todos los objetos contenidos en la lista (es decir, todos los objetos de una
imagen)
● Contar los objetos de una imagen (propiedad "Count").
● Editar un objeto determinado de la lista (método "Item").
Utilice la propiedad "ScreenItems" para retornar un objeto de la imagen de proceso. Utilice el
nombre del objeto en calidad de índice.
En el ejemplo siguiente, el color de fondo del círculo "myCircle" de la imagen "RootScreen"
se ajusta a "verde".
Dim objCircle
Set objCircle = HMIRuntime.Screens("RootScreen").ScreenItems("myCircle")
objCircle.BackColor = vbGreen
Descripción
+0,5XQWLPH
6PDUW7DJV
6PDUW7DJ
Esta lista contiene los objetos "SmartTag" que representan todas las variables en WinCC
Runtime.
Nota
La lista "SmartTags" tiene una funcionalidad limitada. Para acceder a un objeto SmartTag sólo
se puede utilizar el nombre de la variable correspondiente. No es posible acceder a través del
índice ni utilizar la instrucción "For-Each".
Nota
Si desea acceder a una variable que todavía no está creada en el proyecto con la lista
SmartTags, no se devolverá ningún valor. No se realizará ninguna asignación a una variable
que no exista:
Dim intVar
intVar = SmartTags("FillLevel")
"intVar" permanece vacío si la variable "FillLevel" no está creada.
Utilización
Utilice la lista "SmartTags" para retornar un objeto SmartTag. Utilice el nombre de la variable
para crear una referencia con el objeto SmartTag:
'VBS_Example_SmartTags
'Writes tag value to local tag and returns a user-defined text through the
operating system channel for debug alarms.
Dim strAirPressure
strAirPressure = "Current air pressure: " + CStr(SmartTags("AirPressure"))
HMIRuntime.Trace strAirPressure
Dim strAirPressure
strAirPressure = "Current air pressure: " + CStr(AirPressure)
HMIRuntime.Trace strAirPressure
Descripción
+0,5XQWLPH
6PDUW7DJV
6PDUW7DJ
Representa el valor de las variables de proceso indicadas. El objeto SmartTag forma parte
de la lista "SmartTags".
Utilización
El objeto SmartTag permite leer y escribir el valor de la variable de proceso indicada. El objeto
SmartTag no retorna una referencia de objeto. Utilice la lista "SmartTags" para retornar el
valor de una variable de proceso. Utilice el nombre de la variable en calidad de índice.
Nota
Con el ajuste "SmartTags lee valores del cache", los valores no se leen directamente del
controlador, sino de la memoria imagen de proceso (cache).
El objeto SmartTag también puede leer valores directamente del controlador. Sin embargo,
en tal caso hay que contar con una carga por comunicaciones mucho mayor entre el dispositivo
HMI y el controlador.
Ejemplo
'VBS_Example_SmartTags
'Writes tag value to local tag and returns a user-defined text through the
operating system channel for debug alarms.
Dim strAirPressure
strAirPressure = "Current air pressure: " + CStr(SmartTags("AirPressure"))
HMIRuntime.Trace strAirPressure
Nota
Si desea acceder a una variable que todavía no está creada en el proyecto con la lista
SmartTags, no se devolverá ningún valor. No se realizará ninguna asignación a una variable
que no exista:
Dim intVar
intVar = SmartTags("FillLevel")
"intVar" permanece vacío si la variable "FillLevel" no está creada.
Nota
Si desea retornar el tipo de datos de un objeto SmartTag con la función de VBS "TypeName",
utilice la sintaxis siguiente:
TypeName(SmartTags("FillLevel").value)
Descripción
+0,5XQWLPH
Alarms 3URFHVVYDOXHV
$ODUP 3URFHVVYDOXH
Nota
Las propiedades del objeto Alarm no se actualizan automáticamente si cambian los valores
de las mismas.
Descripción
+0,5XQWLPH
Alarms 3URFHVVYDOXHV
$ODUP 3URFHVVYDOXH
Utilización
Con el listado "Alarms" Ud. puede:
● Acceder a un mensaje del listado (método Item)
● Generar un nuevo objeto de alarma (método Create)
● Leer el AlarmID del mensaje (propiedad AlarmID)
● Leer el estado de un mensaje (propiedad State)
● Leer el AlarmID del mensaje (propiedad AlarmID)
● Crear una instancia del objeto Alarm (propiedad Instance)
● Leer el nombre del ordenador en el que ha aparecido el mensaje (propiedad
ComputerName)
● Leer o fijar el nombre del usuario que ha emitido el mensaje (propiedad UserName)
● Leer o fijar los nombres de los bloques de valores de proceso (propiedad ProcessValues)
● Leer o fijar el comentario del mensaje (propiedad Comment)
● Leer o fijar el prefijo de servidor del mensaje (propiedad Context)
Ejemplo
En el siguiente ejemplo se activa el aviso configurado en el editor "Avisos HMI" con el número
de aviso "1":
'VBS360
Dim MyAlarm
Set MyAlarm = HMIRuntime.Alarms(1)
MyAlarm.State = 5 'hmiAlarmStateCome + hmiAlarmStateComment
MyAlarm.Comment = "MyComment"
MyAlarm.UserName = "Hans-Peter"
MyAlarm.ProcessValues(1) = "Process Value 1"
MyAlarm.ProcessValues(4) = "Process Value 4"
MyAlarm.Create "MyApplication"
Consulte también
AlarmID (Página 1556)
Descripción
/RJJLQJ $ODUPORJV
'DWDORJV
Con el objeto se vuelven a asociar con runtime segmentos trasvasados del fichero de avisos
o se vuelven a borrar segmentos previamente almacenados del fichero de avisos. Los
segmentos de fichero que deben almacenarse se copian en la carpeta "Common Archiving"
del proyecto de WinCC. Los segmentos de fichero previamente almacenados se borran en la
carpeta "Common Archiving".
Por medio de parámetros se controla el lugar desde el que se deben almacenar segmentos
de fichero. También se determina el período en el cual se almacenan o borran segmentos de
fichero.
Si se produce un error durante la operación con los segmentos de fichero, el método aplicado
devuelve un mensaje de error.
Utilización
● Método "Restore"
Los segmentos previamente trasvasados del fichero de avisos se asocian con runtime.
● Método "Remove"
Los segmentos previamente almacenados del fichero de avisos se borran del proyecto
runtime.
Ejemplo
En el siguiente ejemplo se guardan segmentos del fichero de avisos y el valor de retorno se
indica como Trace.
'VBS187
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.AlarmLogs.Restore("D:
\Folder","2004-09-14","2004-09-20",-1) & vbNewLine
Consulte también
Restore (Página 2245)
Remove (Página 2240)
Descripción
+0,5XQWLPH
'DWD6HW
'DWD,WHP
6FUHHQV 'DWD6HW
6FUHHQ 'DWD,WHP
El objeto DataItem se usa para acceder a los contenidos de la lista DataSet. Los valores o
referencias de un objeto se guardan en el listado como DataItem.
El acceso se realiza con el nombre con el que se agregó el valor al listado. No se recomienda
el acceso individual a través del índice porque el índice varía al agregar o borrar valores. El
índice se utiliza para presentar el contenido completo de la lista. La salida se realiza en orden
alfabético.
Nota
En las referencias de objetos hay que asegurarse de que los objetos son aptos para
multithread.
Ejemplo
El ejemplo muestra cómo se visualiza como Trace el valor de 'Motor1'.
'VBS163
HMIRuntime.Trace "motor1: " & HMIRuntime.DataSet("motor1").Value & vbNewLine
El siguiente ejemplo enumera todos los objetos DataItem del listado DataSet. El Nombre
(Name) y el valor (Value) tienen salida como Trace.
'VBS164
Dim data
For Each data In HMIRuntime.DataSet
HMIRuntime.Trace data.Name & ": " & data.Value & vbNewLine
Next
Nota
En objetos puede suceder que Value no tenga una salida directa.
Consulte también
Value (Página 1968)
Name (Página 1749)
Descripción
/RJJLQJ $ODUPORJV
'DWDORJV
Con el objeto se vuelven a asociar con runtime segmentos trasvasados del fichero de variables
o se vuelven a borrar segmentos previamente almacenados del fichero de variables. Los
segmentos de fichero que deben almacenarse se copian en la carpeta "Common Archiving"
Utilización
● Método "Restore"
Los segmentos previamente trasvasados del fichero de variables se asocian con runtime.
● Método "Remove"
Los segmentos previamente almacenados del fichero de variables se borran del proyecto
runtime.
Ejemplo
En el siguiente ejemplo se almacenan segmentos del fichero de variables rápido y el valor de
retorno se indica como Trace.
'VBS188
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.DataLogs.Restore("D:
\Folder","2004-09-14","2004-09-20",-1,1) & vbNewLine
Consulte también
Restore (Página 2245)
Remove (Página 2240)
Descripción
+0,5XQWLPH
'DWD6HW
'DWD,WHP
6FUHHQV 'DWD6HW
6FUHHQ 'DWD,WHP
Nota
Objetos del tipo Screen, Screens, ScreenItem, ScreenItems, Tag y TagSet no pueden ser
incluidos en la lista DataSet.
El objeto DataSet no soporta ninguna clase.
Utilización
La lista "DataSet" puede utilizarse del modo siguiente:
● Enumerar
Mostrar o editar todos los objetos dentro de la lista
● Propiedad "Count"
Mostrar el número de elementos contenidos
● Método "Item"
Editar un objeto determinado de la lista
● Método "Add"
Agregar un objeto a la lista
● Método "Remove"
Eliminar un objeto determinado de la lista
● Método "RemoveAll"
Eliminar todos los objetos de la lista
El acceso a los elementos de la lista se realiza del siguiente modo:
HMIRuntime.DataSet("Itemname")
HMIRuntime.Screens("Screenname").DataSet("Itemname")
DataSet("Itemname")
Ejemplo
El ejemplo muestra cómo incluir un valor en la lista, leer el valor, y eliminar nuevamente el
valor en diferentes acciones.
'VBS162
HMIRuntime.DataSet.Add "motor1", 23
HMIRuntime.Trace "motor1: " & HMIRuntime.DataSet("motor1").Value & vbNewLine
HMIRuntime.DataSet.Remove("motor1")
Consulte también
RemoveAll (Página 2244)
Remove (Página 2240)
Item (Página 2222)
Add (Página 2160)
Descripción
+0,5XQWLPH
$ODUPV
$ODUP
7DJV
7DJ
6FUHHQV
6FUHHQ
'DWD6HW
'DWD,WHP
/RJJLQJ
$FWLYH3URMHFW
$FWLYH6FUHHQ
Utilización
El objeto "HMIRuntime" se utiliza, p. ej., del siguiente modo:
● Propiedad "Language"
Leer o definir el idioma actual de runtime.
● Propiedad "BaseScreenName"
Leer o definir la imagen raíz actual
● Propiedad "ActiveProject"
Leer la ruta del proyecto runtime activo
● Propiedad "Tags"
Acceder a variables
● Propiedad "DataSet"
Acceder a variables de una lista
● Método "Stop"
Finalizar runtime
● Método "Trace"
Visualizar avisos en una ventana de diagnóstico
Ejemplo
El siguiente comando finaliza WinCC Runtime:
'VBS3
HMIRuntime.Stop
Consulte también
Trace (Página 2265)
Stop (Página 2264)
Language (Página 1702)
Tags (Página 1856)
Logging (Página 1725)
DataSet (Página 1635)
CurrentContext (Página 1630)
MenuToolBarConfig (Página 1729)
Descripción
El objeto Item proporciona una referencia al objeto actual.
Utilización
El objeto Item se utiliza, p. ej., para acceder a las propiedades del objeto actualmente marcado
en la imagen.
Ejemplo
En el siguiente ejemplo se pone en rojo el color de fondo del objeto que está marcado en la
imagen:
'VBS195
Item.BackColor = RGB(255,0,0)
Descripción
6FUHHQV
6FUHHQ
/D\HUV
/D\HU
Objeto Parent
Imagen en la que está el nivel de la imagen
Utilización
Por medio del objeto Layer se accede a las propiedades de un nivel completo dependiendo
de determinados eventos, p. ej. para ocultar o mostrar un nivel con elementos de control
dependiendo de la autorización de uso.
Ejemplo
En el siguiente ejemplo se pone el nivel 1 en "invisible":
'VBS4
Layers(2).Visible = vbFalse
Consulte también
Name (Página 1749)
Descripción
6FUHHQV
6FUHHQ
/D\HUV
/D\HU
Con la lista Layers se accede a los 32 niveles del sistema runtime gráfico.
Objeto Parent
Imagen en la que está el nivel de la imagen
Utilización
La lista "Layers" se utiliza del siguiente modo:
● Propiedad "_NewEnum"
Editar todos los niveles dentro de la lista
● Propiedad "Count"
Contar todos los niveles contenidos en la lista
● Método "Item"
Editar el nivel desde la lista
Las propiedades son propiedades y métodos predeterminados de un listado y no son descritos
detalladamente en la documentación de WinCC.
Consulte también
Item (Página 2222)
Descripción
+0,5XQWLPH
/RJJLQJ $ODUPORJV
'DWDORJV
Con el objeto se vuelven a asociar con runtime segmentos de fichero trasvasados o se vuelven
a borrar segmentos de fichero previamente almacenados. Los segmentos de fichero que
deben almacenarse se copian en la carpeta "Common Archiving" del proyecto de WinCC. Los
segmentos de fichero previamente almacenados se borran en la carpeta "Common Archiving".
Por medio de parámetros se controla el lugar desde el que se deben almacenar segmentos
de fichero. También se determina el período en el cual se almacenan o borran segmentos de
fichero.
Si se produce un error durante la operación con los segmentos de fichero, el método aplicado
devuelve un mensaje de error.
Utilización
● Método "Restore"
Los segmentos previamente trasvasados del fichero de avisos y del fichero de variables
se asocian con runtime.
● Método "Remove"
Los segmentos previamente almacenados del fichero de avisos y del fichero de variables
se borran del proyecto runtime.
Ejemplo
En el siguiente ejemplo se almacenan segmentos del fichero de avisos y del fichero de
variables y el valor de retorno se indica como Trace.
'VBS189
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.Restore("D:
\Folder","2004-09-14","2004-09-20",-1) & vbNewLine
Consulte también
Restore (Página 2245)
Remove (Página 2240)
DataLogs (lista) (Página 1309)
AlarmLogs (lista) (Página 1306)
Descripción
+0,5XQWLPH
$FWLYH3URMHFW
Utilización
Por medio del objeto "Project" se lee lo siguiente:
● la ruta del proyecto runtime actual (propiedad "Path")
● el nombre del proyecto runtime actual, sin indicación de ruta ni extensión de archivo
(propiedad "Name")
Ejemplo
El siguiente ejemplo indica como Trace el nombre y la ruta del proyecto runtime actual:
'VBS159
HMIRuntime.Trace "Name: " & HMIRuntime.ActiveProject.Name & vbNewLine
HMIRuntime.Trace "Path: " & HMIRuntime.ActiveProject.Path & vbNewLine
Consulte también
Name (Página 1749)
Path (Página 1773)
Descripción
+0,5XQWLPH
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
Utilización
El objeto "Screen" se utiliza para las acciones siguientes, p. ej.:
● Propiedades "Width" y "Height"
Leer el ancho y la altura de una imagen
● Propiedad "BackColor"
Modificar el color de fondo
Utilice el nombre del objeto en calidad de índice.
Ejemplo
En el ejemplo siguiente, el color de fondo se cambia de negro a verde:
'VBS_Example_BackColor
HMIRuntime.Screens("Rootscreen").BackColor = vbGreen
Objeto "Parent"
Ventana de imagen en la que está incrustado el objeto "Screen".
Si el objeto "Screen" es la imagen raíz, el objeto "Parent" no está definido y está puesto a
cero.
Nota
Al cambiar de imagen, dejan de ser válidas todas las referencias abiertas a la imagen que ya
no existe. Por tanto, no podrá seguir utilizando dichas referencias.
Ejemplo
En el ejemplo siguiente se incrementa el ancho de la primera imagen de runtime en 20 píxeles:
'VBS7
Dim objScreen
Set objScreen = HMIRuntime.Screens(1)
MsgBox "Screen width before changing: " & objScreen.Width
objScreen.Width = objScreen.Width + 20
MsgBox "Screen width after changing: " & objScreen.Width
HMIRuntime.BaseScreenName = "Screenname"
' WINCC:SCREENNAME_SECTION_START
Const ScreenNameInAction = "ScreenName"
' WINCC:SCREENNAME_SECTION_END
Esta sección puede insertarse tantas veces como sea necesario en las acciones VBS.
Consulte también
Refresh (Página 2240)
Activate (Página 2155)
ObjectSizeDeclutteringEnable (Página 1755)
ObjectSizeDeclutteringMax (Página 1756)
ObjectSizeDeclutteringMin (Página 1757)
LayerDeclutteringEnable (Página 1709)
Layers (Página 1710)
DataSet (Página 1635)
ExtendedZoomingEnable (Página 1655)
AccessPath (Página 1546)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Utilización
En función de determinados eventos, el objeto "ScreenItem" sirve para acceder a las
propiedades de los objetos gráficos contenidos en una imagen.
El objeto "ScreenItem" se utiliza del siguiente modo, p. ej.:
● Propiedad "Visible"
Activar o desactivar la visibilidad de un objeto
● Propiedades "Height" y "Width"
Averiguar el ancho y la altura de un objeto
● Propiedades "Top" y "Left"
Modificar la posición de un objeto
● Propiedad "ObjectName"
Leer el nombre de un objeto gráfico
● Propiedad "Parent"
Crear una referencia con la imagen de orden superior
Utilice la propiedad "ScreenItems" para retornar un objeto de la imagen. Utilice el nombre del
objeto en calidad de índice.
Ejemplo
En el ejemplo siguiente, el color de fondo del círculo "myCircle" de la imagen "RootScreen"
se ajusta a "verde".
'VBS_Example_ScreenItems
Dim objCircle
Set objCircle = HMIRuntime.Screens("RootScreen").ScreenItems("myCircle")
objCircle.BackColor = vbGreen
Nota
Para ahorrar espacio de memoria en el panel de operador, al cargar el proyecto no se
transfieren nombres de objetos. No obstante, si desea transferir también los nombres, abra
en WinCC la configuración de runtime para el panel de operador en cuestión. En "General"
podrá modificar los ajustes deseados. Los nombres de los objetos se necesitan si desea
acceder a ellos a través de su nombre, o bien para depurar un proyecto.
Consulte también
Activate (Página 2155)
Layer (Página 1706)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Esta lista contiene los objetos "ScreenItem", es decir, todos los objetos de imagen que
conforman la imagen indicada. La lista tiene una propiedad "Parent". Esta propiedad "Parent"
sirve para indicar la imagen en la que se encuentra el objeto de imagen.
Utilización
La lista "ScreenItems" se utiliza del siguiente modo:
● Indicar o editar todos los objetos contenidos en la lista (es decir, todos los objetos de una
imagen)
● Propiedad "Count"
Contar los objetos de una imagen
● Método "Item"
Editar un objeto determinado de la lista
Utilice la propiedad "ScreenItems" para retornar un objeto de la imagen. Utilice el nombre del
objeto en calidad de índice.
Ejemplo
En el ejemplo siguiente, el color de fondo del círculo "myCircle" de la imagen "RootScreen"
se ajusta a "verde".
Dim objCircle
Set objCircle = HMIRuntime.Screens("RootScreen").ScreenItems("myCircle")
objCircle.BackColor = vbGreen
'Control1 is a WinCC-Control
'VBS197
Dim Control
Set Control=ScreenItems("Control1")
Control.type
Ejemplo
En el ejemplo siguiente se visualizan en un cuadro los nombres de los objetos incluidos en la
imagen actual:
Consulte también
Item (Página 2222)
Descripción
+0,5XQWLPH
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
Gracias a la técnica de ventanas de imagen, en WinCC Runtime puede haber varias imágenes
abiertas al mismo tiempo, aunque sólo exista una imagen raíz. La lista "Screens" permite
acceder a todas las imágenes abiertas en runtime por medio de su nombre. La lista "Screens"
también contiene todas las imágenes invisibles.
La clave de acceso necesaria en el entorno VBS para la instrucción
HMIRuntime.Screens(<clave de acceso>) debe cumplir la siguiente descripción de sintaxis:
Ejemplos
Las imágenes se direccionan indicando la jerarquía dentro de la lista. Es posible direccionar
las imágenes utilizando su nombre o sin utilizarlo. En los ejemplos siguientes se ha
configurado una imagen raíz "BaseScreenName" con una ventana de imagen
"ScreenWindow". La ventana de imagen contiene una imagen "ScreenName".
Direccionamiento utilizando el nombre de imagen
'VBS8
Set objScreen = HMIRuntime.Screens("BaseScreenName.ScreenWindow:ScreenName")
'VBS9
Set objScreen = HMIRuntime.Screens("ScreenWindow")
'VBS10
Set objScreen = HMIRuntime.Screens(1)
'VBS11
Set objScreen = HMIRuntime.Screens("")
'VBS12
Set objScreen = HMIRuntime.Screens("BaseScreenName")
Descripción
+0,5XQWLPH
6PDUW7DJV
6PDUW7DJ
Representa el valor de las variables de proceso indicadas. El objeto SmartTag forma parte
de la lista "SmartTags".
Utilización
El objeto SmartTag permite leer y escribir el valor de la variable de proceso indicada. El objeto
SmartTag no retorna una referencia de objeto. Utilice la lista "SmartTags" para retornar el
valor de una variable de proceso. Utilice el nombre de la variable en calidad de índice.
Nota
Con el ajuste "SmartTags lee valores del cache", los valores no se leen directamente del
controlador, sino de la memoria imagen de proceso (cache).
El objeto SmartTag también puede leer valores directamente del controlador. Sin embargo,
en tal caso hay que contar con una carga por comunicaciones mucho mayor entre el dispositivo
HMI y el controlador.
Ejemplo
'VBS_Example_SmartTags
'Writes tag value to local tag and returns a user-defined text through the
operating system channel for debug alarms.
Dim strAirPressure
strAirPressure = "Current air pressure: " + CStr(SmartTags("AirPressure"))
HMIRuntime.Trace strAirPressure
Nota
Si desea acceder a una variable que todavía no está creada en el proyecto con la lista
SmartTags, no se devolverá ningún valor. No se realizará ninguna asignación a una variable
que no exista:
Dim intVar
intVar = SmartTags("FillLevel")
"intVar" permanece vacío si la variable "FillLevel" no está creada.
Nota
Si desea retornar el tipo de datos de un objeto SmartTag con la función de VBS "TypeName",
utilice la sintaxis siguiente:
TypeName(SmartTags("FillLevel").value)
Descripción
+0,5XQWLPH
6PDUW7DJV
6PDUW7DJ
Esta lista contiene los objetos "SmartTag" que representan todas las variables en WinCC
Runtime.
Nota
La lista "SmartTags" tiene una funcionalidad limitada. Para acceder a un objeto SmartTag sólo
se puede utilizar el nombre de la variable correspondiente. No es posible acceder a través del
índice ni utilizar la instrucción "For-Each".
Nota
Si desea acceder a una variable que todavía no está creada en el proyecto con la lista
SmartTags, no se devolverá ningún valor. No se realizará ninguna asignación a una variable
que no exista:
Dim intVar
intVar = SmartTags("FillLevel")
"intVar" permanece vacío si la variable "FillLevel" no está creada.
Utilización
Utilice la lista "SmartTags" para retornar un objeto SmartTag. Utilice el nombre de la variable
para crear una referencia con el objeto SmartTag:
'VBS_Example_SmartTags
'Writes tag value to local tag and returns a user-defined text through the
operating system channel for debug alarms.
Dim strAirPressure
strAirPressure = "Current air pressure: " + CStr(SmartTags("AirPressure"))
HMIRuntime.Trace strAirPressure
Dim strAirPressure
strAirPressure = "Current air pressure: " + CStr(AirPressure)
HMIRuntime.Trace strAirPressure
Consulte también
SmartTag (Página 1329)
Descripción
+0,5XQWLPH
7DJV 7DJ6HW
7DJ 7DJ
Un objeto Tag (variable) será retornado por medio del listado "Tags". Por medio del objeto
Tag se puede acceder a todas las propiedades y métodos de una variable.
Al crear un objeto Tag se inicializan todas las propiedades con los siguientes valores:
● Value = VT_EMPTY
● Name = Nombre de variable
● QualityCode = BAD NON-SPECIFIC
● TimeStamp = 0
● LastError = 0
● ErrorDescription = " "
Nota
Un resumen de los QualityCodes posibles encontrará en el sistema de información de
WinCC, bajo la palabra clave "Comunicación" > "Diagnóstico" o "Comunicación" > "Quality
Codes".
Utilización
El objeto "Tag" se utiliza del siguiente modo:
● Propiedades "Name", "QualityCode", "TimeStamp", "LastError" y "ErrorDescription"
Leer información sobre la variable
● Método "Write", propiedad "Value"
Definir un valor de una variable
● Método "Read", propiedad "Value"
Leer un valor de una variable
Ejemplo
El siguiente ejemplo muestra la lectura del valor de una variable "Tag1":
'VBS13
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
objTag.Read()
MsgBox objTag.Value
Ejemplo
El siguiente ejemplo muestra la declaración de una variable VBScript "IngVar":
'VBS14
Dim lngVar
lngVar = 5
MsgBox lngVar
Nota
Los nombres de variables no deben contener caracteres especiales.
Debe prestarse atención a que, al crear una variable, ésta no contenga ningún valor (Value
= VT_EMPTY). Inicialice variables de acuerdo a la declaración con un valor correspondiente.
HMIRuntime.Tags("Tagname")
Ud. puede insertar esta sección cuantas veces desee en las acciones VBS.
Nota
Es posible que los nombres de variables compuestos no sean registrados por CrossReference.
Consulte también
Name (Página 1749)
Value (Página 1968)
ErrorDescription (Página 1648)
LastError (Página 1705)
QualityCode (Página 1780)
TimeStamp (Página 1882)
Descripción
+0,5XQWLPH
7DJV 7DJ6HW
7DJ 7DJ
El listado "Tags" le permite el acceso a variables en WinCC Runtime. Como resultado del
acceso al listado "Tags" se suministra un objeto del tipo "Tag". Por medio del objeto Tag se
puede acceder a todas las propiedades y métodos de una variable.
Nota
"Tags" es un listado con un volumen de funciones limitado. A las variables dentro del listado
no se puede acceder a través del índice, sino únicamente a través del nombre de la variable.
Los métodos estándar get_Count y get_NewEnum no se pueden aplicar en el listado Tags.
Utilización
El acceso a las variables del listado se realiza por medio de:
HMIRuntime.Tags("Tagname")
Por medio del listado Tags se declaran variables (objetos Tag) para un acceso leyendo y un
acceso escribiendo. Para que el acceso de lectura y escritura pueda realizare sin errores,
deben existir las variables HMI correspondientes.
En VB Script se puede acceder a variables HMI directamente a través de su nombre y definir
y leer valores. Pero si usted desea consultar propiedades adicionales de la variable, tal como
el código de calidad o el sello de tiempo, o ejecutar un tratamiento de error, deberá acceder
a la variable siempre a través del listado Tags. A través del objeto Tag devuelto Ud. tiene
acceso a todas las propiedades y métodos de las variables.
Con el método "CreateTagSet" se puede generar un objeto TagSet que posibilita el acceso
simultáneo a varias variables.
Ejemplo
Para crear variables, utilice el nombre de la variable.
'VBS16
Dim objTag
Set objTag = HMIRuntime.Tags("Tagname")
Si se utiliza solo el nombre de la variable, se asignan a la propiedad "TagPrefix" los
valores del contexto actual (de la ventana de imagen actual).
Descripción
El objeto "TagSet" permite el acceso simultáneo a varias variables en una ejecución. El acceso
simultáneo se realiza con mejor rendimiento y menor carga de comunicación que el acceso
individual a las distintas variables.
Utilización
El objeto "TagSet" se utiliza del siguiente modo:
● Método "Add"
Agregar variables a la lista
● Método "Item"
Acceder a los objetos Tag contenidos en la lista y a sus propiedades
● Método "Write"
Escribir todas las variables de la lista
● Método "Read"
Leer todas las variables de la lista
● Método "Remove"
Eliminar variables individuales de la lista
● Método "RemoveAll"
Eliminar todas las variables de la lista
El acceso a las variables del listado se realiza por medio de:
'VBS169
Dim myTags
myTags = HMIRuntime.Tags.CreateTagSet
myTags("Tagname")
Para que el acceso de lectura y escritura a las variables (objetos Tag) de la lista pueda ser
ejecutado sin errores, deberán existir las variables correspondientes en WinCC.
Si se ha presentado un error durante el acceso de lectura o escritura, el método aplicado
retorna un mensaje de error a través de las propiedades "LastError" y "ErrorDescription".
Ejemplo
El siguiente ejemplo muestra cómo se genera un objeto TagSet, cómo se agregan variables
y cómo se escriben valores.
'VBS168
'Build a Reference to the TagSet Object
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
'Add Tags to the Collection
group.Add "Motor1"
group.Add "Motor2"
'Set the Values of the Tags
group("Motor1").Value = 3
group("Motor2").Value = 9
'Write the Values to the DataManager
group.Write
Consulte también
ErrorDescription (Página 1648)
LastError (Página 1705)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Ejemplo
En el siguiente ejemplo se desplazará 10 píxeles hacia la derecha el objeto con el nombre
"Control1":
'VBS54
Dim objControl
Set objControl = ScreenItems("Control1")
objControl.Left = objControl.Left + 10
Abreviatura Validez
Pa Panels
A RT Advanced
P RT Professional
* No visible en el ES
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Si se modifican los ajustes de este objeto con una función definida por el usuario, éstos se
conservarán incluso después de volver a llamar la imagen con este objeto.
Nota
El objeto "Visor de avisos simple" no se puede dinamizar mediante una función definida por
el usuario.
Abreviatura Validez
Pa Panels
A RT Advanced
P RT Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A RT Advanced
P RT Professional
* No visible en el ES
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A RT Advanced
P RT Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A RT Advanced
P RT Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
* No visible en el ES
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
* No visible en el ES
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Campo de fecha y hora". El objeto DateTimeField forma parte de la lista
ScreenItems.
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
* No visible en el ES
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Utilización
En el siguiente ejemplo se desplazará 10 píxeles hacia la derecha el objeto con el nombre
"Control1":
'VBS36
Dim objControl
Set objControl = ScreenItems("Control1")
objControl.Left = objControl.Left + 10
Particularidad
En los controles suministrados por WinCC se devolverá como tipo una identificación especial.
Ella se puede encontrar en el rubro "Identificación de tipo en VBS" en las descripciones
individuales de los controles de WinCC.
public UserControlTestModify()
{
InitializeComponent();
}
private void OnMyEvent(Exception e)
{
if (this.MyEvent!= null)
{
// Place data in Properties before invoking event.
Title = "title";
Description = "description"; ";
this.MyEvent.Invoke();
}
}
El siguiente ejemplo muestra cómo acceder en WinCC a la propiedad específica "Title" del
control de otro fabricante "FControl":
HMIRuntime.Screens("StartScreen").ScreenItems("FControl").Title = "MyForeignControl"
Nota
Como no todos los controles tienen una ProgID independiente de la versión, para consultar
la ProgID independiente de la versión o el UserFriendlyName se debería incluir un tratamiento
de error. Si no se utiliza ningún tratamiento de error se terminará el código inmediatamente
sin resultado en el caso de que no se haya encontrado ninguna ProgID.
'VBS37
Dim objControl
Dim strCurrentVersion
Set objControl = ScreenItems("Control1")
strCurrentVersion = CreateObject("WScript.Shell").RegRead("HKCR\" & objControl.Type &
"\CurVer\")
MsgBox strCurrentVersion
Nota
Para que el ejemplo de arriba funcione se debería insertar en la imagen un control multimedios.
'VBS38
Dim objControl
Dim strFriendlyName
Set objControl = ScreenItems("Control1")
strFriendlyName = CreateObject("WScript.Shell").RegRead("HKCR\" & objControl.Type & "\")
MsgBox strFriendlyName
Nota
Para que el ejemplo de arriba funcione se debería insertar en la imagen un control multimedios.
Si Ud. utiliza un control que no ha sido suministrado por WinCC, puede suceder que las
propiedades traídas por el control tengan el mismo nombre que las propiedades generales
de ScreenItem. En este caso tienen preferencia las propiedades ScreenItem. A través de la
propiedad adicional "object" se puede acceder a las propiedades "ocultas" de un control de
otro fabricante. Si Ud. considera adecuadas las propiedades de un control de otro fabricante,
es decir, p. ej. de la siguiente forma:
Control.object.type
En caso de homonimia se usan las propiedades del objeto ScreenItem si utiliza Ud. la siguiente
forma:
Control.type
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
* No visible en el ES
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Consulte también
BackColor (Página 1572)
Caption (Página 1608)
LoadDataImmediately (Página 1723)
Online (Página 1757)
TimeBase (Página 1866)
ShowRuler (Página 1822)
ApplyProjectSettings (Página 1564)
BorderColor (Página 1589)
BorderWidth (Página 1600)
Closeable (Página 1617)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Indicador (gauge)". El objeto Gauge forma parte de la lista ScreenItems.
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
* No visible en el ES
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Campo E/S gráfico". El objeto GraphicIOField forma parte de la lista
ScreenItems.
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
* No visible en el ES
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Campo E/S". El objeto IOField forma parte de la lista ScreenItems.
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Cuadro de lista". El objeto Listbox forma parte de la lista ScreenItems.
Utilización
En el siguiente ejemplo, el objeto denominado "ListBox1" se desplazará 10 píxeles hacia la
derecha:
'VBS21
Dim objListBox
Set objListBox = ScreenItems("ListBox1")
objListBox.Left = objListBox.Left + 10
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Utilización
En el siguiente ejemplo se desplazará 16 píxeles hacia la derecha el objeto con el nombre
"Control1":
'VBS60
Dim objControl
Set objControl = ScreenItems("Control1")
objControl.Left = objControl.Left + 16
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Utilización
En el siguiente ejemplo se desplazará 10 píxeles hacia la derecha el objeto con el nombre
"MultiLineEdit1":
'VBS21
Dim objMultiLineEdit
Set objMultiLineEdit = ScreenItems("MultiLineEdit1")
objMultiLineEdit.Left = objMultiLineEdit.Left + 10
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
* No visible en el ES
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
* No visible en ES
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Nombre del proyecto". El objeto ProjectName forma parte de la lista
ScreenItems.
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQ
6FUHHQV,WHPV
6FUHHQ,WHP
Representa el objeto "Rango efectivo Nombre (RFID)". El objeto ProtectedAreaName es un
elemento de la lista ScreenItems.
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQ
6FUHHQV,WHPV
6FUHHQ,WHP
Representa el objeto "Rango efectivo Nombre". El objeto RangeLabelView es un elemento de
la lista ScreenItems.
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQ
6FUHHQV,WHPV
6FUHHQ,WHP
Representa el objeto "Rango efectivo Señal". El objeto RangeQualityView es un elemento de
la lista ScreenItems.
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Nota
El objeto "Visor de recetas simple" no se puede dinamizar mediante un script de usuario.
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
* No visible en el ES
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
* No visible en el ES
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
* No visible en el ES
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Consulte también
ObjectName (Página 2035)
Font (Página 1669)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
* No visible en el ES
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
* No visible en el ES
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
* No visible en el ES
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Campo E/S simbólico". El objeto SymbolicIOField forma parte de la lista
ScreenItems.
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Consulte también
Name (Página 1749)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Consulte también
Name (Página 1749)
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Representa el objeto "Campo de texto". El objeto TextField forma parte de la lista ScreenItems.
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
* No visible en el ES
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Ejemplo
En el siguiente ejemplo se desplazará 16 píxeles hacia la derecha el objeto con el nombre
"Control1":
'VBS60
Dim objControl
Set objControl = ScreenItems("Control1")
objControl.Left = objControl.Left + 16
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
* No visible en el ES
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
* No visible en el ES
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Utilización
En el siguiente ejemplo, el objeto denominado "TubeArcObject1" se desplazará 10 píxeles
hacia la derecha:
'VBS24
Dim objTubeArcObject
Set objTubeArcObject = ScreenItems("TubeArcObject1")
objTubeArcObject.Left = objTubeArcObject.Left + 10
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Utilización
En el siguiente ejemplo, el objeto denominado "TubeDoubleTeeObject1" se desplazará 10
píxeles hacia la derecha:
'VBS21
Dim objTubeDoubleTeeObject
Set objTubeDoubleTeeObject = ScreenItems("TubeDoubleTeeObject1")
objTubeDoubleTeeObject.Left = objTubeDoubleTeeObject.Left + 10
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Utilización
En el siguiente ejemplo, el objeto denominado "TubePolyline1" se desplazará 10 píxeles hacia
la derecha:
'VBS24
Dim objTubePolyline
Set objTubePolyline = ScreenItems("TubePolyline1")
objTubePolyline.Left = objTubePolyline.Left + 10
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Utilización
En el siguiente ejemplo se desplazará 10 píxeles hacia la derecha el objeto con el nombre
"TubeTeeObject1":
'VBS21
Dim objTubeTeeObject
Set objTubeTeeObject = ScreenItems("TubeTeeObject1")
objTubeTeeObject.Left = objTubeTeeObject.Left + 10
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
* No visible en el ES
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Nota
El objeto "Visor de usuarios simple" no se puede dinamizar mediante un script de usuario.
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
* No visible en ES.
Descripción
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQ
6FUHHQV,WHPV
6FUHHQ,WHP
Representa el objeto "WLAN Recepción". El objeto WLanQualityView es un elemento de la
lista ScreenItems.
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQ
6FUHHQV,WHPV
6FUHHQ,WHP
Representa el objeto "Zona Nombre". El objeto ZoneLabelView es un elemento de la lista
ScreenItems.
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
6FUHHQ
6FUHHQV,WHPV
6FUHHQ,WHP
Representa el objeto "Zona Señal". El objeto ZoneQualityView es un elemento de la lista
ScreenItems.
Abreviatura Validez
Pa Panels
A Runtime Advanced
P Runtime Professional
Descripción
Define el color del objeto indicado para el caso "Rebase por exceso del límite superior".
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura y escritura
Sintaxis
Object.AboveUpperLimitColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● IOField
Con la siguiente apariencia no se tiene acceso en runtime:
● GraphicIOField
● Switch
● SymbolLibrary
● SymbolicIOField
Color
Opcional. Valor o constante que determina el color del objeto especificado para el caso "Límite
superior rebasado".
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). El color "rojo", por ejemplo, se
representa así: RGB(255, 0, 0). Además, también es posible utilizar las constantes de color
VBScript, tales como vbRed o vbGreen.
Descripción
Define si el campo de entrada se confirma automáticamente al salir de él.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AcceptOnExit[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● IOField
● SymbolicIOField
BOOLEAN
Opcional. TRUE si el campo de entrada se confirma automáticamente al salir de él.
Descripción
Define si se sale automáticamente del campo de entrada con confirmación una vez que se
ha introducido un número determinado de valores.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AcceptOnFull[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● IOField
BOOLEAN
Opcional. TRUE si se sale automáticamente del campo de entrada con confirmación una vez
que se ha introducido un número determinado de valores.
Descripción
Devuelve la ruta de ubicación de una imagen.
Sintaxis
Object.AccessPath
Object
Obligatorio. Uno objeto del tipo "Screen".
Ejemplo
En el siguiente ejemplo se edita la ruta de la imagen "ScreenWindow1":
'VBS67
Dim objScreen
Set objScreen = HMIRuntime.Screens("ScreenWindow1")
MsgBox objScreen.AccessPath
Consulte también
Screen (Página 1320)
Descripción
Devuelve el proyecto indicado.
Acceso en runtime: lectura
Sintaxis
Object.ActiveProject
Object
Se necesita. Objeto del tipo "HMIRuntime".
Consulte también
HMIRuntime (Página 1313)
Project (Página 1319)
Descripción
Devuelve un objeto del tipo "Screen" que representa la imagen resaltada en ese momento.
Nota
Si en un script de usuario se consulta la propiedad "ActiveScreen", es posible que la propiedad
no devuelva un objeto "Screen" válido sino "Nothing", debido p. ej. a un ScreenSaver. Se
visualizará un aviso del sistema.
Sintaxis
Object.ActiveScreen
Object
Obligatorio. Objeto del tipo "HMIRuntime".
Observaciones
La imagen retornada dependerá de si está resaltada la imagen básica o la ventana
permanente.
La propiedad ActiveScreen retornará NOTHING si no hay ninguna imagen resaltada. Éste es
el caso, por ejemplo, cuando está resaltada otra ventana. Con la instrucción "If not [expresión]
Is Nothing" puede consultar si se retornará una imagen:
'VBS_Example_ActiveScreen
Dim objActiveScreen
Set objActiveScreen = HmiRuntime.ActiveScreen
If Not objActiveScreen Is Nothing Then
'found an active screen
HmiRuntime.Trace("There is an active screen." & vbCrLf)
Else
'found NO active screen
HmiRuntime.Trace("There is NO active screen." & vbCrLf)
End If
Descripción
Devuelve un objeto del tipo "Screen" que representa la imagen enfocada actualmente.
Nota
Si en una función se consulta la propiedad "ActiveScreen", es posible que, debido p. ej. a un
ScreenSavers, la propiedad no devuelva un objeto "Screen" válido sino "Nothing", y aparezca
un aviso del sistema.
Sintaxis
Object.ActiveScreen
Object
Obligatorio. Un objeto del tipo "HMIRuntime".
Observaciones
La imagen que se devuelve depende de si está enfocada la imagen raíz o la ventana
permanente.
La propiedad ActiveScreen devuelve NOTHING si no hay ninguna imagen enfocada. Esto
sucede p. ej. cuando está enfocada otra ventana. Con la instrucción "If not [expresión] Is
Nothing" se puede consultar si se devuelve una imagen:
'VBS_Example_ActiveScreen
Dim objActiveScreen
Set objActiveScreen = HmiRuntime.ActiveScreen
If Not objActiveScreen Is Nothing Then
'found an active screen
HmiRuntime.Trace("There is an active screen." & vbCrLf)
Else
'found NO active screen
HmiRuntime.Trace("There is NO active screen." & vbCrLf)
End If
Descripción
Crea una referencia con el objeto de imagen enfocado actualmente.
Solo si la imagen del objeto "Screen" correspondiente está seleccionada en ese momento y
si dispone de un campo de entrada, la propiedad "ActiveScreenItem" del objeto "Screen"
tendrá asignado un objeto "ScreenItem" válido. En los demás casos, si p. ej. está seleccionada
otra imagen de la lista "Screens" o una ventana independiente dentro de WinCC u otra
aplicación, esta propiedad no recibirá ningún valor, es decir, tendrá asignado el valor "Nothing".
Utilización
El objeto "ActiveScreenItem" se utiliza para acceder en runtime a las propiedades del objeto
enfocado actualmente.
Descripción
Crea una referencia con el objeto de imagen resaltado actualmente.
Sólo si la imagen del objeto "Screen" correspondiente está seleccionada en ese momento y
si dispone de un campo de entrada, la propiedad "ActiveScreenItem" del objeto "Screen"
tendrá asignado un objeto "ScreenItem" válido. En los demás casos, si p. ej. está seleccionada
otra imagen de la lista "Screens" o una ventana independiente dentro de WinCC u otra
aplicación, esta propiedad no recibirá ningún valor, es decir, tendrá asignado el valor "Nothing".
Utilización
El objeto "ActiveScreenItem" se utiliza para acceder en runtime a las propiedades del objeto
resaltado actualmente.
Descripción
Determina el número del vértice actual del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ActualPointIndex[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Polygon
● Polyline
● Tubepolyline
Con la siguiente apariencia no se tiene acceso en runtime:
● Line
Int32
Opcional. Valor o constante que determina el número del vértice actual del objeto indicado.
Descripción
Determina la coordenada X del vértice actual en referencia al origen de la imagen. El origen
de la imagen se encuentra en la parte superior izquierda del objeto. Cada vértice se identifica
mediante un índice que se obtiene a partir del número ("PointCount") de vértices existentes.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ActualPointLeft[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Polygon
● Polyline
● Tubepolyline
Con la siguiente apariencia no se tiene acceso en runtime:
● Line
Int32
Opcional. Un valor o una constante que determina la coordenada X del vértice actual en
referencia al origen de la imagen.
Observaciones
Una modificación del valor puede alterar las propiedades "Width" (ancho del objeto) y "Left"
(coordenada X de la posición del objeto).
Descripción
Determina la coordenada Y del vértice actual en referencia al origen de la imagen. El origen
de la imagen se encuentra en la parte superior izquierda del objeto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ActualPointTop[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Polygon
● Polyline
● Tubepolyline
Con la siguiente apariencia no se tiene acceso en runtime:
● Line
Int32
Opcional. Valor o constante que determina la coordenada Y del vértice actual en referencia
al origen de la imagen.
Observaciones
Una modificación del valor puede alterar las propiedades "Height" (altura del objeto) y "Top"
(coordenada Y de la posición del objeto).
Descripción
Determina si el borde del objeto indicado se adapta de manera dinámica al tamaño del texto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AdaptBorder[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Button
● IOField
● OptionGroup
● SymbolicIOField
● TextField
Con la siguiente apariencia no se tiene acceso en runtime:
● Checkbox
BOOLEAN
Opcional. TRUE si el borde del objeto indicado se adapta de manera dinámica al tamaño del
texto.
Descripción
Ningún acceso en runtime.
Descripción
Indica si la imagen representada en una ventana de imagen se adapta o no en runtime al
tamaño de la ventana de imagen.
Acceso en runtime: lectura
Sintaxis
Object.AdaptScreenToWindow[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Screenwindow
BOOLEAN
TRUE si la imagen se adapta al tamaño de la ventana de imagen.
FALSE si la imagen no se adapta al tamaño de la ventana de imagen.
Descripción
Indica si la ventana de imagen se adapta a la imagen representada en ella en runtime.
Acceso en runtime: leer
Sintaxis
Object.AdaptWindowtoScreen[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Screenwindow
BOOLEAN
TRUE si el tamaño de la ventana de imagen se adapta a la imagen.
FALSE si el tamaño de la ventana de imagen no se adapta a la imagen.
Descripción
Determina la dirección web que se abre en el navegador HTML.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Address[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● HTML-Browser
STRING
Opcional. Un valor o una constante que contiene la dirección web.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Define el límite de visualización de espacio de memoria a partir del cual se emite un aviso.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Alarm[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● DiscSpaceView
Int32
Opcional. Valor o constante que define el límite de visualización de espacio de memoria a
partir del cual se emite un aviso.
Descripción
Ningún acceso en runtime.
Descripción
Determina el color que se muestra en las barras en cuanto la memoria ocupada haya
alcanzado el rango de alarma.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AlarmColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● DiscSpaceView
Color
Opcional. Un valor o una constante que determina el color que se muestra en las barras en
cuanto la memoria ocupada haya alcanzado el rango de alarma.
Observaciones
Es posible utilizar la función "RGB" para determinar el color en formato RGB (rojo, verde, azul).
Para ello, indique para cada uno de los tres valores RGB el correspondiente valor decimal
(rango de valores de 0 a 255). Por ejemplo, el color rojo se representa de la manera siguiente:
RGB(255, 0, 0). Además, también pueden utilizarse las constantes de color VBS como vbRed
o vbGreen.
Descripción
Devuelve la AlarmID del objeto Alarm. La AlarmID es unívoca y la otorga el sistema.
AlarmID (readonly)
Consulte también
Alarms (lista) (Página 1305)
Descripción
Ningún acceso en runtime.
Descripción
Devuelve un objeto del tipo "AlarmLogs".
Acceso en runtime: lectura
Sintaxis
Object.AlarmLogs
Object
Obligatorio. Un objeto del tipo "Logging".
Consulte también
Logging (Página 1318)
Descripción
Establece el valor límite inferior con el que se dispara la alarma.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AlarmLowerLimit[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
DOUBLE
Opcional. Un valor o una constante que determina el valor límite inferior con el que se dispara
la alarma.
Observaciones
El tipo de evaluación (porcentual o absoluta) se determina con la propiedad
"AlarmLowerLimitRelative".
La propiedad "AlarmLowerLimitEnable" determina si está activada la vigilancia de este valor
límite.
Descripción
Determina el color de barra para el valor límite "AlarmLowerLimit".
La propiedad "AlarmLowerLimitEnable" debe tener el valor TRUE cuando debe modificarse
el color de barra al alcanzar el valor límite.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AlarmLowerLimitColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
Con la siguiente apariencia no se tiene acceso en runtime:
● Slider
Color
Opcional. Un valor o una constante que determina el color de barra para valor el límite
"AlarmLowerLimit".
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Determina si se vigila el valor límite "AlarmLowerLimit".
Acceso en runtime: lectura y escritura
Sintaxis
Object.AlarmLowerLimitEnabled[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional. TRUE, cuando se vigila el valor límite "AlarmLowerLimit".
Observaciones
Los siguientes valores se determinan por medio de las propiedades "AlarmLowerLimit",
"AlarmLowerLimitColor" y "AlarmLowerLimitRelative":
Valor límite
Representación al alcanzarse el valor límite
Tipo de evaluación
Descripción
Determina si el valor límite inferior con el que se dispara la alarma se evalúa en porcentaje o
de forma absoluta.
Sintaxis
Object.AlarmLowerLimitRelative[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional. TRUE si el valor límite inferior con el que se dispara la alarma se evalúa en
porcentaje.
Descripción
Ningún acceso en runtime.
Descripción
Determina el valor límite superior con el que se dispara la alarma.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AlarmUpperLimit[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
DOUBLE
Opcional. Un valor o una constante que determina el valor límite superior con el que se dispara
la alarma.
Observaciones
El tipo de evaluación (porcentual o absoluta) se determina con la propiedad
"AlarmUpperLimitRelative".
Descripción
Determina el color de barra para el valor límite "AlarmUpperLimit".
La propiedad "AlarmUpperLimitEnable" debe tener el valor TRUE cuando debe modificarse
el color de barra al alcanzar el valor límite.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AlarmUpperLimitColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
Con la siguiente apariencia no se tiene acceso en runtime:
● Slider
Color
Opcional. Un valor o una constante que determina el color de barra para valor el límite
"AlarmUpperLimit".
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Determina si se vigila el valor límite "AlarmUpperLimit".
Acceso en runtime: lectura y escritura
Sintaxis
Object.AlarmUpperLimitEnabled[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional. TRUE, cuando se vigila el valor límite "AlarmUpperLimit".
Observaciones
Los siguientes valores se determinan por medio de las propiedades "AlarmUpperLimit",
"AlarmUpperLimitColor" y "AlarmUpperLimitRelative":
● Valor límite
● Representación al alcanzarse el valor límite
● Tipo de evaluación
Descripción
Determina si el valor límite superior con el que se dispara la alarma se evalúa en porcentaje
o de forma absoluta.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AlarmUpperLimitRelative[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional. TRUE si el valor límite superior con el que se dispara la alarma se evalúa en
porcentaje.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime
Descripción
Determina si el reloj se visualiza en formato analógico.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Analog[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Clock
BOOLEAN
Opcional. TRUE si el reloj se visualiza en formato analógico.
Descripción
Define el ángulo para el final de escala en el objeto "Gauge".
Acceso en runtime: lectura y escritura
Sintaxis
Object.AngleMax[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
DOUBLE
Opcional. Valor o constante que determina el ángulo en grados.
Observaciones
El principio y fin de la gradación de escala se escriben en grados angulares con las
propiedades "AngleMin" y "AngleMax".
El valor de la propiedad AngleMin debe ser siempre menor que el valor de la propiedad
AngleMax. El ángulo de grado cero está en la posición de las 3 en el disco de la escala. Los
valores positivos se cuentan en el sentido de las agujas del reloj.
Descripción
Define el ángulo para el principio de escala en el objeto "Gauge".
Acceso en runtime: lectura y escritura
Sintaxis
Object.AngleMin[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
DOUBLE
Opcional. Valor o constante que determina el ángulo en grados.
Observaciones
El principio y fin de la gradación de escala se escriben en grados angulares con las
propiedades "AngleMin" y "AngleMax".
El valor de la propiedad AngleMin debe ser siempre menor que el valor de la propiedad
AngleMax.
El ángulo de grado cero está en la posición de las 3 en el disco de la escala. Los valores
positivos se cuentan en el sentido de las agujas del reloj.
Descripción
Ningún acceso en runtime.
Descripción
Define si se aplica la configuración del proyecto desde el editor "Avisos HMI".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ApplyProjectSettings[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
BOOLEAN
TRUE: los bloques de aviso configurados en el editor "Avisos HMI" se aplican con sus
propiedades en el visor de avisos. Los bloques de aviso se muestran con estas propiedades
en el visor de avisos.
FALSE: no se aplican las propiedades.
Descripción
Ningún acceso en runtime.
Descripción
Determina si el motivo para la operación de este objeto se registra en un informe. Al operar
el objeto indicado en runtime se abre un cuadro de diálogo en el cual el operador introduce
como texto el motivo de la operación.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AskOperationMotive[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● ComboBox
● IOField
● ListBox
● SymbolicIOField
● WindowsSlider
BOOLEAN
Opcional. TRUE si el motivo para la operación de este objeto se registra en un informe.
Descripción
Establece un listado que contiene las asignaciones entre el valor de salida y el texto de salida
que realmente será mostrado. Las asignaciones dependen del tipo de lista ajustado. El tipo
de lista se define con la propiedad ListType.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Assignments[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● SymbolicIOField
STRING
Opcional. Establece un listado que contiene las asignaciones entre el valor de salida y el texto
de salida que realmente será mostrado.
Descripción
Ningún acceso en runtime.
Descripción
Determina los derechos de manejo del objeto indicado en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Authorization[=HMIRTAuthorization]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● ComboBox
● DateTimeField
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon
● Polyline
● RecipeView
● Rectangle
● RoundButton
● Slider
● StatusForce
● Switch
● SymbolLibrary
● SymbolicIOField
● SysDiagControl
● TextField
● TrendView
● TubeArcObject
● TubeDoubleTeeObject
● TubeTeeObject
● Tubepolyline
● UserView
● WindowsSlider
Con la siguiente apariencia no se tiene acceso en runtime:
● AlarmView
● PLCCodeViewer
● ProtectedAreaNameView
● RangeLabelView
● S7GraphOverview
HMIRTAuthorization
Opcional. Valor o constante que determina los derechos de manejo del objeto indicado en
runtime.
Descripción
Determina si se mostrarán las columnas vacías si Control es más ancho que las columnas
configuradas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AutoCompleteColumns[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: se muestran las columnas vacías.
FALSE: no se muestran las columnas vacías.
Descripción
Determina si se mostrarán las filas vacías si Control es más largo que el número de filas
configuradas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AutoCompleteRows[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: se muestran las filas vacías.
FALSE: no se muestran las filas vacías.
Descripción
Determina cómo se comporta la ventana de avisos al aparecer nuevos avisos.
La selección específica de líneas de avisos solo es posible cuando "AutoScroll" no está
activado.
La propiedad "AutoScroll" se desactiva cuando se fija el atributo "MsgCtrlFlag" = "-1". El aviso
más actual se muestra arriba en la ventana de avisos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AutoScroll[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
BOOLEAN
Opcional.
TRUE: un nuevo aviso se añade a la lista mostrada en la ventana de avisos y se selecciona.
El área visible de la ventana de avisos se desplaza en caso necesario.
FALSE: no se selecciona un nuevo aviso. El área visible de la ventana de avisos no se modifica.
Descripción
Define si el color de selección para celda y fila se realizará con los colores preestablecidos
por el sistema.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AutoSelectionColors[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: se utiliza el color de sistema.
FALSE: se utiliza el color definido por el usuario.
Descripción
Define si el borde de selección se coloreará con el color definido por el sistema.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AutoSelectionRectColors[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: se utiliza el color de sistema.
FALSE: se utiliza el color definido por el usuario.
Descripción
Ningún acceso en runtime.
Descripción
Define si se obtendrá el valor medio de los 15 últimos valores.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AverageLast15Values[=BOOLEAN]
Object
Necesario. Objeto del tipo "ScreenItem" con la apariencia "Bar".
BOOLEAN
Opcional. TRUE si se obtiene el valor medio de los 15 últimos valores.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Determina el color de fondo del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.BackColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmControl
● AlarmView
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● ComboBox
● DateTimeField
● Ellipse
● EllipseSegment
● EllipticalArc
● FunctionTrendControl
● Gauge
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit
● OnlineTableControl
● OnlineTrendControl
● OptionGroup
● Polygon
● Polyline
● RecipeView
● Rectangle
● RoundButton
● Slider
● StatusForce
● Switch
● SymbolLibrary
● SymbolicIOField
● TextField
● TrendRulerControl
● TrendView
● TubeArcObject
● UserArchiveControl
● UserView
● WindowsSlider
Con la siguiente apariencia no se tiene acceso en runtime:
● GraphicIOField
Color
Opcional. Valor o constante que determina el color de fondo.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los tres valores RGB el valor
decimal correspondiente (rango de valores de 0 a 255). Por ejemplo, el color rojo se representa
de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las constantes
de color VBS, tales como vbRed o vbGreen.
El color de fondo no es visible si la propiedad "BorderStyle" tiene el valor "0".
Descripción
Determina el color de la parte inferior/derecha del objeto Slider.
Acceso en runtime: lectura y escritura
Sintaxis
Object.BackColorBottom[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● WindowsSlider
Color
Opcional. Un valor o una constante que determina el color de la parte inferior/derecha del
objeto Slider.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina el color de la parte superior/izquierda del objeto Slider.
Acceso en runtime: lectura y escritura
Sintaxis
Object.BackColorTop[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● WindowsSlider
Color
Opcional. Un valor o una constante que determina el color de la parte superior/izquierda del
objeto Slider.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Define el patrón de relleno del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.BackFillStyle[=FillStyle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● Clock
● ComboBox
● Ellipse
● EllipseSegment
● Gauge
● GraphicView
● IOField
● ListBox
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● Slider
● SymbolLibrary
● SymbolicIOField
● TextField
● WindowsSlider
Con la siguiente apariencia no se tiene acceso en runtime:
● DateTimeField
● GraphicIOField
● Switch
FillStyle
Opcional. Valor o constante que determina el patrón de relleno.
hmiFillStyleTransparent (65536): relleno transparente
hmiFillStyleSolid (0): el objeto se rellena con el color indicado
Ajuste estándar: hmiFillStyleSolid
Descripción
Determina el color del fondo para el estado de parpadeo "Off".
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura y escritura
Sintaxis
Object.BackFlashingColorOff[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
● Button
● GraphicView
● IOField
● OptionGroup
● RoundButton
● SymbolicIOField
● TextField
● WindowsSlider
Con la siguiente apariencia no se tiene acceso en runtime:
● CheckBox
● Switch
Color
Opcional. Un valor o una constante que determina el color del fondo para el estado de
parpadeo "Off".
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Determina el color del fondo para el estado de parpadeo "On".
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura y escritura
Sintaxis
Object.BackFlashingColorOn[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
● Button
● GraphicView
● IOField
● OptionGroup
● RoundButton
● SymbolicIOField
● TextField
● WindowsSlider
Con la siguiente apariencia no se tiene acceso en runtime:
● CheckBox
● Switch
Color
Opcional. Un valor o una constante que determina el color del fondo para el estado de
parpadeo "On".
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Determina si el fondo del objeto indicado parpadea en runtime.
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura y escritura
Sintaxis
Object.BackFlashingEnabled[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
● Button
● GraphicView
● IOField
● OptionGroup
● RoundButton
● SymbolicIOField
● TextField
● WindowsSlider
Con la siguiente apariencia no se tiene acceso en runtime:
● CheckBox
● Switch
BOOLEAN
Opcional. TRUE si el fondo del objeto indicado parpadea en runtime.
Descripción
Determina la frecuencia de parpadeo del fondo del objeto indicado.
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura y escritura
Sintaxis
Object.BackFlashingRate[=FlashingRate]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
● Button
● GraphicView
● IOField
● OptionGroup
● RoundButton
● SymbolicIOField
● TextField
● WindowsSlider
Con la siguiente apariencia no se tiene acceso en runtime:
● CheckBox
● Switch
FlashingRate
hmiFlashingRateSlow (0): la longitud del intervalo de parpadeo es de 250 ms.
hmiFlashingRateMedium (1): la longitud del intervalo de parpadeo es de 500 ms.
hmiFlashingRateFast (2): la longitud del intervalo de parpadeo es de 1000 ms.
Descripción
Ningún acceso en runtime.
Descripción
Define el color del fondo de barra en el objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.BarBackColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
● Slider
Color
Opcional. Valor o constante que determina el color del fondo de barra.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Determina el patrón de relleno de la barra.
Sintaxis
Object.BarBackFillStyle[=FillStyle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
FillStyle
hmiFillStyleTransparent ( 65536): patrón de relleno transparente
hmiFillStyleSolid ( 0): patrón de relleno sólido
hmiFillStyleBackwardDiagonal ( 131075): patrón de relleno a rayas diagonales hacia arriba a
la derecha
hmiFillStyleCross ( 131076): patrón de relleno a cuadros
hmiFillStyleDiagonalCross ( 131077): patrón de relleno a cuadros diagonal
hmiFillStyleForwardDiagonal ( 131074): patrón de relleno a rayas diagonales hacia arriba a
la izquierda
hmiFillStyleHorizontal ( 131072): patrón de relleno a rayas horizontales
hmiFillStyleVertical ( 131073): patrón de relleno a rayas verticales
hmiFillStylePattern1 ( 196608): patrón de relleno predefinido
hmiFillStylePattern2 ( 196609): patrón de relleno predefinido
hmiFillStylePattern3 ( 196610): patrón de relleno predefinido
hmiFillStylePattern4 ( 196611): patrón de relleno predefinido
hmiFillStylePattern5 ( 196612): patrón de relleno predefinido
hmiFillStylePattern6 ( 196613): patrón de relleno predefinido
hmiFillStylePattern7 ( 196614): patrón de relleno predefinido
hmiFillStylePattern8 ( 196615): patrón de relleno predefinido
hmiFillStylePattern9 ( 196616): patrón de relleno predefinido
hmiFillStylePattern10 ( 196617): patrón de relleno predefinido
hmiFillStylePattern11 ( 196618): patrón de relleno predefinido
hmiFillStylePattern12 ( 196619): patrón de relleno predefinido
hmiFillStylePattern13 ( 196620): patrón de relleno predefinido
hmiFillStylePattern14 ( 196621): patrón de relleno predefinido
hmiFillStylePattern15 ( 196622): patrón de relleno predefinido
hmiFillStylePattern16 ( 196623): patrón de relleno predefinido
hmiFillStylePattern17 ( 196624): patrón de relleno predefinido
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Define el color de la barra en el objeto "Slider".
Acceso en runtime: lectura y escritura
Sintaxis
Object.BarColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Slider
Color
Opcional. Valor o constante que determina el color del regulador.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
El rango va desde "RangeMin" hasta la posición del regulador.
Descripción
Ningún acceso en runtime.
Descripción
Lee el nombre de la imagen raíz actual o da lugar a un cambio de imagen raíz definiendo un
nuevo nombre de imagen.
Acceso en runtime: lectura y escritura
Sintaxis
Object.BaseScreenName[= STRING]
Object
Obligatorio. Objeto del tipo "HMIRuntime".
STRING
Opcional. Valor o constante que contiene el nombre de la imagen.
Observaciones
También es posible utilizar la propiedad para determinar la imagen que se está visualizando.
Descripción
Ningún acceso en runtime.
Descripción
Determina el bit cuyo estado debe modificarse para desencadenar un cambio de valor.
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura y escritura
Sintaxis
Object.BitNumber[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● SymbolicIOField
Int32
Opcional. Un valor o una constante que determina el bit cuyo estado debe modificarse para
desencadenar un cambio de valor.
Observaciones
La variable utilizada debe ser del tipo BYTE, WORD o DWORD.
Descripción
Define el color con el que parpadea el objeto "SymbolLibrary".
Acceso en runtime: lectura y escritura
Sintaxis
Object.BlinkColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● SymbolLibrary
Color
Opcional. Valor o constante que determina el color de parpadeo.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Determina el tipo de gráfico intermitente para el objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.BlinkMode[=SymbolLibraryBlinkMode]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● SymbolLibrary
SymbolLibraryBlinkMode
hmiSymbolLibraryFlashingNone ( 0): el parpadeo está desactivado.
hmiSymbolLibraryFlashingInvisible ( 1): el gráfico intermitente es invisible.
hmiSymbolLibraryFlashingShaded ( 2): el gráfico intermitente recibe una superficie a color,
sombreada. El color de la superficie se corresponde con el ajuste de la propiedad "BlinkColor".
hmiSymbolLibraryFlashingSolid ( 3): el gráfico intermitente recibe una superficie a color, no
sombreada. El color de la superficie se corresponde con el ajuste de la propiedad "BlinkColor".
Descripción
Determina la frecuencia de parpadeo.
Fast - 250: la longitud del intervalo de parpadeo es de 250 ms. Medium - 500: la longitud del
intervalo de parpadeo es de 500 ms.
Slow - 1000: la longitud del intervalo de parpadeo es de 1000 ms. El valor estándar es Medium
- 500.
Acceso en runtime: lectura y escritura
Sintaxis
Object.BlinkSpeed[=FlashingRate]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● SymbolLibrary
FlashingRate
hmiFlashingRateSlow ( 0): la longitud del intervalo de parpadeo es de 250 ms.
hmiFlashingRateMedium ( 1): la longitud del intervalo de parpadeo es de 500 ms.
hmiFlashingRateFast ( 2): la longitud del intervalo de parpadeo es de 1000 ms.
Descripción
Ningún acceso en runtime.
Descripción
Define el color de fondo de la línea de borde quebrada del objeto indicado.
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura y escritura
Sintaxis
Object.BorderBackColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● ComboBox
● Ellipse
● EllipseSegment
● GraphicIOField
● GraphicView
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowsSlider
Con la siguiente apariencia no se tiene acceso en runtime:
● AlarmView
● Clock
● DateTimeField
● Gauge
● RecipeView
● Slider
● StatusForce
● Switch
● SysDiagControl
● TrendView
● UserView
Color
Opcional. Valor o constante que determina el color de fondo de la línea de borde quebrada
del objeto indicado.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina el color de las siguientes partes del borde para la representación en 3D del objeto
indicado:
● Partes externas superiores e inferiores del borde
● Partes internas inferiores y derechas del borde
Acceso en runtime: lectura y escritura
Sintaxis
Object.BorderBrightColor3D[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Button
● RoundButton
● Slider
Con la siguiente apariencia no se tiene acceso en runtime:
● Switch
Color
Opcional. Un valor o una constante que determina el color del borde. La configuración estándar
es blanco.
Observaciones
Es posible utilizar la función "RGB" para determinar el color en formato RGB (rojo, verde, azul).
Para ello, indique para cada uno de los tres valores RGB el correspondiente valor decimal
(rango de valores de 0 a 255). El color "rojo", por ejemplo, se representa así: RGB(255, 0, 0).
Además, también pueden utilizarse las constantes de color VBS como vbRed o vbGreen.
Descripción
Determina el color de línea del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.BorderColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmControl
● AlarmView
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● ComboBox
● DateTimeField
● Ellipse
● EllipseSegment
● FunctionTrendControl
● GraphicIOField
● GraphicView
● IOField
● ListBox
● MultiLineEdit
● OnlineTableControl
● OnlineTrendControl
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● TrendRulerControl
● UserArchiveControl
● WindowsSlider
Con la siguiente apariencia no se tiene acceso en runtime:
● Clock
● Gauge
● RecipeView
● Slider
● StatusForce
● Switch
● SysDiagControl
● TrendView
● UserView
Color
Opcional. Valor o constante que determina el color de línea.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los tres valores RGB el valor
decimal correspondiente (rango de valores de 0 a 255). Por ejemplo, el color rojo se representa
de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las constantes
de color VBS, tales como vbRed o vbGreen.
Descripción
Devuelve si la ventana se representa con borde en runtime.
Acceso en runtime: lectura
Sintaxis
Object.BorderEnabled[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● ApplicationWindow
● Screenwindow
BOOLEAN
Opcional. TRUE si la ventana se muestra con borde en runtime.
Descripción
Determina el tipo de finales de línea del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.BorderEndStyle[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Line
● Polyline
Int32
Opcional. Un valor o una constante que determina el tipo de finales de línea del objeto indicado.
Descripción
Determina el color de la línea de borde del objeto indicado para el estado de parpadeo "Off".
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura y escritura
Sintaxis
Object.BorderFlashingColorOff[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
● Button
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicIOField
● GraphicView
● IOField
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowsSlider
Con la siguiente apariencia no se tiene acceso en runtime:
● CheckBox
● Switch
Color
Opcional. Un valor o una constante que determina el color de la línea de borde del objeto
indicado para el estado de parpadeo "Off".
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina el color de la línea de borde del objeto indicado para el estado de parpadeo "On".
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura y escritura
Sintaxis
Object.BorderFlashingColorOn[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
● Button
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicIOField
● GraphicView
● IOField
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowsSlider
Con la siguiente apariencia no se tiene acceso en runtime:
● CheckBox
● Switch
Color
Opcional. Un valor o una constante que determina el color de la línea de borde del objeto
indicado para el estado de parpadeo "On".
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina si la línea de borde del objeto indicado parpadea en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.BorderFlashingEnabled[=BOOLEAN]
Object
Necesario. Un objeto del tipo "ScreenItem" con las especificaciones "Ellipse", "Circle",
"EllipseSegment", "CircleSegment", "Rectangle", "Polygon", "TextField", "IOField",
"SymbolicIOField", "Button", "Roundbutton", "Switch", "GraphicView", "GraphicIOField", "Bar",
"Checkbox", "OptionGroup" o "WindowSlider".
BOOLEAN
Opcional. TRUE si la línea de borde del objeto parpadea.
Consulte también
Ellipse (Página 1385)
Circle (Página 1369)
EllipseSegment (Página 1388)
CircleSegment (Página 1372)
Descripción
Determina la frecuencia de parpadeo de la línea de borde del objeto indicado.
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura/escritura
Sintaxis
Object.BorderFlashingRate[=FlashingRate]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
● Button
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicIOField
● GraphicView
● IOField
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowsSlider
Con la siguiente apariencia no se tiene acceso en runtime:
● CheckBox
● Switch
FlashingRate
hmiFlashingRateSlow (0): la longitud del intervalo de parpadeo es de 250 ms.
hmiFlashingRateMedium (1): la longitud del intervalo de parpadeo es de 500 ms.
hmiFlashingRateFast (2): la longitud del intervalo de parpadeo es de 1000 ms.
Descripción
Determina la representación de la parte interior del borde del objeto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.BorderInnerStyle3D[=SliderBorder3DStyle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
● Slider
SliderBorder3DStyle
hmiGaugeBorder3DStyleNone (0): no hay ninguna parte interior del borde del objeto.
hmiGaugeBorder3DStyleRecessed (1): el borde del objeto se representa troquelado.
hmiGaugeBorder3DStyleRaised (2): el borde del objeto se representa realzado.
hmiGaugeBorder3DStyleGray (3): el borde del objeto tiene un marco gris uniforme.
hmiGaugeBorder3DStyleColored (4): el borde del objeto tiene un marco de color uniforme. El
color del borde se corresponde con el color del fondo.
Descripción
Define el ancho del borde interior en una representación tridimensional del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.BorderInnerWidth3D[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Slider
Int32
Opcional. Valor o constante que determina el ancho (en píxeles) del borde interior.
Descripción
Determina la representación de la parte exterior del borde del objeto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.BorderOuterStyle3D[=GaugeBorder3DStyle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
● Slider
GaugeBorder3DStyle
hmiGaugeBorder3DStyleNone (0): no hay ninguna parte interior del borde del objeto.
hmiGaugeBorder3DStyleRecessed (1): el borde del objeto se representa troquelado.
hmiGaugeBorder3DStyleRaised (2): el borde del objeto se representa realzado.
hmiGaugeBorder3DStyleGray (3): el borde del objeto tiene un marco gris uniforme.
hmiGaugeBorder3DStyleColored (4): el borde del objeto tiene un marco de color uniforme. El
color del borde se corresponde con el color del fondo.
Descripción
Define el ancho del borde exterior en una representación tridimensional del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.BorderOuterWidth3D[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Slider
Int32
Opcional. Valor o constante que determina el ancho del borde exterior en píxeles.
Descripción
Determina el color de las siguientes partes del borde para la representación en 3D del objeto
indicado:
● Partes internas superiores e inferiores del borde
● Partes externas inferiores y derechas del borde
Acceso en runtime: lectura y escritura
Sintaxis
Object.BorderShadeColor3D[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Button
● RoundButton
● Slider
Con la siguiente apariencia no se tiene acceso en runtime:
● Switch
Color
Opcional. Un valor o una constante que determina el color para el sombreado.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina el tipo de líneas de borde del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.BorderStyle[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
● Button
● CheckBox
● ComboBox
● GraphicIOField
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● SymbolicIOField
● WindowsSlider
Int32
Opcional. Un valor o una constante que determina el tipo de líneas de borde del objeto
indicado.
0 = línea continua
1 = línea rayada
2 = línea punteada
3 = línea de rayas y puntos
4 = línea de raya-punto-punto
Descripción
Determina si el objeto indicado debe tener un borde sombreado tridimensional.
Acceso en runtime:
● RT Advanced: lectura y escritura
● RT Professional: ningún acceso
Sintaxis
Object.BorderStyle3D[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● DateTimeField
● IOField
● Switch
● TextField
Con la siguiente apariencia no se tiene acceso en runtime:
● Bar
● Button
● GraphicIOField
● GraphicView
● SymbolicIOField
BOOLEAN
Opcional. TRUE si el objeto posee un sombreado de borde 3D.
Descripción
Determina el grosor de línea del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.BorderWidth[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmControl
● AlarmView
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● ComboBox
● Ellipse
● EllipseSegment
● FunctionTrendControl
● Gauge
● GraphicIOField
● GraphicView
● IOField
● ListBox
● MultiLineEdit
● OnlineTableControl
● OnlineTrendControl
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● Slider
● SymbolicIOField
● TextField
● TrendRulerControl
● UserArchiveControl
● WindowsSlider
Int32
Opcional. Valor o constante que establece el grosor de la línea en píxeles.
Descripción
Define el ancho del borde interior en una representación tridimensional del objeto indicado.
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura y escritura
Sintaxis
Object.BorderWidth3D[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Button
● Gauge
● RoundButton
Con la siguiente apariencia no se tiene acceso en runtime:
● Bar
● IOField
● Switch
Int32
Opcional. Valor o constante que determina el ancho (en píxeles) del borde interior para la
representación en 3D.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Determina el texto que se muestra en la barra de título del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Caption[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● Slider
● UserArchiveControl
STRING
Opcional. Valor o constante que contiene el texto que se muestra en la barra de título.
Descripción
Determina el color de fondo de la barra de título del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CaptionBackColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● SymbolicIOField
Color
Opcional. Un valor o una constante que determina el color de fondo de la barra de título del
objeto indicado.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina el color del texto que se muestra en la barra de título del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CaptionColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Gauge
● Switch
● SymbolicIOField
Color
Opcional. Un valor o una constante que determina el color del texto.
Observaciones
Es posible utilizar la función "RGB" para determinar el color en formato RGB (rojo, verde, azul).
Para ello, indique para cada uno de los tres valores RGB el correspondiente valor decimal
(rango de valores de 0 a 255). El color "rojo", por ejemplo, se representa así: RGB(255, 0, 0).
Además, también pueden utilizarse las constantes de color VBS como vbRed o vbGreen.
Descripción
Determina el texto que se debe visualizar la barra de título del objeto indicado.
Sintaxis
Object.CaptionText[= STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Gauge
● ScreenWindow
● Switch
STRING
Opcional. Valor o constante que contiene el texto que se muestra en la barra de título.
Descripción
Determina la distancia de la rotulación de instrumentos respecto al borde superior del objeto
indicado. La rotulación de instrumentos solo se puede colocar a lo largo del diámetro vertical
del cuadrante. El valor del atributo hace referencia a la altura del objeto indicado. La altura la
determinan el borde superior del objeto indicado y el borde inferior del texto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CaptionTop[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
DOUBLE
Opcional. Un valor o una constante que determina la distancia de la rotulación de instrumentos
respecto del borde superior del objeto indicado.
Rango de valores de 0 a 1
0: el borde inferior del texto se encuentra sobre la delimitación superior del objeto indicado.
El texto ya no se ve, dado que se encuentra fuera del objeto indicado.
1: el borde inferior del texto se encuentra sobre la delimitación inferior del objeto indicado.
Descripción
Define si el contenido de las celdas se abreviará en caso de que las celdas sean demasiado
estrechas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CellCut[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE si el contenido se abrevia.
Descripción
Establece la distancia inferior que se utilizará en las celdas de la tabla.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CellSpaceBottom[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con las apariencias siguientes:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchivControl
Int32
Opcional. Valor o constante que establece la distancia inferior que se utilizará en las celdas
de la tabla.
Descripción
Establece el sangrado izquierdo que se utilizará en las celdas de la tabla.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CellSpaceLeft[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
Int32
Opcional. Valor o parámetro que determina el sangrado izquierdo dentro de las celdas de la
tabla.
Descripción
Establece el sangrado derecho que se utilizará en las celdas de la tabla.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CellSpaceRight[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con las apariencias siguientes:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
Int32
Opcional. Valor o constante que establece el sangrado derecho que se utilizará en las celdas
de la tabla.
Descripción
Establece la distancia superior que se utilizará en las celdas de la tabla.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CellSpaceTop[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con las apariencias siguientes:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
Int32
Opcional. Valor o constante que establece la distancia superior que se utilizará en las celdas
de la tabla.
Descripción
Define el color del punto central del objeto "Gauge".
Acceso en runtime: lectura y escritura
Sintaxis
Object.CenterColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
Color
Opcional. Valor o constante que determina el color del punto central.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Determina el diámetro del centro de la escala.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CenterSize[=SINGLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
SINGLE
Opcional. Un valor o una constante que determina el diámetro del punto redondo del centro
de la escala.
Rango de valores de 0,03 a 1
1: el diámetro se corresponde con el valor inferior de los atributos de geometría "Width" o
"Height".
Descripción
Determina si el aspecto del puntero del ratón debe permanecer invariable en runtime cuando
se encuentra sobre el símbolo.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ChangeMouseCursor[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● SymbolLibrary
BOOLEAN
Opcional. TRUE si el puntero tiene el aspecto de una flecha, aunque se coloque sobre el
símbolo.
FALSE si el puntero del ratón tiene el aspecto de una flecha en 3D con el símbolo de un rayo
verde. Con ello se señaliza en runtime que el objeto correspondiente puede utilizarse.
Descripción
Determina si los campos se disponen justificados a la derecha.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CheckMarkAlignment[=ContentAlignment]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● OptionGroup
Con la siguiente apariencia no se tiene acceso en runtime:
● CheckBox
ContentAlignment
(0): Los campos se disponen justificados a la izquierda.
(1): Los campos se disponen justificados a la derecha.
Descripción
Determina el número de campos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CheckMarkCount[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● OptionGroup
Int32
Opcional. Un valor o una constante que determina el número de campos. Rango de valores
de 0 a 31
Descripción
Determina si se borra una entrada errónea automáticamente en este objeto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ClearOnError[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● IOField
BOOLEAN
Opcional. TRUE si se borra una entrada errónea automáticamente en este objeto.
Descripción
Determina si se borra la entrada errónea en cuanto se activa el campo E/S.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ClearOnFocus[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● IOField
BOOLEAN
Opcional. TRUE si se borra la entrada errónea en cuanto se activa el campo E/S.
Descripción
Determina si la ventana puede cerrarse en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Closeable[=BOOLEAN]
Object
Necesario. Objeto del tipo "ScreenItem" con la especificación "UserArchiveControl".
BOOLEAN
Opcional. TRUE si la ventana puede cerrarse en runtime.
Consulte también
AlarmControl (Página 1338)
UserArchiveControl (Página 1528)
SystemDiagnoseWindow (Página 1501)
TrendRulerControl (Página 1508)
FunctionTrendControl (Página 1397)
OnlineTableControl (Página 1434)
OnlineTrendControl (Página 1443)
Descripción
Determina el color de línea del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Color[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● CircularArc
● EllipticalArc
● Line
● Polyline
● TubeArcObject
● TubeDoubleTeeObject
● Tubepolyline
● TubeTeeObject
Color
Opcional. Un valor o una constante que determina el color de línea.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina la histéresis en porcentaje respecto al valor de visualización.
La propiedad "ColorChangeHysteresisEnable" debe tener el valor TRUE para que pueda
calcularse la histéresis.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ColorChangeHysteresis[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
DOUBLE
Opcional. Un valor o una constante que determina la histéresis en porcentaje respecto al valor
de visualización.
Descripción
Determina si el objeto se mostrará con histéresis.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ColorChangeHysteresisEnabled[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional. TRUE si el objeto se muestra con histéresis.
Descripción
Determina cómo se alineará la columna seleccionada.
Son posibles los siguientes ajustes:
Descripción
Determina el formato de fecha que se utilizará para la visualización. Mediante la propiedad
"ColumnIndex" se referencia la columna de fecha del visor de recetas. El atributo puede
dinamizarse con el nombre ColumnDateFormat.
Acceso en runtime: escritura
Sintaxis
Object.ColumnDateFormat(=String)
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "UserArchiveControl".
String
Pueden utilizarse los siguientes formatos de fecha:
Valor Explicación
dd.MM.yy día.mes.año, p. ej. 24.12.13.
dd.yyyyd.MM día.mes.año, p. ej. 24.12.2013.
dd/MM/yy día/mes/año, p. ej. 24/12/13
dd/MM/yyyy día/mes/año, p. ej. 24/12/2013.
Consulte también
UserArchiveControl (Página 1528)
Descripción
Determina si se puede modificar el ancho de las columnas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ColumnResize[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: puede modificarse el ancho de las columnas.
FALSE: no puede modificarse el ancho de las columnas.
Descripción
Ningún acceso en runtime.
Descripción
Determina si las barras de desplazamiento de columnas se deben visualizar.
Acceso en runtime: lectura
Sintaxis
Object.ColumnScrollbar[=Scrollbar]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "AlarmControl",
"TrendRulerControl", "OnlineTableControl", "UserArchivControl".
Scrollbar
0 = (no) No se muestran las barras de desplazamiento de columnas.
1 = (en caso necesario) Se mostrarán las barras de desplazamiento de columnas si la
necesidad de espacio del control en el sentido vertical es superior al área de visualización
disponible.
2 = (siempre) Se muestran siempre las barras de desplazamiento de columnas.
Consulte también
UserArchiveControl (Página 1528)
TrendRulerControl (Página 1508)
OnlineTableControl (Página 1434)
AlarmControl (Página 1338)
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Determina qué formato de tiempo se utilizará. Mediante la propiedad "ColumnIndex" se
referencia la columna de tiempo del visor de recetas. El atributo puede dinamizarse con el
nombre ColumnTimeFormat.
Acceso en runtime: escritura
Sintaxis
Object.ColumnTimeFormat(=String)
Object
Necesario. Un objeto del tipo "ScreenItem" con la especificación "UserArchiveControl".
String
Formatos de tiempo disponibles:
Valor Explicación
HH:mm:ss.ms horas:minutos:segundos, por ejemplo 15:35:44.240.
hh:mm:ss tt horas:minutos:segundos AM/PM, por ejemplo 03:35:44 PM.
hh:mm:ss.ms tt horas:minutos:segundos.milisegundos AM/PM, por ejemplo 03:35:44.240 PM.
Descripción
Determina cómo se alinearán los títulos de columnas.
Acceso en runtime: lectura
Sintaxis
Object.ColumnTitleAlignment[=GridColumnHeaderHorizontalAlignment]
Object
Necesario. Objeto del tipo "ScreenItem" con las apariencias "AlarmControl",
"TrendRulerControl", "OnlineTableControl", "UserArchivControl".
GridColumnHeaderHorizontalAlignment
0 = Los títulos de las columnas se justificarán a la izquierda.
1 = Los títulos de las columnas se justificarán centrados.
2 = Los títulos de las columnas se justificarán a la derecha.
3 = Los títulos de columnas se justificarán como el contenido de la columna correspondiente.
Consulte también
AlarmControl (Página 1338)
Descripción
Determina si se debe mostrar el título de las columnas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ColumnTitles[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchivControl
BOOLEAN
TRUE: se mostrará el título de las columnas.
FALSE: no se mostrará el título de las columnas.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Devuelve el nombre del ordenador en el que se habilitó el objeto Alarm.
ComputerName (readonly)
Descripción
Descripción
Ningún acceso en runtime.
Descripción
Determina si se enlazan los visores de curvas configurados. El requisito para ello es que se
hayan configurado varios visores de curvas.
Los visores de curvas enlazados tienen las siguientes características:
● un eje X común;
● una barra de desplazamiento;
● una regla.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ConnectTrendWindows[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
BOOLEAN
TRUE: se conectan todos los visores de curvas configurados.
FALSE: los visores de curvas se muestran separados.
Descripción
Lee o fija el prefijo del servidor del objeto Alarm.
Descripción
Determina si el valor de la propiedad "ProcessValue" se transfiere al soltar el botón del ratón
o justo en el momento de cambiar la posición del deslizador en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ContinousChange[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Slider
BOOLEAN
Opcional. TRUE si el valor de la propiedad "ProcessValue" se transfiere al soltar el botón del
ratón o justo en el momento de cambiar la posición del deslizador en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Determina el tipo de líneas de borde del objeto indicado.
Acceso en runtime: sólo lectura
Sintaxis
Object.CornerStyle[=Int]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● ComboBox
● EllipseSegment
● GraphicIOField
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● Tubepolyline
● WindowsSlider
Con la siguiente apariencia no se tiene acceso en runtime:
● Ellipse
● EllipticalArc
● Switch
● TubeArcObject
Int
Opcional. Un valor o una constante que determina el tipo de líneas de borde del objeto
indicado.
0 = línea continua
1 = línea rayada
2 = línea punteada
3 = línea de rayas y puntos
4 = línea de raya-punto-punto
Descripción
Retorna el número de elementos en la lista indicada.
Acceso en runtime: lectura
Sintaxis
Object.Count
Object
Obligatorio. Objeto del tipo "Collection".
Descripción
Determina el número de segmentos en los que se dividirá la barra por medio de las marcas
grandes de la escala.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CountDivisions[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
Int32
Opcional. Un valor o una constante que determina el número de segmentos en los que se
dividirá la barra por medio de las marcas grandes de la escala.
0-100: el objeto puede dividirse en 100 segmentos como máximo
= 0: el número óptimo de segmentos se determina de manera automática
Consulte también
Bar (Página 1353)
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Determina cuántas líneas contiene la lista de selección. Si el número de textos configurados
es superior a este valor, la lista de selección dispondrá de una barra de desplazamiento
vertical.
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura y escritura
Sintaxis
Object.CountVisibleItems[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● ComboBox
● ListBox
● SymbolicIOField
Con la siguiente apariencia no se tiene acceso en runtime:
● StatusForce
● TrendView
● UserView
Int32
Opcional. Valor o constante que determina cuántas líneas contiene la lista de selección.
Descripción
Devuelve una cadena de caracteres según el uso de la función.
Si la función está incluida en una imagen de la ventana de imagen, CurrentContext devuelve
el nombre simbólico del servidor que proporciona la imagen. Ejemplo:
"WinCCProject_MyComputer::"
Si la función está incluida en la imagen raíz, se devuelve una cadena de caracteres vacía.
Acceso en runtime: lectura
Sintaxis
Object.CurrentContext
Object
Se necesita. Objeto del tipo "HMIRuntime".
Consulte también
HMIRuntime (Página 1313)
Descripción
Determina si el puntero del ratón debe saltar al siguiente campo del orden de tabulación tras
salir del campo.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CursorControl[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● IOField
● SymbolicIOField
BOOLEAN
Opcional. TRUE, si el puntero del ratón salta al siguiente campo del orden de TAB- tras salir
del campo.
Observaciones
Para ello, la propiedad "CursorMode" debe haberse puesto a TRUE.
Descripción
Ningún acceso en runtime.
Descripción
Define el color del rango de peligro en la escala del objeto "Gauge".
La propiedad "DangerRangeVisible" debe tener el valor TRUE para que se visualice el rango
de peligro.
Acceso en runtime: lectura y escritura
Sintaxis
Object.DangerRangeColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
Color
Opcional. Valor o constante que determina el color del rango de peligro.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Determina a partir de qué valor de la escala comienza el rango de peligro del objeto "Gauge".
La propiedad "DangerRangeColor" debe tener el valor TRUE para que se visualice el rango
de peligro.
Acceso en runtime: lectura y escritura
Sintaxis
Object.DangerRangeStart[=SINGLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
SINGLE
Opcional. Valor o constante que determina el valor de la escala para el principio del rango de
peligro.
Observaciones
El rango va desde el valor "Gefahr" hasta el final de la escala.
Descripción
Determina si debe mostrarse el rango de peligro en la escala del objeto "Gauge".
Acceso en runtime: lectura y escritura
Sintaxis
Object.DangerRangeVisible[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
BOOLEAN
Opcional. TRUE si debe mostrarse el rango de peligro en la escala.
Observaciones
El color del rango de peligro se define con la propiedad "DangerRangeColor".
El principio del rango de peligro se define con la propiedad "DangerRangeStart".
Descripción
Devuelve el tipo de datos del objeto IOField.
Acceso en runtime: lectura
Sintaxis
Object.DataFormat[=IOFieldDataFormat]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● IOField
IOFieldDataFormat
Opcional. Valor o constante que devuelve el tipo de datos del objeto IOField.
Margen de valores de 0 hasta 3.
● 0: Binaria
● 1: Decimal
● 2: Cadena
● 3: Hexadecimal
Descripción
Devuelve un objeto del tipo "DataLogs".
Acceso en runtime: lectura
Sintaxis
Object.DataLogs
Object
Obligatorio. Un objeto del tipo "Logging".
Consulte también
Logging (Página 1318)
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Devuelve un objeto del tipo "DataSet".
Acceso en runtime: lectura
Sintaxis
Object.DataSet
Object
Obligatorio. Un objeto del tipo "Screen".
Consulte también
HMIRuntime (Página 1313)
Screen (Página 1320)
Descripción
Define el color de la esfera en el objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.DialColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Clock
● Gauge
Color
Opcional. Valor o constante que determina el color de la esfera.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Determina el tipo de fondo del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.DialFillStyle[=GaugeFillStyle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
GaugeFillStyle
hmiGaugeBackStyleSolid (0): el fondo rectangular de la visualización está rellenado con el
color de borde indicado. El cuadrante está rellenado con el color de fondo indicado.
hmiGaugeBackStyleFrameTransparent (1): el fondo rectangular de Gauge es transparente.
El cuadrante está rellenado con el color de fondo indicado. De este modo es posible
representar una visualización en forma de círculo.
hmiGaugeBackStyleTransparent (2): el fondo rectangular y el cuadrante son transparentes.
Descripción
Determina el diámetro del cuadrante en relación con el valor más pequeño de los atributos
de geometría "Width" y "Height".
Acceso en runtime: lectura y escritura
Sintaxis
Object.DialSize[=SINGLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
SINGLE
Opcional. Un valor o una constante que determina el diámetro del cuadrante en relación con
el valor más pequeño de los atributos de geometría "Width" y "Height".
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Determina si se mostrarán los avisos cuya visualización se ha ocultado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.DisplayOptions[=AlarmDisplayOptions]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmControl
AlarmDisplayOptions
0: Todos los avisos
1: solo avisos visibles
2: solo avisos ocultos
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Define la acción que se realizará cuando se haga doble clic en la fila de avisos en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.DoubleClickAction[=AlarmControlActions]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
AlarmControlActions
Descripción
Determina si la línea de borde del objeto indicado se traza a partir de un grosor de línea
superior a 1 dentro del borde o de forma simétrica respecto al borde.
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura y escritura
Sintaxis
Object.DrawInsideFrame[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
● Button
● Circle
● CircleSegment
● CircularArc
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● GraphicView
● OptionGroup
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowsSlider
Con la siguiente apariencia no se tiene acceso en runtime:
● CheckBox
● Switch
● TubeArcObject
BOOLEAN
Opcional. TRUE si la línea de borde del objeto indicado se traza a partir de un grosor de línea
superior a 1 dentro del borde.
Descripción
Determina la letra de la unidad de disco que debe vigilarse.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Drive[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● DiscSpaceView
STRING
Opcional. Un valor o una constante que determina la letra de la unidad de disco que debe
vigilarse.
Descripción
Establece el estilo de línea del objeto indicado.
Sintaxis
Object.EdgeStyle[=LineStyle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● ComboBox
● Ellipse
● EllipseSegment
● GraphicIOField
● GraphicView
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowsSlider
Con la siguiente apariencia no se tiene acceso en runtime:
● AlarmView
● Clock
● DateTimeField
● Gauge
● RecipeView
● Slider
● StatusForce
● Switch
● SysDiagControl
● TrendView
● UserView
LineStyle
Opcional. Valor o constante que establece el estilo de línea. Rango de valores de -1 a 4.
Los objetos "Ellipse", "Circle", "Rectangle" y "Polygon" admiten los estilos de línea:
● hmiLineStyleSolid (0): línea continua
● hmiLineStyleDash (1): línea discontinua
● hmiLineStyleDot (2): línea de puntos
● hmiLineStyleDashDot (3): línea punto raya
● hmiLineStyleDashDotDot (4): línea punto punto raya
Los objetos "TextField"" y "IOField" solo admiten los estilos de línea:
● hmiLineStyleNone (-1): ninguna línea
● hmiLineStyleSolid (0): línea continua
Configuración estándar: hmiLineStyleSolid
Descripción
Determina si pueden introducirse datos inmediatamente cuando el campo de entrada está
seleccionado con la tecla <Tab>.
Acceso en runtime: lectura y escritura
Sintaxis
Object.EditOnFocus[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● IOField
● SymbolicIOField
BOOLEAN
Opcional. TRUE si pueden introducirse datos inmediatamente cuando el campo de entrada
está seleccionado con la tecla <Tab>.
Descripción
Determina si el objeto indicado se puede manejar en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Enabled[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● AlarmView
● Bar
● Button
● ChannelDiagnose
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Clock
● ComboBox
● DateTimeField
● DiscSpaceView
● Ellipse
● EllipseSegment
● EllipticalArc
● FunctionTrendControl
● Gauge
● GraphicIOField
● GraphicView
● HTML-Browser
● IOField
● Line
● ListBox
● MediaPlayer
● MultiLineEdit
● OnlineTableControl
● OnlineTrendControl
● OptionGroup
● PLCCodeViewer
● Polygon
● Polyline
● RecipeView
● Rectangle
● RoundButton
● S7GraphOverview
● Slider
● SmartClientView
● StatusForce
● Switch
● SymbolicIOField
● SymbolLibrary
● SysDiagControl
● TextField
● TrendRulerControl
● TrendView
● TubeArcObject
● TubeDoubleTeeObject
● Tubepolyline
● TubeTeeObject
● UserArchiveControl
● UserView
● WindowsSlider
BOOLEAN
Opcional. TRUE si el objeto indicado se puede manejar.
Descripción
Determina si se pueden modificar los datos mostrados en runtime.
Sintaxis
Object.EnableEdit[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
● UserArchiveControl
BOOLEAN
TRUE: los datos se pueden modificar en runtime.
FALSE: los datos no se pueden modificar.
Descripción
Ningún acceso en runtime.
Descripción
Determina el ángulo por el cual el punto final del objeto indicado se desvía de la posición cero
(0º).
Acceso en runtime: lectura y escritura
Sintaxis
Object.EndAngle[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● CircleSegment
● CircularArc
● EllipseSegment
● EllipticalArc
● TubeArcObject
Int32
Opcional. Un valor o una constante que determina el ángulo por el cual el punto final del objeto
indicado se desvía de la posición cero (0º).
Descripción
Ningún acceso en runtime.
Descripción
Determina cómo se representa el final de línea del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.EndStyle[=LineEndStyle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Line
● Polyline
LineEndStyle
Opcional. Un valor o una constante que determina el final de línea. Rango de valores de 0 a
6.
hmiLineEndStyleNone (0): la línea no tiene ningún símbolo de fin.
hmiLineEndStyleArrow (1): la línea termina con una punta de flecha.
hmiLineEndStyleFilledArrow (2): la línea termina con una punta de flecha rellenada.
hmiLineEndStyleFilledArrowReversed (3): la línea termina con una punta de flecha invertida.
hmiLineEndStyleLine (4): la línea termina con una línea vertical.
hmiLineEndStyleCircle (5): la línea termina con un círculo.
hmiLineEndStyleFilledCircle (6): la línea termina con un círculo rellenado.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Devuelve una de las siguientes descripciones de error en inglés:
Impresión Descripción
"" Aceptar
"Operation Failed" Error de ejecución
"Variable not found" Error de variable
"Server down" Servidor no disponible
"An error occured for one or several tags" Multi Tag Error (error en una o varias variables)
Para obtener una descripción del error debe ejecutarse primero el método Read.
Nota
Si el error se produce al acceder a través del objeto TagSet, evalúe la propiedad
ErrorDescription para cada variable del objeto TagSet.
Sintaxis
Object.ErrorDescription
Object
Obligatorio. Un objeto del tipo "Tag".
Ejemplo
El siguiente ejemplo muestra la descripción del error para la variable "Tag1":
'VBS72
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
objtag.Read
MsgBox objTag.ErrorDescription
'VBS179
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
group.Add "Motor1"
group.Add "Motor2"
HMIRuntime.Trace "ErrorDescription: " & group.ErrorDescription & vbNewLine
Consulte también
Tag (Página 1332)
TagSet (lista) (Página 1336)
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Determina si el directorio para la exportación de datos se puede modificar en runtime.
Sintaxis
Object.ExportDirectoryChangeable=[BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: el directorio para la exportación de datos se puede modificar en runtime.
FALSE: el directorio para la exportación de datos no se puede modificar en runtime.
Descripción
Determina el directorio en el cual se exportarán los datos runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ExportDirectoryname[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
STRING
Opcional. Valor o constante que determina el directorio.
Descripción
Establece la extensión del archivo de exportación. Hasta el momento solamente es compatible
la extensión "csv".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ExportFileExtension[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
STRING
Opcional. Establece la extensión del archivo de exportación.
Descripción
Determina el nombre del archivo al cual se exportarán los datos de runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ExportFilename[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
STRING
Opcional. Determina el nombre del archivo al cual se exportarán los datos de runtime.
Descripción
Determina si el nombre de archivo del archivo de exportación se puede modificar en runtime.
Sintaxis
Object.ExportFilenameChangeable[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: el nombre del archivo de exportación se puede modificar en runtime.
FALSE: el nombre del archivo de exportación no se puede modificar en runtime.
Descripción
Define la asignación de número de identidad y Export-Provider.
Sintaxis
Object.ExportFormatGuid[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
STRING
Opcional. Valor o constante que define la asignación de número de identidad y Export-
Provider.
Descripción
Determina el formato de archivo para la exportación. Actualmente sólo está disponible el
formato de archivo "csv" para la exportación de datos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ExportFormatName[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
STRING
Opcional. Valor o constante que determina el formato de archivo para la exportación.
Descripción
Establece los parámetros del formato seleccionado mediante el cuadro de diálogo de
propiedades.
Acceso en runtime: lectura y escritura.
Sintaxis
Object.ExportParameters
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
ExportParameters
Opcional. Valor o constante que establece los parámetros del formato seleccionado mediante
el cuadro de diálogo de propiedades.
Descripción
Determina qué datos de runtime del Control se exportarán.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ExportSelection[=ExportRange]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
ExportRange
Descripción
Determina si el cuadro de diálogo para la exportación de datos se mostrará en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ExportShowDialog[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
Opcional. TRUE si el cuadro de diálogo se muestra en runtime.
Descripción
Determina si el operador puede ampliar o reducir la imagen en runtime girando la rueda del
ratón.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ExtendedZoomingEnable[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "Screen".
BOOLEAN
Opcional. TRUE si el operador puede ampliar o reducir la imagen en runtime.
Ejemplo
El siguiente ejemplo muestra cómo se activa el zoom avanzado para la imagen NewPDL1:
'VBS155
Dim objScreen
Set objScreen = HMIRuntime.Screens("NewPDL1")
objScreen.ExtendedZoomingEnable = 1
Consulte también
Screen (Página 1320)
Descripción
Determina que el campo "Longitud de campo de la cadena de caracteres" sea de sólo lectura.
Acceso en runtime: lectura y escritura
Sintaxis
Object.FieldLength[=BOOLEAN]
Object
Necesario. Un objeto del tipo "ScreenItem" con la especificación "IOField".
BOOLEAN
Opcional. TRUE si el campo "Longitud de campo de la cadena de caracteres" es de sólo
lectura.
Consulte también
IOField (Página 1418)
Descripción
Ningún acceso en runtime.
Descripción
Determina el tipo de primer plano para el objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.FillColorMode[=SymbolLibraryColorMode]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● SymbolLibrary
SymbolLibraryColorMode
hmiSymbolLibraryAppearanceOriginal (0): la superficie es gris.
hmiSymbolLibraryAppearanceShaded (1): la representación está sombreada.
hmiSymbolLibraryAppearanceSolid (2): la representación es sólida.
hmiSymbolLibraryAppearanceTransparent (3): la representación es gris.
Descripción
Establece el color del tipo de relleno del objeto indicado.
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura y escritura
Sintaxis
Object.FillPatternColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● ComboBox
● Ellipse
● EllipseSegment
● GraphicView
● IOField
● ListBox
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowsSlider
Con la siguiente apariencia no se tiene acceso en runtime:
● AlarmControl
● DateTimeField
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
Color
Opcional. Valor o constante que establece el color del tipo de relleno del objeto indicado.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Define el patrón de relleno del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.FillStyle[=LineFillStyle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Line
● Polyline
LineFillStyle
Opcional. Valor o constante que determina el patrón de relleno.
hmiLineFillStyleTransparent (0): relleno transparente
hmiLineFillStyleSolid (1): el objeto se rellena con el color indicado
Ajuste estándar: hmiLineFillStyleSolid
Descripción
Determina la alineación dentro del objeto indicado.
Descripción
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Determina el número de índice del punto de conector superior.
Acceso en runtime: lectura y escritura
Sintaxis
Object.FirstConnectedObjectIndex[=Int]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Connector".
Int
Int
Consulte también
Connector (Página 1379)
Descripción
Determina el nombre del objeto que está acoplado al punto de conector superior.
Acceso en runtime: lectura y escritura
Sintaxis
Object.FirstConnectedObjectName[=String]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Connector".
String
String
Consulte también
Connector (Página 1379)
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Determina si al modificar el tamaño del símbolo se mantiene la proporción de página o si es
variable.
Acceso en runtime: lectura y escritura
Sintaxis
Object.FixedAspectRatio[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● SymbolLibrary
BOOLEAN
Opcional. TRUE si al modificar el tamaño del símbolo se mantiene la proporción de página.
Descripción
Determina el color de la línea de borde del objeto indicado para el estado de parpadeo "Off".
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura y escritura
Sintaxis
Object.FlashingColorOff[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Button
● Circle
● CircleSegment
● CircularArc
● Ellipse
● EllipseSegment
● EllipticalArc
● IOField
● Line
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
Con la siguiente apariencia no se tiene acceso en runtime:
● Bar
● CheckBox
● Switch
● TubeArcObject
Color
Opcional. Un valor o una constante que determina el color de la línea de borde del objeto
indicado para el estado de parpadeo "Off".
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina el color de la línea de borde del objeto indicado para el estado de parpadeo "On".
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura y escritura
Sintaxis
Object.FlashingColorOn[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Button
● Circle
● CircleSegment
● CircularArc
● Ellipse
● EllipseSegment
● EllipticalArc
● IOField
● Line
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
Con la siguiente apariencia no se tiene acceso en runtime:
● Bar
● CheckBox
● Switch
● TubeArcObject
Color
Opcional. Un valor o una constante que determina el color de la línea de borde del objeto
indicado para el estado de parpadeo "On".
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina si la línea de borde del objeto indicado parpadea en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.FlashingEnabled[=BOOLEAN]
Object
Necesario. Un objeto del tipo "ScreenItem" con las especificaciones "Line", "Polyline",
"Ellipse", "Circle", "EllipseSegment", "CircleSegment", "EllipticalArc", "CircularArc",
"Rectangle", "Polygon", "TextField", "IOField", "SymbolicIOField", "Button", "Switch",
"GraphicIOField", "Bar", "Checkbox", "OptionGroup" o "Connector".
BOOLEAN
Opcional. TRUE si la línea de borde del objeto parpadea.
Consulte también
Line (Página 1422)
Polyline (Página 1459)
Ellipse (Página 1385)
Circle (Página 1369)
EllipseSegment (Página 1388)
CircleSegment (Página 1372)
EllipticalArc (Página 1390)
CircularArc (Página 1374)
Rectangle (Página 1471)
Descripción
Ningún acceso en runtime.
Descripción
Determina la frecuencia de parpadeo de la línea de borde del objeto indicado.
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura/escritura
Sintaxis
Object.FlashingRate[=FlashingRate]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Button
● Circle
● CircleSegment
● CircularArc
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● IOField
● Line
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
Con la siguiente apariencia no se tiene acceso en runtime:
● Bar
● CheckBox
● Switch
● TubeArcObject
FlashingRate
hmiFlashingRateSlow (0): la longitud del intervalo de parpadeo es de 1000 ms.
hmiFlashingRateMedium (1): la longitud del intervalo de parpadeo es de 500 ms.
hmiFlashingRateFast (2): la longitud del intervalo de parpadeo es de 250 ms.
Descripción
Determina el color del objeto de mapa de bits de una imagen intermitente que se establece
en "transparente".
Acceso en runtime: lectura y escritura
Sintaxis
Object.FlashTransparentColor[=Color]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "GraphicIOField".
Color
Opcional. Un valor o una constante que determina el color del objeto de mapa de bits de una
imagen intermitente que se establece en "transparente".
Consulte también
GraphicIOField (Página 1408)
Descripción
Voltea el símbolo por el eje central vertical y/u horizontal del mismo.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Flip[=SymbolLibraryFlip]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● SymbolLibrary
SymbolLibraryFlip
hmiSymbolLibraryFlipNone (0): el símbolo no se voltea.
hmiSymbolLibraryFlipHorizontal (1): el símbolo se voltea horizontalmente.
hmiSymbolLibraryFlipVertical (2): el símbolo se voltea verticalmente.
hmiSymbolLibraryFlipBoth (3): el símbolo se voltea horizontal y verticalmente.
Descripción
Determina el color para el borde del foco del objeto indicado cuando el objeto posee el foco.
Acceso en runtime: lectura y escritura
Sintaxis
Object.FocusColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmView
● RecipeView
● Slider
● StatusForce
● Switch
● TrendView
Con la siguiente apariencia no se tiene acceso en runtime:
● Button
● GraphicIOField
● SymbolicIOField
Color
Opcional. Valor o constante que determina el color para el borde del foco.
Observaciones
Es posible utilizar la función "RGB" para determinar el color en formato RGB (rojo, verde, azul).
Para ello, indique para cada uno de los tres valores RGB el correspondiente valor decimal
(rango de valores de 0 a 255). El color "rojo", por ejemplo, se representa así: RGB(255, 0, 0).
Además, también pueden utilizarse las constantes de color VBS como vbRed o vbGreen.
Descripción
Determina el ancho del borde del objeto indicado cuando el objeto posee el foco.
Acceso en runtime: lectura y escritura
Sintaxis
Object.FocusWidth[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmView
● RecipeView
● Slider
● StatusForce
● Switch
● TrendView
Con la siguiente apariencia no se tiene acceso en runtime:
● Button
● GraphicIOField
● SymbolicIOField
Int32
Opcional. Un valor o una constante que determina el ancho del borde en píxeles. Rango de
valores de 1 a 10.
Descripción
Define la fuente, o la devuelve.
El objeto Font tiene las subpropiedades
● Size (tamaño de fuente)
● Bold (negrita Sí/No)
● Name (tipo de fuente)
● Italic (cursiva Sí/No)
● Underline (subrayado Sí/No)
● StrikeThrough (tachado Sí/No)
Si se asignan directamente dos propiedades de Font, se aceptará únicamente la propiedad
default "Name".
Acceso en runtime: lectura y escritura
Sintaxis
Object.Font[=Font]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
AlarmControl
Clock
FunctionTrendControl
OnlineTableControl
OnlineTrendControl
Slider
TrendRulerControl
UserArchiveControl
Con la siguiente apariencia no se tiene acceso en runtime:
● Bar
● Button
● CheckBox
● ComboBox
● DateTimeField
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● ProtectedAreaNameView
● RangeLabelView
● RecipeView
● RoundButton
● SmartClientView
● Switch
● SymbolicIOField
● TextField
● TrendView
● ZoneLabelView
Font
Fuente
Ejemplo
'VBS74
Dim objControl1
Dim objControl2
Set objControl1 = ScreenItems("Control1")
Set objControl2 = ScreenItems("Control2")
objControl2.Font = objControl1.Font ' take over only the type of font
Descripción
Determina si el texto del objeto indicado se muestra en negrita.
Acceso en runtime: lectura y escritura
Sintaxis
Object.FontBold[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● TextField
● Bar
● Button
● CheckBox
● ComboBox
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● SymbolicIOField
BOOLEAN
Opcional. TRUE si el texto del objeto indicado se muestra en negrita.
Descripción
Determina si el texto del objeto indicado se muestra en cursiva.
Acceso en runtime: lectura y escritura
Sintaxis
Object.FontItalic[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● TextField
● Button
● CheckBox
● ComboBox
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● SymbolicIOField
BOOLEAN
Opcional. TRUE si el texto del objeto indicado se muestra en cursiva.
Descripción
Establece la fuente del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.FontName[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● TextField
● Bar
● Button
● CheckBox
● ComboBox
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● SymbolicIOField
STRING
Opcional. Valor o constante que establece la fuente del objeto indicado.
Descripción
Establece el tamaño de fuente del texto del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.FontSize[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● TextField
● Bar
● Button
● CheckBox
● ComboBox
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● SymbolicIOField
Int32
Opcional. Valor o constante que establece el tamaño de fuente del texto del objeto indicado.
Descripción
Determina si el texto del objeto indicado se muestra subrayado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.FontUnderline[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● TextField
● Button
● CheckBox
● ComboBox
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● SymbolicIOField
BOOLEAN
Opcional. TRUE si el texto del objeto indicado se muestra subrayado.
Descripción
Establece el color de fuente del texto del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ForeColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
● Button
● CheckBox
● ComboBox
● DateTimeField
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RecipeView
● RoundButton
● Slider
● Switch
● SymbolLibrary
● SymbolicIOField
● TextField
Con la siguiente apariencia no se tiene acceso en runtime:
● AlarmView
Color
Opcional. Valor o constante que establece el color de fuente del texto del objeto indicado.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Ningún acceso en runtime.
Descripción
Determina el formado del valor de salida.
Acceso en runtime: leer
Sintaxis
Object.FormatPattern[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● IOField
STRING
Opcional. Un valor o una constante que determina el formato del valor de salida.
Descripción
Devuelve el tamaño de la memoria libre.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Free[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● DiscSpaceView
DOUBLE
Opcional. Un valor o una constante que devuelve el tamaño de la memoria libre.
Descripción
Devuelve en porcentaje los valores medidos de la memoria libre. Los valores pueden
consultarse en runtime. Los valores no pueden predefinirse.
Acceso en runtime: lectura y escritura
Sintaxis
Object.FreePercent[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● DiscSpaceView
Int32
Opcional. Un valor o una constante que devuelve en porcentaje los valores medidos de la
memoria libre.
Descripción
Define la diferencia de valor entre dos marcas principales del objeto "Gauge".
Acceso en runtime: lectura y escritura
Sintaxis
Object.Gradation[=SINGLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
SINGLE
Opcional. Valor o constante que determina la diferencia de valor.
Descripción
Determina el borde de la ventana de curvas en el que se muestran los valores actuales.
Acceso en runtime: lectura y escritura
Sintaxis
Object.GraphDirection[=GraphDirection]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
GraphDirection
0: Los valores positivos serán desplazados hacia la derecha y hacia arriba.
-1: Los valores positivos serán desplazados hacia la izquierda y hacia arriba.
-2: Los valores positivos serán desplazados hacia la derecha y hacia arriba.
-3: Los valores positivos serán desplazados hacia la derecha y hacia abajo.
Descripción
Establece el color de las líneas de cuadrícula.
Acceso en runtime: lectura y escritura
Sintaxis
Object.GridLineColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● AlarmView
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
Con la siguiente apariencia no se tiene acceso en runtime:
● TrendView
Color
Opcional. Valor o constante que establece el color de las líneas de cuadrícula.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Define en píxeles el grosor de la línea de separación.
Acceso en runtime: lectura y escritura
Sintaxis
Object.GridLineWidth[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
Int32
Opcional. Valor o constante que establece el grosor de la línea de separación.
Descripción
Ningún acceso en runtime.
Descripción
Define la altura del objeto indicado.
Acceso en runtime: lectura y escritura.
Sintaxis
Object.Height[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmControl
● AlarmView
● ApplicationWindow
● Bar
● BatteryView
● Button
● ChannelDiagnose
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Clock
● ComboBox
● DateTimeField
● DiscSpaceView
● Ellipse
● EllipseSegment
● EllipticalArc
● FunctionTrendControl
● Gauge
● GraphicIOField
● GraphicView
● HTML-Browser
● IOField
● Line
● ListBox
● MediaPlayer
● MultiLineEdit
● OnlineTableControl
● OnlineTrendControl
● OptionGroup
● PLCCodeViewer
● Polygon
● Polyline
● ProtectedAreaNameView
● RangeLabelView
● RangeQualityView
● RecipeView
● Rectangle
● RoundButton
● Screenwindow
● Slider
● SmartClientView
● StatusForce
● Switch
● SymbolLibrary
● SymbolicIOField
● SysDiagControl
● TextField
● TrendRulerControl
● TrendView
● TubeArcObject
● TubeDoubleTeeObject
● TubeTeeObject
● Tubepolyline
● UserArchiveControl
● UserView
● WLanQualityView
● WindowsSlider
● ZoneLabelView
● ZoneQualityView
Con la siguiente apariencia no tiene acceso en runtime:
● S7GraphOverview
Int32
Opcional. Valor o constante que determina la altura en píxeles.
Ejemplo
El siguiente ejemplo divide por la mitad la altura de todos los objetos de la imagen "NewPDL1",
cuyo nombre empieza con "Circle":
'VBS75
Dim objScreen
Dim objCircle
Dim lngIndex
Dim strName
lngIndex = 1
Set objScreen = HMIRuntime.Screens("NewPDL1")
For lngIndex = 1 To objScreen.ScreenItems.Count
'
'Searching all circles
strName = objScreen.ScreenItems.Item(lngIndex).ObjectName
If "Circle" = Left(strName, 6) Then
'
'to halve the height of the circles
Set objCircle = objScreen.ScreenItems(strName)
objCircle.Height = objCircle.Height / 2
End If
Next
Consulte también
Line (Página 1422)
Polyline (Página 1459)
Ellipse (Página 1385)
Circle (Página 1369)
EllipseSegment (Página 1388)
CircleSegment (Página 1372)
EllipticalArc (Página 1390)
CircularArc (Página 1374)
Rectangle (Página 1471)
Polygon (Página 1456)
TextField (Página 1505)
IOField (Página 1418)
SymbolicIOField (Página 1491)
Button (Página 1360)
Switch (Página 1488)
GraphicView (Página 1411)
Descripción
Indica el tooltip que se visualiza en runtime como ayuda de manejo del objeto indicado.
Acceso en runtime: lectura
Sintaxis
Object.HelpText[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Button
● DateTimeField
● GraphicIOField
● IOField
● Switch
● SymbolicIOField
● TrendView
STRING
Opcional. Valor o constante que indica el contenido del tooltip que se visualiza en runtime
como ayuda de manejo del objeto indicado.
Descripción
Determina si se muestra el valor al realizar la entrada o bien un * para cada carácter.
Acceso en runtime: lectura y escritura
Sintaxis
Object.HiddenInput[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● IOField
BOOLEAN
Opcional. TRUE si el valor no se muestra al realizar la entrada. Para cada carácter se muestra
un *.
Descripción
Determina el color del botón superior o derecho para desplazarse por una barra de
desplazamiento.
Acceso en runtime: lectura y escritura
Sintaxis
Object.HighLimitColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● WindowsSlider
Color
Opcional. Un valor o una constante que determina el color del botón superior o derecho para
desplazarse por una barra de desplazamiento.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed y vbGreen.
Descripción
Ningún acceso en runtime.
Descripción
Aplica el bloque de aviso seleccionado de la lista de bloques de aviso existentes y lo introduce
en la lista de bloques de aviso seleccionados.
Acceso en runtime: lectura y escritura
Sintaxis
Object.HitlistColumnAdd[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
STRING
Opcional. Aplica el bloque de aviso seleccionado en la lista de bloques de aviso existentes y
lo introduce en la lista de bloques de aviso seleccionados.
Descripción
Especifica el número de bloques de aviso seleccionados que aparecerán en la lista de aciertos
en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.HitlistColumnCount[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
Int32
Opcional. Especifica el número de bloques de aviso seleccionados que aparecerán en la lista
de aciertos en runtime.
Descripción
Hace referencia a uno de los bloques de aviso seleccionados para la lista de aciertos. Mediante
la utilización de este atributo podrá asignar a un bloque de aviso determinado de la lista de
aciertos los valores de otros atributos.
Los valores válidos para "HitlistColumnIndex" se encuentran entre 0 y "HitlistColumnCount"
menos 1. El atributo "HitlistColumnCount" indica el número de bloques de aviso seleccionados
para la lista de aciertos. El atributo "HitlistColumnIndex" se puede dinamizar con el atributo
HitlistColumnRepos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.HitlistColumnIndex[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
Int32
Opcional. Hace referencia a uno de los bloques de aviso seleccionados para la lista de aciertos.
Descripción
Define el nombre del bloque de aviso de la lista de aciertos que ha sido referenciado con el
atributo "HitlistColumnIndex". No se puede modificar el nombre.
Acceso en runtime: lectura y escritura
Sintaxis
Object.HitlistColumnName[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
STRING
Opcional. Define el nombre del bloque de aviso de la lista de aciertos que ha sido referenciado
con el atributo "HitlistColumnIndex".
Descripción
Elimina el bloque de aviso seleccionado de la lista de bloques seleccionados y lo introduce
en la lista de bloques de aviso existentes.
Acceso en runtime: lectura y escritura
Sintaxis
Object.HitlistColumnRemove[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
STRING
Opcional. Elimina el bloque de aviso seleccionado de la lista de bloques seleccionados y lo
introduce en la lista de bloques de aviso existentes.
Descripción
Modifica la secuencia de los bloques de aviso. "Arriba" y "Abajo" desplazan el bloque de aviso
seleccionado en la lista. De esta forma en el runtime se desplazará hacia arriba o abajo el
bloque de aviso en Control.
Acceso en runtime: lectura y escritura
Sintaxis
Object.HitlistColumnRepos[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
Int32
Opcional. Modifica la secuencia de los bloques de aviso.
Descripción
Establece cómo se clasificará en la lista de aciertos el bloque de aviso referenciado en
"HitlistColumnIndex".
Acceso en runtime: lectura y escritura
Sintaxis
Object.HitlistColumnSort[=SortMode]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
SortMode
0: ninguna clasificación.
1: clasificación ascendente desde el valor menor hasta el mayor.
2: clasificación descendente desde el valor mayor hasta el menor.
Descripción
Define la secuencia de clasificación del bloque de aviso de la lista de aciertos referenciado
en "HitlistColumnIndex". Si ajusta el valor a "0", el criterio de clasificación se eliminará de
"HitlistColumnSort".
Acceso en runtime: lectura y escritura
Sintaxis
Object.HitlistColumnSortIndex[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
Int32
Opcional. Define la secuencia de clasificación del bloque de aviso de la lista de aciertos
referenciado en "HitlistColumnIndex". Si ajusta el valor a "0", el criterio de clasificación se
eliminará de "HitlistColumnSort".
Descripción
Establece una lista con los bloques de aviso seleccionados de la lista de aciertos que se
utilizarán en el control en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.HitlistColumnVisible[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
BOOLEAN
Opcional. Establece una lista con los bloques de aviso seleccionados de la lista de aciertos
que se utilizarán en el control en runtime.
Descripción
Define la clasificación determinada en las columnas de la tabla de la lista de aciertos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.HitlistDefaultSort[=SortMode]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
SortMode
0: la lista se clasificará de forma ascendente según la frecuencia.
1: la lista se clasificará de forma descendente según la frecuencia.
Descripción
Establece el número máximo de registros que se utilizan del fichero de avisos para la creación
de la lista de aciertos. El valor puede elegirse libremente entre "0 - 10000".
Acceso en runtime: lectura y escritura
Sintaxis
Object.HitlistMaxSourceItems[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
Int32
Opcional. Valor o constante que establece el número máximo de registros que se utilizan del
fichero de avisos para la creación de la lista de aciertos.
Descripción
Determina si se muestra una advertencia cuando se alcanza el número máximo de registros
especificado en "HitlistMaxSourceItems".
Acceso en runtime: lectura y escritura
Sintaxis
Object.HitlistMaxSourceItemsWarn[=BOOLEAN]
Object
Necesario. Objeto del tipo "ScreenItem" con la especificación "AlarmControl".
BOOLEAN
Opcional. TRUE si se muestra una advertencia cuando se alcanza el número máximo de
registros especificado en "HitlistMaxSourceItems".
Consulte también
AlarmControl (Página 1338)
Descripción
Establece el factor de tiempo que, con el tipo de tiempo "HitlistRelTimeFactorType", determina
el período para el que se crea la estadística de la lista de aciertos.
Si no desea especificar un período, ajuste el factor de tiempo a "0".
Acceso en runtime: lectura y escritura
Sintaxis
Object.HitlistRelTimeFactor[=Long]
Object
Necesario. Objeto del tipo "ScreenItem" con la especificación "AlarmControl".
Long
Opcional. Valor o constante que establece el factor de tiempo.
Consulte también
AlarmControl (Página 1338)
Descripción
Establece el tipo de tiempo que, con el factor de tiempo "HitlistRelTimeFactor", determina el
período para el que se crea la estadística de la lista de aciertos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.HitlistRelTimeFactorType[=AlarmViewAdvancedTimeFactorUnit]
Object
Necesario. Objeto del tipo "ScreenItem" con la especificación "AlarmControl".
AlarmViewAdvancedTimeFactorUnit
hmiAlarmViewAdvancedTimeFactorUnitMinute ( 0): el intervalo de tiempo para la estadística
se mide en minutos.
hmiAlarmViewAdvancedTimeFactorUnitHour ( 1): el intervalo de tiempo para la estadística se
mide en horas.
hmiAlarmViewAdvancedFactorUnitDay ( 2): el intervalo de tiempo para la estadística se mide
en días.
Consulte también
AlarmControl (Página 1338)
Descripción
Determina si se utilizará el intervalo de tiempo para la estadística.
Si no desea especificar un período, ajuste el factor de tiempo a "0".
Acceso en runtime: lectura y escritura
Sintaxis
Object.HitListRelTime [=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
BOOLEAN
TRUE: si no hay ningún intervalo de tiempo en la selección, se utilizará el intervalo de tiempo
indicado para la estadística.
FALSE: no se utilizará el intervalo de tiempo indicado.
Descripción
Determina la orientación horizontal del texto dentro del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.HorizontalAlignment[=HorizontalAlignment]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Button
● CheckBox
● ComboBox
● DateTimeField
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● Switch
● SymbolicIOField
● TextField
HorizontalAlignment
Opcional. Un valor o una constante que determina la orientación horizontal del texto.
hmiAlignmentLeft (0):el texto se justifica a la izquierda en el objeto.
hmiAlignmentCentered (1): el texto se centra horizontalmente en el objeto.
hmiAlignmentRight (2): el texto se justifica a la derecha en el objeto.
Descripción
Determina si se deben visualizar líneas horizontales.
Acceso en runtime: lectura y escritura
Sintaxis
Object.HorizontalGridLines[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: se muestran las líneas horizontales.
FALSE: no se muestran las líneas horizontales.
Descripción
Define el desplazamiento horizontal de la barra de desplazamiento en una ventana de imagen
con barras de desplazamiento.
La imagen se representa en la ventana de imagen con el desplazamiento horizontal o vertical
de las barras de desplazamiento. Si desea representar la imagen recortada en la que las
barras de desplazamiento de la imagen están ubicadas en el borde izquierdo y en el borde
superior de la imagen, utilice las propiedades "OffsetLeft" y "OffsetTop" para el origen de esta
área.
Acceso en runtime: lectura y escritura
Sintaxis
Object.HorizontalScrollBarPosition[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● ScreenWindow
Int32
Opcional. Valor o constante que define el desplazamiento horizontal de la barra de
desplazamiento en una ventana de imagen con barras de desplazamiento.
Descripción
En el objeto Botón retorna la tecla de funciones para el manejo del ratón.
Sólo acceso de lectura.
Consulte también
Button (Página 1360)
Descripción
Define la longitud de la aguja horaria en el objeto "Clock".
Acceso en runtime: lectura y escritura
Sintaxis
Object.HourNeedleHeight[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Clock
Int32
Opcional. Valor o constante que determina la longitud de la aguja horaria.
Indique la longitud de la aguja horaria en tantos por ciento, referidos al radio de la esfera.
Descripción
Define el ancho de la aguja horaria en el objeto "Clock".
Acceso en runtime: lectura y escritura
Sintaxis
Object.HourNeedleWidth[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Clock
Int32
Opcional. Valor o constante que determina el ancho de la aguja horaria.
Indique el ancho en tantos por ciento, referidos a la longitud doble de la aguja horaria.
Descripción
Establece la distancia entre símbolo y texto en las celdas de la tabla. El valor será efectivo
cuando se muestren símbolos y texto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.IconSpace[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
Int32
Opcional. Valor que establece la distancia.
Descripción
Determina el índice del campo de texto seleccionado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Index[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● CheckBox
● ComboBox
● ListBox
● OptionGroup
Int32
Opcional. Un valor o una constante que determina el índice del campo de texto seleccionado.
Descripción
Define el color debajo del deslizador del objeto "Switch" cuando el objeto está en estado OFF.
Acceso en runtime: lectura y escritura
Sintaxis
Object.InnerBackColorOff[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Switch
Color
Opcional. Valor o constante que determina el color del estado OFF.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Define el color debajo del deslizador del objeto "Switch" cuando el objeto está en estado ON.
Acceso en runtime: lectura y escritura
Sintaxis
Object.InnerBackColorOn[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Switch
Color
Opcional. Valor o constante que determina el color del estado ON.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Define el valor introducido por el usuario en el campo E/S. El valor no se muestra en el campo
E/S al activar la propiedad.
Si quiere que el valor introducido aparezca en el campo E/S tras confirmar con la tecla
<Return>, configure una conexión directa entre las propiedades "Valor de entrada" y "Valor
de salida". La conexión directa solo resulta conveniente cuando no se ha configurado ninguna
conexión con una variable en el valor de salida, pero el usuario desea consultar de todos
modos el valor introducido, p. ej., mediante un script.
Acceso en runtime: lectura y escritura
Sintaxis
Object.InputValue[=Object]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● IOField
● SymbolicIOField
Object
Opcional. Valor o constante que establece el valor de entrada.
Descripción
Devuelve una instancia del objeto Alarm.
Descripción
Determina el número de dígitos a la izquierda de la coma (de 0 a 20).
Acceso en runtime: lectura y escritura
Sintaxis
Object.IntegerDigits[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
Int32
Opcional. Un valor o una constante que determina el número de dígitos a la izquierda de la
coma (de 0 a 20).
Descripción
Determina los intervalos de tiempo para la actualización de los valores medidos mostrados.
El valor se indica en minutos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Interval[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● DiscSpaceView
Int32
Opcional. Un valor o una constante que determina los intervalos de tiempo para la
actualización de los valores medidos mostrados.
Descripción
Establece el tipo de las líneas de separación en la lista de selección del objeto indicado.
Sintaxis
Object.ItemBorderStyle[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● SymbolicIOField
Int32
hmiLineStyleNone (-1): la lista de selección no tiene líneas de separación.
hmiLineStyleSolid ( 0): la lista de selección tiene líneas de separación continuas.
hmiLineStyleDash ( 1): la lista de selección tiene líneas de separación discontinuas.
hmiLineStyleDot ( 2): la lista de selección tiene líneas de separación de puntos.
hmiLineStyleDashDot ( 3): la lista de selección tiene líneas de separación punto raya.
hmiLineStyleDashDotDot ( 4): la lista de selección tiene líneas de separación punto punto raya.
Descripción
Determina si el deslizador se coloca en el valor final correspondiente. El valor final es el valor
mínimo o máximo. Para colocar el deslizador sobre el valor final, el usuario hace clic en el
área situada fuera del actual ajuste del regulador.
Acceso en runtime: lectura y escritura
Sintaxis
Object.JumpToLimitsAfterMouseClick[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● WindowsSlider
BOOLEAN
Opcional. TRUE si el deslizador se coloca en el valor final correspondiente.
Descripción
Define el color de rotulación de la escala en el objeto "Slider".
Acceso en runtime: lectura y escritura
Sintaxis
Object.LabelColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Slider
Color
Opcional. Valor o constante que determina el color de rotulación de la escala.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina el idioma actual de runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Language[= LONG]
Object
Obligatorio. Objeto del tipo "HMIRuntime".
LONG
Opcional. Valor o constante que contiene el código de país.
Observaciones
En VBS, el idioma de runtime se indica con un código de país, p. ej. 1031 para alemán, 2057
para inglés, etc. Encontrará una relación de todos los códigos de país en los principios básicos
de VBScript, en el tema "Cuadro de Id. de configuración regional (LCID)".
Consulte también
HMIRuntime (Página 1313)
Descripción
Determina si las marcas largas de una escala se muestran en negrita.
Acceso en runtime: lectura y escritura
Sintaxis
Object.LargeTicksBold[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional. TRUE, si las marcas largas de una escala se muestran en negrita.
Descripción
Determina la longitud de las marcas largas de una escala.
Acceso en runtime: lectura y escritura
Sintaxis
Object.LargeTicksSize[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
Int32
Opcional. Un valor o una constante que determina la longitud de las marcas largas de una
escala.
Descripción
Determina el número de índice del punto de conexión con el último objeto asociado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.LastConnectedObjectIndex[=Int]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Connector".
Int
Int
Consulte también
Connector (Página 1379)
Descripción
Determina el nombre del objeto que está acoplado en el punto de conector inferior.
Acceso en runtime: lectura y escritura
Sintaxis
Object.LastConnectedObjectName[=String]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Connector".
String
String
Consulte también
Connector (Página 1379)
Descripción
Devuelve un código de error acerca del éxito de la última operación, p. ej. información acerca
del proceso de escribir o leer una variable:
Para obtener una descripción del error debe ejecutarse primero el método Read.
Nota
Si el error se produce al acceder a través del objeto TagSet, evalúe la propiedad LastError
para cada variable del objeto TagSet.
Para obtener una indicación sobre la calidad del valor proporcionado, utilice la propiedad
"QualityCode". Para obtener una descripción del error, utilice la propiedad "ErrorDescription".
Acceso en runtime: lectura
Sintaxis
Object.LastError
Object
Obligatorio. Un objeto del tipo "Tag".
Ejemplo
El siguiente ejemplo muestra el código de error para la variable "Tag1":
'VBS77
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
objTag.Read
MsgBox objTag.LastError
El siguiente ejemplo agrega a la lista TagSet dos variables y presenta la propiedad LastError
como Trace:
'VBS178
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
group.Add "Motor1"
group.Add "Motor2"
HMIRuntime.Trace "LastError: " & group.LastError & vbNewLine
Se puede acceder a la propiedad LastError de una variable contenida en la lista del siguiente
modo:
Consulte también
Tag (Página 1332)
TagSet (lista) (Página 1336)
Descripción
Dentro de la imagen, devuelve como LONG el nivel en el que se encuentra un objeto. En total
hay 32 niveles disponibles, siendo el nivel "0" el nivel inferior, y el nivel "31" el nivel superior.
Dentro de un nivel, los objetos que han sido proyectados primero estarán en el fondo.
Acceso en runtime: lectura
Sintaxis
Object.Layer
Object
Obligatorio. Un objeto del tipo "ScreenItem".
Nota
La propiedad Layer indica el nivel en el que se encuentra el objeto. El nivel "0" se muestra
como nivel "0".
Durante el acceso, las capas son enumeradas en VBS del 1 hacia arriba. Por tanto, acceda
al nivel "1" con layers(2).
Ejemplo
El siguiente ejemplo indica el nombre y el nivel de todos los objetos de la imagen "NewPDL1":
'VBS78
Dim objScreen
Dim objScrItem
Dim lngAnswer
Dim lngIndex
Dim strName
lngIndex = 1
Set objScreen = HMIRuntime.Screens("NewPDL1")
For lngIndex = 1 To objScreen.ScreenItems.Count
strName = objScreen.ScreenItems.Item(lngIndex).ObjectName
Set objScrItem = objScreen.ScreenItems(strName)
lngAnswer = MsgBox(strName & " is in layer " & objScrItem.Layer,vbOKCancel)
If vbCancel = lngAnswer Then Exit For
Next
Consulte también
ScreenItem (Página 1323)
HTMLBrowser (Página 1416)
Group (Página 1414)
ForeignControl (Página 1393)
DateTimeField (Página 1381)
ZoneQualityView (Página 1543)
ZoneLabelView (Página 1542)
WLanQualityView (Página 1541)
ProtectedAreaName (Página 1463)
RangeLabelView (Página 1464)
RangeQualityView (Página 1466)
ScreenWindow (Página 1477)
ScriptDiagnostics (Página 1479)
Slider (Página 1481)
SmartClientView (Página 1484)
StatusForce (Página 1486)
SymbolLibrary (Página 1496)
BatteryView (Página 1359)
ChannelDiagnose (Página 1364)
CheckBox (Página 1366)
GraphicIOField (Página 1408)
Descripción
Indica si los niveles de una imagen se muestran o se ocultan en función de un zoom mínimo
o máximo configurado.
Acceso en runtime: lectura
Sintaxis
Object.LayerDeclutteringEnable
Object
Obligatorio. Un objeto del tipo "Screen".
Ejemplo:
El ejemplo muestra la propiedad LayerDecluttering de la imagen "NewPDL1" como Trace.
'VBS156
Dim objScreen
Set objScreen = HMIRuntime.Screens("NewPDL1")
HMIRuntime.Trace "Enable: " & objScreen.LayerDeclutteringEnable & vbNewLine
Consulte también
Screen (Página 1320)
Descripción
Devuelve un objeto del tipo "Layers".
Acceso en runtime: lectura
Sintaxis
Object.Layers
Object
Obligatorio. Un objeto del tipo "Screen".
Consulte también
Screen (Página 1320)
Descripción
Define el valor de la coordenada X del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Left[=DOUBLE]
Object
Obligatorio. Un objeto del tipo "ScreenItem". Ésta es una propiedad estándar del objeto
ScreenItem-Objekts, por lo que está disponible en todas las apariencias.
DOUBLE
Opcional. Valor o constante que contiene el valor de la coordenada X en píxeles (medido
desde el borde superior izquierdo de la imagen).
Observaciones
La coordenada X hace referencia al ángulo superior izquierdo del recuadro que rodea al objeto.
En runtime se vigilan también los límites de la imagen. Si el valor de coordenada asignado
excede el tamaño de la pantalla, el script de usuario se cancelará con un mensaje de error.
AUTOHOTSPOT
AUTOHOTSPOT
Descripción
Determina la distancia de la imagen desde el borde izquierdo de la ventana de imagen.
La imagen se visualizará como corte de la ventana de imagen. Las barras de desplazamiento
de la imagen están ubicadas en el borde izquierdo y borde superior de la imagen. Si desea
representar la imagen en la ventana de imagen con el desplazamiento horizontal y vertical de
las barras de desplazamiento de la imagen, utilice para el desplazamiento las propiedades
"HorizontalScrollBarPosition" y "VerticalScrollBarPosition".
Acceso en runtime: lectura y escritura
Sintaxis
Object.LeftOffset[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Screenwindow
Int32
Opcional. Valor o constante que determina la distancia de la imagen desde el borde izquierdo
de la ventana de imagen.
Descripción
Establece el valor límite inferior para "Reserve4".
La propiedad "Limit4LowerLimitEnabled" debe haberse puesto a TRUE para que pueda
vigilarse el valor límite "Reserve4".
Acceso en runtime: lectura y escritura
Sintaxis
Object.Limit4LowerLimit[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
DOUBLE
Opcional. Valor o constante que establece el valor límite inferior para "Reserve4".
Observaciones
La propiedad "Limit4LowerLimitRelative" determina si el objeto se evalúa de forma porcentual
o absoluta.
Descripción
Determina el color para el valor límite inferior "Reserve4".
La propiedad "Limit4LowerLimitEnabled" debe tener el valor TRUE cuando debe modificarse
el color de barra al alcanzar el valor límite.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Limit4LowerLimitColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
Color
Opcional. Un valor o una constante que determina el color para el valor límite inferior
"Reserve4".
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina si se vigila el valor límite inferior "Reserve4".
Acceso en runtime: lectura y escritura
Sintaxis
Object.Limit4LowerLimitEnabled[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional. TRUE si se vigila el valor límite inferior "Reserve4".
Observaciones
Los siguientes valores se determinan por medio de las propiedades "Limit4LowerLimit",
"Limit4LowerLimitColor" y "Limit4LowerLimitRelative":
● Valor límite
● Representación al alcanzarse el valor límite
● Tipo de evaluación
Descripción
Determina si el valor límite inferior "Reserve4" se evalúa en porcentaje o de forma absoluta.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Limit4LowerLimitRelative[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional.
TRUE: el valor límite inferior "Reserve4" se evalúa en porcentaje.
FALSE: el valor límite inferior "Reserve4" se evalúa de forma absoluta.
Descripción
Establece el valor límite superior para "Reserve4".
La propiedad "Limit4UpperLimitEnabled" debe haberse puesto a TRUE para que pueda
vigilarse el valor límite "Reserve4".
Acceso en runtime: lectura y escritura
Sintaxis
Object.Limit4UpperLimit[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
DOUBLE
Opcional. Valor o constante que establece el valor límite superior para "Reserve4".
Observaciones
La propiedad "Limit4UpperLimitRelative" determina si el objeto se evalúa de forma porcentual
o absoluta.
Descripción
Determina el color para el valor límite superior "Reserve4".
La propiedad "Limit4UpperLimitEnabled"" debe tener el valor TRUE si debe modificarse el
color de barra al alcanzar el valor límite.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Limit4UpperLimitColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
Color
Opcional. Un valor o una constante que determina el color para el valor límite superior
"Reserve4".
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina si se vigila el valor límite superior "Reserve4".
Acceso en runtime: lectura y escritura
Sintaxis
Object.Limit4UpperLimitEnabled[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional. TRUE si se vigila el valor límite superior "Reserve4".
Observaciones
Los siguientes valores se determinan por medio de las propiedades "Limit4UpperLimit",
"Limit4UpperLimitColor" y "Limit4UpperLimitRelative":
● Valor límite
● Representación al alcanzarse el valor límite
● Tipo de evaluación
Descripción
Determina si el valor límite superior "Reserve4" se evalúa en porcentaje o de forma absoluta.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Limit4UpperLimitRelative[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional.
TRUE: el valor límite inferior "Reserve4" se evalúa en porcentaje.
FALSE: el valor límite inferior "Reserve4" se evalúa de forma absoluta.
Descripción
Establece el valor límite inferior para "Reserve5".
La propiedad "Limit5LowerLimitEnabled" debe haberse puesto a TRUE para que pueda
vigilarse el valor límite "Reserve5".
Acceso en runtime: lectura y escritura
Sintaxis
Object.Limit5LowerLimit[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
DOUBLE
Opcional. Valor o constante que establece el valor límite inferior para "Reserve5".
Observaciones
La propiedad "Limit5LowerLimitRelative" determina si el objeto se evalúa de forma porcentual
o absoluta.
Descripción
Determina el color para el valor límite inferior "Reserve5".
Sintaxis
Object.Limit5LowerLimitColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
Color
Opcional. Un valor o una constante que determina el color para el valor límite inferior
"Reserve5".
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina si se vigila el valor límite inferior "Reserve5".
Acceso en runtime: lectura y escritura
Sintaxis
Object.Limit5LowerLimitEnabled[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional. TRUE si se vigila el valor límite inferior "Reserve5".
Observaciones
Los siguientes valores se determinan por medio de las propiedades "Limit5LowerLimit",
"Limit5LowerLimitColor" y "Limit5LowerLimitRelative":
● Valor límite
● Representación al alcanzarse el valor límite
● Tipo de evaluación
Descripción
Determina si el valor límite inferior "Reserve5" se evalúa en porcentaje o de forma absoluta.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Limit5LowerLimitRelative[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional.
TRUE: el valor límite inferior "Reserve5" se evalúa en porcentaje.
FALSE: el valor límite inferior "Reserve5" se evalúa de forma absoluta.
Descripción
Establece el valor límite superior para "Reserve5".
La propiedad "Limit5UpperLimitEnabled" debe haberse puesto a TRUE para que pueda
vigilarse el valor límite "Reserve5".
Acceso en runtime: lectura y escritura
Sintaxis
Object.Limit5UpperLimit[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
DOUBLE
Opcional. Valor o constante que establece el valor límite superior para "Reserve5".
Observaciones
La propiedad "TypeLimitHigh5" determina si el objeto se evalúa de forma porcentual o
absoluta.
Descripción
Determina el color para el valor límite superior "Reserve5".
La propiedad "Limit5UpperLimitEnabled" debe tener el valor TRUE cuando debe modificarse
el color de barra al alcanzar el valor límite.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Limit5UpperLimitColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
Color
Opcional. Un valor o una constante que determina el color para el valor límite superior
"Reserve5".
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina si se vigila el valor límite superior "Reserve5".
Acceso en runtime: lectura y escritura
Sintaxis
Object.Limit5UpperLimitEnabled[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional. TRUE si se vigila el valor límite superior "Reserve5".
Descripción
Determina si el valor límite superior "Reserve5" se evalúa en porcentaje o de forma absoluta.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Limit5UpperLimitRelative[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional.
TRUE: el valor límite superior "Reserve5" se evalúa en porcentaje.
FALSE: el valor límite superior "Reserve5" se evalúa de forma absoluta.
Descripción
Define el color de las líneas de separación de la ventana. Mediante el botón abra el cuadro
de diálogo "Selección de color" para seleccionar el color.
Acceso en runtime: lectura y escritura
Sintaxis
Object.LineColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
Color
Opcional. Valor o constante que determina el color de las líneas de separación de la ventana.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Determina la apariencia de los finales de línea.
Acceso en runtime: lectura y escritura
Sintaxis
Object.LineEndShapeStyle[=LineEndShapeStyle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● ComboBox
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● SymbolicIOField
● TextField
● WindowsSlider
● Switch
Con las siguientes apariencias no se tiene acceso en runtime:
● Switch
● TubeArcObect
LineEndShapeStyle
Opcional. Valor o constante que determina la apariencia de los finales de línea.
Descripción
Determina el grosor de línea del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.LineWidth[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmControl
● CircularArc
● EllipticalArc
● FunctionTrendControl
● Line
● OnlineTableControl
● OnlineTrendControl
● Polyline
● TrendRulerControl
● TubeArcObject
● TubeDoubleTeeObject
● TubeTeeObject
● Tubepolyline
● UserArchiveControl
Con la siguiente apariencia no se tiene acceso en runtime:
● Polygon
Int32
Opcional. Un valor o una constante que determina el grosor de línea en píxeles.
Descripción
Determina si los valores de variables para el intervalo de tiempo que se representa se cargan
desde los ficheros al abrir una imagen.
Acceso en runtime: lectura y escritura
Sintaxis
Object.LoadDataImmediately[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
BOOLEAN
Opcional. TRUE si los valores de variables para el intervalo de tiempo que se representa se
cargan desde los ficheros al abrir una imagen.
Descripción
Ningún acceso en runtime.
Descripción
Determina si el tamaño del reloj puede ajustarse con el ratón.
Acceso en runtime: lectura y escritura
Sintaxis
Object.LockSquaredExtent[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Clock
● Gauge
BOOLEAN
Opcional. TRUE si el tamaño del reloj puede ajustarse en cada proporción de página deseada
arrastrando el ratón en los puntos de selección.
Descripción
Devuelve un objeto del tipo "Logging".
Acceso en runtime: lectura
Sintaxis
Object.Logging
Object
Obligatorio. Un objeto del tipo "HMIRuntime".
Consulte también
HMIRuntime (Página 1313)
Descripción
Determina si después de una operación con este objeto se visualiza un aviso en el sistema
de avisos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.LogOperation[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● CheckBox
● ComboBox
● IOField
● ListBox
● OptionGroup
● SymbolicIOField
● WindowsSlider
BOOLEAN
Opcional. TRUE, si después de una operación con este objeto se visualiza un aviso en el
sistema de avisos.
Descripción
Determina cómo se mostrarán los avisos en la lista de ficheros históricos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.LongTermArchiveConsistency[= BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
BOOLEAN
Valor Explicación
TRUE Se muestran los últimos 1000 avisos en el cliente de todos los servidores o par de servi‐
dores redundantes en la lista de ficheros históricos.
FALSE Se muestran 1000 avisos en la lista de ficheros históricos en el monopuesto, en el servidor
o en el cliente por cada servidor o par de servidores redundantes.
Descripción
Determina el valor límite inferior para valores de entrada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.LowerLimit[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● IOField
DOUBLE
Opcional. Un valor o una constante que determina el valor límite inferior para valores de
entrada.
Descripción
Determina el color del botón inferior o izquierdo para desplazarse por una barra de
desplazamiento.
Acceso en runtime: lectura y escritura
Sintaxis
Object.LowLimitColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● WindowsSlider
Color
Opcional. Un valor o una constante que determina el color del botón inferior o izquierdo para
desplazarse por una barra de desplazamiento.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina la ID de red del dispositivo que debe vigilarse.
Introduzca el nombre o el puerto del dispositivo como ID de red.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MachineName[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● SmartClientView
STRING
Opcional. Valor o constante que contiene la ID de red.
Descripción
Determina el ancho del borde 3D en píxeles. El valor para el ancho depende del tamaño del
objeto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MarginToBorder[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● WindowsSlider
Int32
Opcional. Un valor o una constante que determina el ancho del borde 3D en píxeles.
Descripción
Determina el valor máximo de la escala en el objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MaximumValue[=DOUBLE | Int32 | SINGLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
● Gauge
● Slider
● WindowsSlider
Descripción
Carga el archivo de configuración indicado con los menús y barras de herramientas definidos
por el usuario o reproduce el nombre del archivo de configuración.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MenuToolBarConfig[=HmiObjectHandle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Screenwindow
HmiObjectHandle
Opcional. El archivo de configuración con menú personalizado y barras de herramientas.
Descripción
Determina cómo se van a alinear los contenidos del bloque de aviso seleccionado en la tabla.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageBlockAlignment [=HorizontalAlignment]
Object
Necesario. Objeto del tipo "ScreenItem" con las apariencias "AlarmContro",
"TrendRulerControl", "OnlineTableControl", "UserArchiveControl".
HorizontalAlignment
Consulte también
AlarmControl (Página 1338)
Descripción
Determina si la cantidad de dígitos de coma se debe determinar automáticamente.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageBlockAutoPrecisions[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
BOOLEAN
TRUE: el número de decimales se determinará automáticamente.
FALSE: el valor del campo "Decimales" tiene efecto.
Descripción
Establece el título de la columna en el visor de avisos para el bloque de aviso seleccionado.
La opción "Aplicar configuración del proyecto" debe estar desactivada para poder modificar
las designaciones. El nombre introducido es efectivo en todos los idiomas de runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageBlockCaption[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
STRING
Opcional. Establece el título de la columna en el visor de avisos para el bloque de aviso
seleccionado.
Descripción
Especifica el número de bloques de aviso existentes que están disponibles para la lista de
avisos y la lista de aciertos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageBlockCount[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
Int32
Opcional. Especifica el número de bloques de aviso existentes que están disponibles para la
lista de avisos y la lista de aciertos.
Descripción
Determina qué formato de fecha se debe utilizar para los avisos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageBlockDateFormat[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
STRING
Valor Explicación
Automático El formato de fecha se generará automáticamente.
dd.MM.yy Día.Mes.Año, p. ej., 24.12.10.
dd.MM.yyyy Día.Mes.Año, p. ej., 24.12.2010.
dd/MM/yy Día/Mes/Año, p. ej., 24/12/10.
dd/MM/yyyy Día/Mes/Año, p. ej., 24/12/2010.
Descripción
Determina si los valores del bloque de aviso seleccionado se mostrarán en representación
exponencial.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageBlockExponentialFormat[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
BOOLEAN
TRUE: los valores se muestran en representación exponencial.
FALSE: los valores se muestran en representación decimal.
Descripción
Establece si contenido del bloque de aviso parpadeé en runtime si aparece un aviso.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageBlockFlashOn[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
BOOLEAN
TRUE: el contenido del bloque de aviso parpadea.
FALSE: el contenido del bloque de aviso no parpadea.
Descripción
Determina si el contenido del bloque de aviso el texto se mostrará en forma de texto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageBlockHideText[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
BOOLEAN
TRUE: el contenido no se muestra en forma de texto. La opción no está activada.
FALSE: el contenido se muestra en forma de texto. La opción está activada.
Descripción
Determina si el título del bloque de aviso seleccionado se mostrará en forma de texto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageBlockHideTitleText[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
BOOLEAN
TRUE: el título no se mostrará en forma de texto. La opción no está activada.
FALSE: el título se mostrará en forma de texto. La opción está activada.
Descripción
Define la asignación de clave ID y bloque de aviso en el visor de avisos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageBlockId[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
Int32
Opcional. Define la asignación de clave ID y bloque de aviso en el visor de avisos.
Descripción
Hace referencia a un bloque de aviso ya existente. Mediante la utilización de este atributo
podrá asignar a un bloque de aviso determinado los valores de otros atributos. Los valores
válidos para "MessageBlockIndex" se encuentran entre 0 y "MessageBlockCount" menos 1.
El atributo "MessageBlockIndex" se puede dinamizar con el atributo MessageBlockRepos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageBlockIndex[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
Int32
Opcional. Hace referencia a un bloque de aviso ya existente. Los valores válidos para
"MessageBlockIndex" se encuentran entre 0 y "MessageBlockCount" menos 1.
Descripción
Determina si el formato del bloque de aviso seleccionado se mostrará con ceros a la
izquierda.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageBlockLeadingZeros[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
Int32
TRUE: se mostrarán ceros a la izquierda. El número de los ceros a la izquierda se establece
en las propiedades.
FALSE: no se mostrarán ceros a la izquierda.
Descripción
Establece la "Longitud en caracteres" para el contenido del bloque de aviso seleccionado.
Solamente se podrá introducir un valor si el campo "Aplicar preferencias de proyecto" no está
activo.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageBlockLength[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
Int32
Opcional. Valor que establece la longitud del bloque de aviso.
Descripción
Define el nombre para el bloque de aviso seleccionado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageBlockName[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
STRING
Opcional. Define el nombre para el bloque de aviso seleccionado.
Descripción
Define el número de posiciones decimales de los valores del bloque de aviso seleccionado.
Solamente se puede indicar el valor si la opción "Automático" está desactivada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageBlockPrecisions[=Int16]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
Int16
Opcional. Determina el número de decimales.
Descripción
Los bloques de aviso existentes son bloques que están disponibles para la lista de avisos o
la lista de aciertos en el control en runtime.
En la ficha "Bloques de aviso" active los bloques que necesite en Control de los bloques de
aviso existentes. En las fichas "Lista de aciertos" y "Lista de avisos" configure las listas de
aciertos y avisos de los bloques existentes.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageBlockSelected[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
BOOLEAN
Opcional. En la ficha "Bloques de aviso" active los bloques que necesite en Control de los
bloques de aviso existentes. En las fichas "Lista de aciertos" y "Lista de avisos" configure las
listas de aciertos y avisos de los bloques existentes.
Descripción
Establece si en el bloque de aviso "Hora" se mostrará la fecha junto con la hora.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageBlockShowDate[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
BOOLEAN
TRUE: se muestran la fecha y la hora.
FALSE: se muestra la hora.
Descripción
Determina si el contenido del bloque de aviso se mostrará en forma de símbolo.
Sintaxis
Object.MessageBlockShowIcon[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
BOOLEAN
TRUE: el contenido se muestra en forma de símbolo.
FALSE: el contenido no se muestra en forma de símbolo.
Descripción
Determina si el título del bloque de aviso seleccionado se mostrará en forma de texto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageBlockShowTitleIcon[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
BOOLEAN
TRUE: el título se mostrará en forma de símbolo.
FALSE: el título no se mostrará en forma de símbolo.
Descripción
Define la denominación para el bloque de aviso seleccionado con ayuda de un ID de texto
obtenido en Text-Library. Si se cambia el idioma runtime la denominación se ajustará
automáticamente.
Para indicar un ID de texto, desactive la opción "Aplicar la configuración del proyecto".
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageBlockTextId[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
Int32
Opcional. Define el nombre del bloque de aviso seleccionado con ayuda de un ID de texto.
Descripción
Determina qué formato de tiempo o de duración se debe utilizar para visualizar los avisos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageBlockTimeFormat[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
STRING
Los siguientes formatos de tiempo están a disposición:
Valor Explicación
Automático El formato de tiempo se generará automáticamente.
HH:mm:ss Horas:Minutos:Segundos, por ejemplo 15:35:44
HH:mm:ss.ms Horas:Minutos:Segundos.milisegundos, por ejemplo 15:35:44.240.
hh:mm:ss tt Horas:Minutos:Segundos, AM/PM, por ejemplo 03:35:44 PM.
hh:mm:ss.ms tt Horas:Minutos:Segundos.milisegundos, AM/PM, por ejemplo 03:35:44.240
PM.
Valor Explicación
Automático El formato de duración se generará automáticamente.
d H:mm:ss Día Horas:Minutos:Segundos, por ejemplo 1 2:03:55.
H:mm:ss. Horas:Minutos:Segundos, por ejemplo 26:03:55.
m:ss Minutos:Segundos, ejemplo: 1563:55.
s Segundos, por ejemplo 93835.
Descripción
Indica el número de bloques de aviso existentes que están disponibles para la lista de avisos
y la lista de aciertos.
Acceso en runtime: lectura
Sintaxis
Object.MessageBlockType[=AlarmBlockType]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
AlarmBlockType
Descripción
Aplica el bloque de aviso marcado de la lista de bloques de aviso existentes y lo introduce en
la lista de bloques de aviso seleccionados.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageColumnAdd[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
STRING
Opcional. Aplica el bloque de aviso marcado de la lista de bloques de aviso existentes y lo
introduce en la lista de bloques de aviso seleccionados.
Descripción
Especifica el número de bloques de aviso seleccionados que aparecerán en la lista de avisos
en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageColumnCount[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
Int32
Opcional. Especifica el número de bloques de aviso seleccionados que aparecerán en la lista
de avisos en runtime.
Descripción
Hace referencia a uno de los bloques de aviso seleccionados para la lista de avisos. Mediante
la utilización de este atributo podrá asignar a un bloque de aviso determinado de la lista de
avisos los valores de otros atributos.
Los valores válidos para "MessageColumnIndex" se encuentran entre 0 y
"MessageColumnCount" menos 1. El atributo "MessageColumnIndex" puede dinamizarse con
el atributo MessageColumnRepos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageColumnIndex[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
Int32
Opcional. Hace referencia a uno de los bloques de aviso seleccionados para la lista de avisos.
Los valores válidos para "MessageColumnIndex" se encuentran entre 0 y
"MessageColumnCount" menos 1.
Descripción
Define el nombre del bloque de aviso de la lista de avisos referenciado con la propiedad
"MessageColumnIndex".
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageColumnName[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
STRING
Opcional. Define el nombre del bloque de aviso de la lista de avisos referenciado con la
propiedad "MessageColumnIndex".
Descripción
Elimina el bloque de aviso seleccionado de la lista de bloques seleccionados y lo introduce
en la lista de bloques de aviso existentes.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageColumnRemove[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
STRING
Opcional. Elimina el bloque de aviso seleccionado de la lista de bloques seleccionados y lo
introduce en la lista de bloques de aviso existentes.
Descripción
Define la secuencia de los bloques de aviso. "Arriba" y "Abajo" desplazan el bloque de aviso
seleccionado en la lista. De esta forma, el bloque de aviso se desplaza hacia arriba o abajo
en el visor de avisos en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageColumnRepos[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
Int32
Opcional. Valor que establece la secuencia de los bloques de aviso en la lista.
Descripción
Establece cómo se clasificará en la lista de avisos el bloque de aviso referenciado en
"MessageColumnIndex".
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageColumnSort[=SortMode]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
SortMode
0: ninguna clasificación.
1: clasificación ascendente desde el valor menor hasta el mayor.
2: clasificación descendente desde el valor mayor hasta el menor.
Descripción
Define la secuencia de clasificación del bloque de aviso referenciado en
"MessageColumnIndex". Si ajusta el valor a "0", el criterio de clasificación se eliminará de
"MessageColumnSort".
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageColumnSortIndex[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
Int32
Opcional. Define la secuencia de clasificación del bloque de aviso referenciado en
"MessageColumnIndex".
Descripción
Determina si los bloques de aviso se mostrarán en el visor de avisos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageColumnVisible[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
BOOLEAN
Opcional.
TRUE: los bloques de aviso se muestran en el visor de avisos.
FALSE: los bloques de aviso no se muestran en el visor de avisos.
Descripción
Determina de qué lista de avisos se muestran contenidos al abrir una imagen.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MessageListType[=AlarmListType]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
AlarmListType
Descripción
Determina el valor mínimo de la escala en el objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.MinimumValue[=DOUBLE | Int32 | SINGLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
● Gauge
● Slider
● WindowsSlider
Descripción
Define la longitud del minutero en el objeto "Clock".
Acceso en runtime: lectura y escritura
Sintaxis
Object.MinuteNeedleHeight[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Clock
Int32
Opcional. Valor o constante que determina la longitud del minutero.
Indique la longitud del minutero en tantos por ciento, referidos al radio de la esfera.
Descripción
Define el ancho del minutero en el objeto "Clock".
Acceso en runtime: lectura y escritura
Sintaxis
Object.MinuteNeedleWidth[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Clock
Int32
Opcional. Valor o constante que determina el ancho del minutero.
Indique el ancho en tantos por ciento, referidos a la longitud doble del minutero.
Descripción
Determina el tipo de campo del objeto indicado.
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura y escritura
Sintaxis
Object.Mode[=IOFieldType]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Button
● IOField
● RoundButton
● SymbolicIOField
Con la siguiente apariencia no se tiene acceso en runtime:
● DateTimeField
● GraphicIOField
● Switch
IOFieldType
hmiIOFieldInput (1): campo de entrada
hmiIOFieldOutput (0): campo de salida
hmiIOFieldInOutput (2): campo de entrada y salida
Descripción
Determina si la ventana puede moverse en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Moveable[=BOOLEAN]
Object
Necesario. Objeto del tipo "ScreenItem" con la especificación "UserArchiveControl".
BOOLEAN
Opcional. TRUE si la ventana puede moverse en runtime.
Consulte también
AlarmControl (Página 1338)
UserArchiveControl (Página 1528)
TrendRulerControl (Página 1508)
FunctionTrendControl (Página 1397)
OnlineTableControl (Página 1434)
OnlineTrendControl (Página 1443)
Descripción
Define uno o varios Statements SQL para la selección personalizada de los avisos. Varias
selecciones personalizadas se vinculan con "OR". Si ha configurado una selección fija
"DefaultMsgFilterSQL", los Statements SQL de "DefaultMsgFilterSQL" y "MsgFilterSQL" se
vinculan con "AND".
Acceso en runtime: lectura y escritura
Sintaxis
Object.MsgFilterSQL[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
STRING
Opcional. Valor o constante que establece las instrucciones SQL para la selección
personalizada de los avisos.
Descripción
Devuelve el nombre de objeto como STRING. El valor devuelto depende del objeto utilizado.
Acceso en runtime: lectura
Sintaxis
Object.Name[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● BatteryView
● Clock
● Ellipse
● Gauge
● Slider
Con la siguiente apariencia no se tiene acceso en runtime:
● AlarmControl
● AlarmView
● ApplicationWindow
● Bar
● Button
● ChannelDiagnose
● CheckBox
● Circle
● CircleSegment
● CircularArc
● ComboBox
● DateTimeField
● DiscSpaceView
● EllipseSegment
● EllipticalArc
● FunctionTrendControl
● GraphicIOField
● GraphicView
● HTML-Browser
● IOField
● Line
● ListBox
● MediaPlayer
● MultiLineEdit
● OnlineTableControl
● OnlineTrendControl
● OptionGroup
● PLCCodeViewer
● Polygon
● Polyline
● ProtectedAreaNameView
● RangeLabelView
● RangeQualityView
● RecipeView
● Rectangle
● RoundButton
● S7GraphOverview
● Screenwindow
● SmartClientView
● StatusForce
● Switch
● SymbolLibrary
● SymbolicIOField
● SysDiagControl
● TextField
● TrendRulerControl
● TrendView
● TubeArcObject
● TubeDoubleTeeObject
● TubeTeeObject
● Tubepolyline
● UserArchiveControl
● UserView
● WLanQualityView
● WindowsSlider
● ZoneLabelView
● ZoneQualityView
Observaciones
En función del objeto indicado se devuelven los siguientes nombres de objeto:
● Tag: nombre de la variable sin prefijo de servidor y variable.
● Project: nombre del proyecto de runtime actual.
● DataItem: nombre del objeto DataItem.
● Layer: nombre del nivel.
● FunctionTrendControl: nombre de la curva referenciada por la propiedad "Index".
Nota
En la lista "Tags" se puede acceder a una variable mediante la propiedad "Name". Los
nombres de las variables están estructurados en WinCC según el siguiente esquema:
<Prefijo de variable><Nombre de variable>
Si solo se indica el nombre de variable, el prefijo de variable se toma del contexto de la
ventana de imagen.
Ejemplo
El siguiente ejemplo indica el nombre del proyecto de runtime actual como Trace:
'VBS160
HMIRuntime.Trace "Name: " & HMIRuntime.ActiveProject.Name & vbNewLine
Descripción
Define el color de línea de las agujas en el objeto "Clock".
Acceso en runtime: lectura y escritura
Sintaxis
Object.NeedleBorderColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Clock
Color
Opcional. Valor o constante que determina el color de línea de la aguja.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen .
Descripción
Define el color de las agujas en el objeto "Clock".
La propiedad "NeedleFillStyle" debe haberse configurado como "Transparent" para que el
color de las agujas se vea.
Acceso en runtime: lectura y escritura
Sintaxis
Object.NeedleColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Clock
Color
Opcional. Valor o constante que determina el color de las agujas.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina si los punteros deben mostrarse opacos o transparentes.
Acceso en runtime: lectura y escritura
Sintaxis
Object.NeedleFillStyle[=THmiFillStyle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Clock
THmiFillStyle
hmiFillStyleTransparent (65536): los punteros se rellenan en el color de relleno del puntero y
con el borde en el color del primer plano.
hmiFillStyleSolid (0): los punteros aparecen transparentes y se muestran con un borde en el
color del primer plano.
Descripción
Define el color del rango normal en la escala del objeto "Gauge".
La propiedad "NormalRangeVisible" debe tener el valor TRUE para que se visualice el rango
normal.
Acceso en runtime: lectura y escritura
Sintaxis
Object.NormalRangeColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
Color
Opcional. Valor o constante que determina el color del rango normal.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Determina si debe mostrarse el rango normal en la escala del objeto "Gauge".
Acceso en runtime: lectura y escritura
Sintaxis
Object.NormalRangeVisible[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
BOOLEAN
Opcional. TRUE si debe mostrarse el rango normal en la escala.
Observaciones
El color del rango normal se define con la propiedad "NormalRangeColor".
Descripción
Si se utiliza un Control no provisto por WinCC puede suceder que las propiedades aportadas
por el Control tengan el mismo nombre que las propiedades ScreenItem generales. En estos
casos, las propiedades ScreenItem tienen prioridad. Es posible acceder a las propiedades
"ocultas" de un Controls de terceros mediante la propiedad adicional "object".
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura y escritura
Sintaxis
Object.Object
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmControl
● AlarmView
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
Con la siguiente apariencia no se tiene acceso en runtime:
● RecipeView
● SmartClientView
● StatusForce
● SymbolLibrary
● UserArchiveControl
Ejemplo de aplicación
Acceda a las propiedades de un control de terceros de la siguiente forma:
Control.object.type
Si sólo se emplea la forma Control.type se utilizan las propiedades del objeto ScreenItem en
caso de equivalencia de nombres.
Descripción
Indica si sólo se muestran objetos dentro de un rango de tamaño definido.
Acceso en runtime: lectura
Sintaxis
Object.ObjectSizeDeclutteringEnable
Object
Obligatorio. Un objeto del tipo "Screen".
Ejemplo
El ejemplo muestra las propiedades Decluttering de la imagen "NewPDL1" como Trace.
'VBS157
Dim objScreen
Set objScreen = HMIRuntime.Screens("NewPDL1")
HMIRuntime.Trace "Min: " & objScreen.ObjectSizeDeclutteringMin & vbNewLine
HMIRuntime.Trace "Max: " & objScreen.ObjectSizeDeclutteringMax & vbNewLine
HMIRuntime.Trace "Enable: " & objScreen.LayerDeclutteringEnable & vbNewLine
Consulte también
Screen (Página 1320)
Descripción
Devuelve como LONG el rango de tamaño superior para suprimir la visualización de objetos
de la imagen indicada.
Acceso en runtime: lectura
Sintaxis
Object.ObjectSizeDeclutteringMax
Object
Obligatorio. Un objeto del tipo "Screen".
Ejemplo
El ejemplo muestra las propiedades Decluttering de la imagen "NewPDL1" como Trace.
'VBS157
Dim objScreen
Set objScreen = HMIRuntime.Screens("NewPDL1")
HMIRuntime.Trace "Min: " & objScreen.ObjectSizeDeclutteringMin & vbNewLine
HMIRuntime.Trace "Max: " & objScreen.ObjectSizeDeclutteringMax & vbNewLine
HMIRuntime.Trace "Enable: " & objScreen.LayerDeclutteringEnable & vbNewLine
Consulte también
Screen (Página 1320)
Descripción
Devuelve como LONG el rango de tamaño inferior para suprimir la visualización de objetos
de la imagen indicada.
Acceso en runtime: lectura
Sintaxis
Object.ObjectSizeDeclutteringMin
Object
Obligatorio. Un objeto del tipo "Screen".
Ejemplo
El ejemplo muestra las propiedades Decluttering de la imagen "NewPDL1" como Trace.
'VBS157
Dim objScreen
Set objScreen = HMIRuntime.Screens("NewPDL1")
HMIRuntime.Trace "Min: " & objScreen.ObjectSizeDeclutteringMin & vbNewLine
HMIRuntime.Trace "Max: " & objScreen.ObjectSizeDeclutteringMax & vbNewLine
HMIRuntime.Trace "Enable: " & objScreen.LayerDeclutteringEnable & vbNewLine
Consulte también
Screen (Página 1320)
Descripción
Ningún acceso en runtime.
Descripción
Determina el inicio y la detención de la actualización.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Online[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTrendControl
● FunctionTrendControl
● OnlineTableControl
BOOLEAN
Opcional.
TRUE: se detiene la representación actualizada. Los valores se guardan en la memoria
intermedia y se añaden en cuanto vuelve a activarse el botón.
FALSE: se reanuda la representación actualizada.
Descripción
Establece cuántos pasos se desplaza el deslizador de la barra de desplazamiento con un clic
de ratón.
Acceso en runtime: lectura y escritura
Sintaxis
Object.OperationSteps[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● WindowSlider
Int32
Opcional. Valor o constante que establece cuántos pasos se desplaza el deslizador de la barra
de desplazamiento con un clic de ratón.
Descripción
Define la asignación por la clave ID y el evento de activación en el visor de avisos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.OperatorMessageId[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
Int32
Descripción
Hace referencia al evento de aviso para un aviso de operador. Esta propiedad permite asignar
los valores de otras propiedades a un determinado aviso de operador.
Acceso en runtime: lectura y escritura
Sintaxis
Object.OperatorMessageIndex[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
Int32
Valor Explicación
0 Evento de aviso "Bloquear"
1 Evento de aviso "Habilitar"
2 Evento de aviso "Ocultar"
3 Evento de aviso "Mostrar"
4 Evento de aviso "Acusar"
Descripción
Define el nombre referenciado con el evento "OperatorMessageIndex" en eventos para avisos
de operador.
Acceso en runtime: lectura y escritura
Sintaxis
Object.OperatorMessageName[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
STRING
Valor Explicación
Lock El evento de aviso "Bloquear".
Unlock El evento de aviso "Habilitar".
Hide El evento de aviso "Ocultar".
Unhide El evento de aviso "Mostrar".
Quit El evento de aviso "Acusar".
Descripción
Determina un número para el aviso de operador del evento de aviso seleccionado si no se
utiliza el aviso de operador de WinCC.
Acceso en runtime: lectura y escritura
Sintaxis
Object.OperatorMessageNumber[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
Int32
Opcional. Determina un número para el aviso de operador del evento de aviso seleccionado.
Descripción
Activa los eventos de aviso en la lista en la que se habilitarán los avisos de operador.
Acceso en runtime: lectura y escritura
Sintaxis
Object.OperatorMessageSelected[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
BOOLEAN
Opcional. Activa los eventos de aviso en la lista en la que se habilitarán los avisos de operador.
Descripción
Determina un bloque de aviso para el aviso utilizado, que se añadirá al "Bloque de valor de
proceso 1" del aviso de operador configurado aquí.
Por ejemplo, si en el bloqueo de un aviso desea crear un aviso de operador. El contenido de
"Bloque de textos de usuario 1" del aviso bloqueado (p. ej., "Motor averiado") debe mostrarse
en el "Bloque de valor de proceso 1" del aviso de operador. Para ello seleccione en Valor de
proceso "1" como bloque de aviso el aviso manejado el "Bloque de textos de usuario 1".
Acceso en runtime: lectura y escritura
Sintaxis
Object.OperatorMessageSource1[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
STRING
Opcional. Determina un bloque de aviso para el aviso utilizado, que se añadirá al "Bloque de
valor de proceso 1" del aviso de operador configurado aquí.
Descripción
Determina un bloque de aviso para el aviso utilizado, que se añadirá al "Bloque de valor de
proceso 2" del aviso de operador configurado aquí.
Por ejemplo, si en el bloqueo de un aviso desea crear un aviso de operador. El contenido de
"Bloque de textos de usuario 1" del aviso bloqueado (p. ej., "Motor averiado") debe mostrarse
en el "Bloque de valor de proceso 2" del aviso de operador. Para ello seleccione en Valor de
proceso "2" como bloque de aviso el aviso manejado el "Bloque de textos de usuario 1".
Acceso en runtime: lectura y escritura
Sintaxis
Object.OperatorMessageSource2[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
STRING
Opcional. Determina un bloque de aviso para el aviso utilizado, que se añadirá al "Bloque de
valor de proceso 2" del aviso de operador configurado aquí.
Descripción
Determina un bloque de aviso para el aviso utilizado, que se añadirá al "Bloque de valor de
proceso 3" del aviso de operador configurado aquí.
Por ejemplo, si en el bloqueo de un aviso desea crear un aviso de operador. El contenido de
"Bloque de textos de usuario 1" del aviso bloqueado (p. ej., "Motor averiado") debe mostrarse
en el "Bloque de valor de proceso 3" del aviso de operador. Para ello seleccione en Valor de
proceso "3" como bloque de aviso el aviso manejado el "Bloque de textos de usuario 1".
Acceso en runtime: lectura y escritura
Sintaxis
Object.OperatorMessageSource3[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
STRING
Opcional. Determina un bloque de aviso para el aviso utilizado, que se añadirá al "Bloque de
valor de proceso 3" del aviso de operador configurado aquí.
Descripción
Determina un bloque de aviso para el aviso utilizado, que se añadirá al "Bloque de valor de
proceso 4" del aviso de operador configurado aquí.
Por ejemplo, si en el bloqueo de un aviso desea crear un aviso de operador. El contenido de
"Bloque de textos de usuario 4" del aviso bloqueado (p. ej., "Motor averiado") debe mostrarse
en el "Bloque de valor de proceso 4" del aviso de operador. Para ello seleccione en Valor de
proceso "4" como bloque de aviso el aviso manejado el "Bloque de textos de usuario 1".
Acceso en runtime: lectura y escritura
Sintaxis
Object.OperatorMessageSource4[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
STRING
Opcional. Determina un bloque de aviso para el aviso utilizado, que se añadirá al "Bloque de
valor de proceso 4" del aviso de operador configurado aquí.
Descripción
Determina un bloque de aviso para el aviso utilizado, que se añadirá al "Bloque de valor de
proceso 5" del aviso de operador configurado aquí.
Por ejemplo, si en el bloqueo de un aviso desea crear un aviso de operador. El contenido de
"Bloque de textos de usuario 1" del aviso bloqueado, p.ej. "Motor averiado", se deberá mostrar
en el "Bloque de valores de proceso 5" del aviso de operador. Para ello seleccione en Valor
de proceso "5" como bloque de aviso del aviso manejado el "Bloque de textos de usuario 1".
Acceso en runtime: lectura y escritura
Sintaxis
Object.OperatorMessageSource5[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
STRING
Opcional. Determina un bloque de aviso para el aviso utilizado, que se añadirá al "Bloque de
valor de proceso 5" del aviso de operador configurado aquí.
Descripción
Determina un bloque de aviso para el aviso utilizado, que se añadirá al "Bloque de valor de
proceso 6" del aviso de operador configurado aquí.
Por ejemplo, si en el bloqueo de un aviso desea crear un aviso de operador. El contenido de
"Bloque de textos de usuario 1" del aviso bloqueado, p.ej. "Motor averiado", se deberá mostrar
en el "Bloque de valores de proceso 6" del aviso de operador. Para ello seleccione en Valor
de proceso "6" como bloque de aviso el aviso manejado el "Bloque de textos de usuario 1".
Acceso en runtime: lectura y escritura
Sintaxis
Object.OperatorMessageSource6[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
STRING
Opcional. Determina un bloque de aviso para el aviso utilizado, que se añadirá al "Bloque de
valor de proceso 6" del aviso de operador configurado aquí.
Descripción
Determina un bloque de aviso para el aviso utilizado, que se añadirá al "Bloque de valor de
proceso 7" del aviso de operador configurado aquí.
Por ejemplo, si en el bloqueo de un aviso desea crear un aviso de operador. El contenido de
"Bloque de textos de usuario 1" del aviso bloqueado, p.ej. "Motor averiado", se deberá mostrar
en el "Bloque de valores de proceso 7" del aviso de operador. Para ello seleccione en Valor
de proceso "7" como bloque de aviso el aviso manejado el "Bloque de textos de usuario 1".
Acceso en runtime: lectura y escritura
Sintaxis
Object.OperatorMessageSource7[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
STRING
Opcional. Determina un bloque de aviso para el aviso utilizado, que se añadirá al "Bloque de
valor de proceso 7" del aviso de operador configurado aquí.
Descripción
Determina un bloque de aviso para el aviso utilizado, que se añadirá al "Bloque de valor de
proceso 8" del aviso de operador configurado aquí.
Por ejemplo, si en el bloqueo de un aviso desea crear un aviso de operador. El contenido de
"Bloque de textos de usuario 1" del aviso bloqueado, p.ej. "Motor averiado", se deberá mostrar
en el "Bloque de valores de proceso 8" del aviso de operador. Para ello seleccione en Valor
de proceso "8" como bloque de aviso el aviso manejado el "Bloque de textos de usuario 1".
Acceso en runtime: lectura y escritura
Sintaxis
Object.OperatorMessageSource8[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
STRING
Opcional. Determina un bloque de aviso para el aviso utilizado, que se añadirá al "Bloque de
valor de proceso 8" del aviso de operador configurado aquí.
Descripción
Determina un bloque de aviso para el aviso utilizado, que se añadirá al "Bloque de valor de
proceso 9" del aviso de operador configurado aquí.
Por ejemplo, si en el bloqueo de un aviso desea crear un aviso de operador. El contenido de
"Bloque de textos de usuario 1" del aviso bloqueado, p.ej. "Motor averiado", se deberá mostrar
en el "Bloque de valores de proceso 9" del aviso de operador. Para ello seleccione en Valor
de proceso "9" como bloque de aviso el aviso manejado el "Bloque de textos de usuario 1".
Acceso en runtime: lectura y escritura
Sintaxis
Object.OperatorMessageSource9[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
STRING
Opcional. Determina un bloque de aviso para el aviso utilizado, que se añadirá al "Bloque de
valor de proceso 9" del aviso de operador configurado aquí.
Descripción
Determina un bloque de aviso para el aviso utilizado, que se añadirá al "Bloque de valor de
proceso 10" del aviso de operador configurado aquí.
Por ejemplo, si en el bloqueo de un aviso desea crear un aviso de operador. El contenido de
"Bloque de textos de usuario 1" del aviso bloqueado, p.ej. "Motor averiado", se deberá mostrar
en el "Bloque de valores de proceso 10" del aviso de operador. Para ello seleccione en Valor
de proceso "10" como bloque de aviso el aviso manejado el "Bloque de textos de usuario 1".
Acceso en runtime: lectura y escritura
Sintaxis
Object.OperatorMessageSource10[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
STRING
Determina un bloque de aviso para el aviso utilizado, que se añadirá al "Bloque de valor de
proceso 10" del aviso de operador configurado aquí.
Descripción
Define en qué formato se transferirá el contenido del origen.
Sintaxis
Object.OperatorMessageType1[=Type]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
Type
Consulte también
AlarmControl (Página 1338)
Descripción
Define en qué formato se transferirá el contenido del origen.
Sintaxis
Object.OperatorMessageType2[=Type]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
Type
Consulte también
AlarmControl (Página 1338)
Descripción
Define en qué formato se transferirá el contenido del origen.
Sintaxis
Object.OperatorMessageType1[=Type]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
Type
Consulte también
AlarmControl (Página 1338)
Descripción
Define en qué formato se transferirá el contenido del origen.
Sintaxis
Object.OperatorMessageType4[=Type]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
Type
Consulte también
AlarmControl (Página 1338)
Descripción
Define en qué formato se transferirá el contenido del origen.
Sintaxis
Object.OperatorMessageType5[=Type]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
Type
Consulte también
AlarmControl (Página 1338)
Descripción
Define en qué formato se transferirá el contenido del origen.
Sintaxis
Object.OperatorMessageType6[=Type]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
Type
Consulte también
AlarmControl (Página 1338)
Descripción
Define en qué formato se transferirá el contenido del origen.
Sintaxis
Object.OperatorMessageType7[=Type]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
Type
Consulte también
AlarmControl (Página 1338)
Descripción
Define en qué formato se transferirá el contenido del origen.
Sintaxis
Object.OperatorMessageType8[=Type]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
Type
Consulte también
AlarmControl (Página 1338)
Descripción
Define en qué formato se transferirá el contenido del origen.
Sintaxis
Object.OperatorMessageType9[=Type]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
Type
Consulte también
AlarmControl (Página 1338)
Descripción
Define en qué formato se transferirá el contenido del origen.
Sintaxis
Object.OperatorMessageType10[=Type]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
Type
Consulte también
AlarmControl (Página 1338)
Descripción
Determina si el paso de página es posible en la lista de ficheros a largo plazo. De esta forma
se pueden mostrar todos los avisos del archivo cíclico en la lista de archivos a largo plazo por
páginas. Con la propiedad "PageModeMessageNumber" se determina el número de avisos
que se mostrarán por página.
Si el paso de página está activo se podrán utilizar los botones para pasar página de la barra
de herramientas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.PageMode[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
BOOLEAN
TRUE: es posible pasar página en la lista de ficheros a largo plazo.
FALSE: no es posible pasar página en la lista de ficheros a largo plazo.
Descripción
Define la cantidad de avisos que se mostrarán por página cuando se pase de página en la
lista de ficheros a largo plazo.
Acceso en runtime: lectura y escritura
Sintaxis
Object.PageModeMessageNumber[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
Int32
Opcional. Valor o constante que establece el número de avisos por página.
Descripción
Devuelve como STRING la ruta del proyecto actual sin el nombre del archivo. En un cliente
WinCC sin proyecto propio se devuelve la ruta en formato UNC, sino la ruta local.
Acceso en runtime: lectura
Sintaxis
Object.Path
Object
Obligatorio. Un objeto del tipo "Project".
Ejemplo
El siguiente ejemplo muestra la ruta del proyecto como Trace:
'VBS161
HMIRuntime.Trace "Path: " & HMIRuntime.ActiveProject.Path & vbNewLine
Consulte también
Project (Página 1319)
Descripción
Determina la contraseña para configurar el control remoto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Password[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● SmartClientView
STRING
Opcional. Valor o constante que contiene la contraseña para configurar la vigilancia remota.
Descripción
Determina la alineación dentro del objeto indicado.
Descripción
Determina la imagen que se muestra en el objeto gráfico en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Picture[=Image]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● GraphicView
● Clock
Image
Opcional. Un valor o una constante que determina la imagen que se muestra en el objeto
gráfico en runtime.
Observaciones
La imagen (*.BMP o *.DIB) debe encontrarse en la carpeta "GraCS" del proyecto actual, para
que pueda ser insertada.
Descripción
Define el modo de representación de la imagen de fondo en el sinóptico de proceso.
Acceso en runtime: lectura y escritura
Sintaxis
Object.PictureAlignment[=PictureAlignment]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Button
● RoundButton
PictureAlignment
Opcional. Valor o constante que determina el modo de representación de la imagen de fondo
en el sinóptico de proceso.
Descripción
Determina el gráfico que se muestra en el estado "Desactivado".
Acceso en runtime: lectura y escritura
Sintaxis
Object.PictureDeactivated[=Image]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Roundbutton
Image
Opcional. Un valor o una constante que determina el gráfico que se mostrará en el estado
"Desactivado".
Observaciones
El gráfico debe encontrarse en la carpeta "GraCS" del proyecto actual para insertarlo.
Descripción
Determina el gráfico que se mostrará en el estado "Off".
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura y escritura
Sintaxis
Object.PictureOff[=HmiObjectHandle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Button
● GraphicIOField
● RoundButton
Con la siguiente apariencia no se tiene acceso en runtime:
● Switch
HmiObjectHandle
Opcional. Un valor o una constante que determina el gráfico que se mostrará en el estado
"Off".
Observaciones
Para poder incorporar el gráfico (*.BMP o *.DIB), este debe encontrarse en la carpeta "GraCS"
del proyecto actual.
Descripción
Establece la imagen que se muestra en el estado "On".
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura y escritura
Sintaxis
Object.PictureOn[=HmiObjectHandle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Button
● GraphicIOField
● RoundButton
Con la siguiente apariencia no se tiene acceso en runtime:
● Switch
HmiObjectHandle
Opcional. Valor o constante que establece la imagen que se muestra en el estado "On".
Observaciones
Para poder incorporar la imagen (*.BMP o *.DIB), esta debe encontrarse en la carpeta "GraCS"
del proyecto actual.
Descripción
Define el color de la aguja en el objeto "Gauge".
Acceso en runtime: lectura y escritura
Sintaxis
Object.PointerColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
Color
Opcional. Valor o constante que determina el color de la aguja.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Determina el número de vértices de la polilínea o del polígono.
Acceso en runtime: lectura y escritura
Sintaxis
Object.PointsCount[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Polygon
● Polyline
● Tubepolyline
Con la siguiente apariencia no se tiene acceso en runtime:
● Line
Int32
Opcional. Un valor o una constante que determina el número de vértices de la polilínea.
Descripción
Determina el número de decimales (de 0 a 20).
Acceso en runtime: lectura y escritura
Sintaxis
Object.Precision[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
Int32
Opcional. Un valor o una constante que determina el número de decimales (de 0 a 20).
Descripción
Determina si el objeto indicado se representa pulsado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Pressed[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Button
● RoundButton
BOOLEAN
Opcional. TRUE si el objeto indicado se representa pulsado.
Descripción
Determina el ajuste predeterminado para el valor que debe mostrarse.
En runtime se utiliza este valor si al iniciar la imagen no está conectada o actualizada la
variable asociada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ProcessValue[=DOUBLE | Int32 | Object | SINGLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
● Gauge
● GraphicIOField
● IOField
● OptionGroup
● Slider
● SymbolicIOField
● WindowsSlider
Con la siguiente apariencia no se tiene acceso en runtime:
● Button
● CheckBox
● DateTimeField
● Switch
● SymbolLibrary
Observaciones
Si se quieren asignar SmartTags a la propiedad "ProcessValue", debe formular la asignación
del siguiente modo:
'Ejemplos para la asignación de SmartTags
'Example 1
IOField.ProcessValue = SmartTags("TagName").Value
'Example 2
HmiRuntime.Screens("Screen_1").ScreenItems("IOField_1").ProcessValue =
SmartTags("Tag_1").Value
Descripción
En controles de otros fabricantes que no son WinCC se retornará como tipo la ProgID
independiente de la versión.
Consulte también
ForeignControl (Página 1393)
Descripción
Devuelve como SHORT la medida para la calidad de un valor de variable tras la lectura de la
variable. Después de que se escribe una variable, el valor no tendrá validez.
Acceso en runtime: lectura
Sintaxis
Object.QualityCode
Object
Obligatorio. Un objeto del tipo "HMIRuntime".
Ejemplo
El siguiente ejemplo edita la calidad del valor leído cuando no se ha presentado ningún error
durante la lectura:
'VBS83
Dim objTag
Dim lngLastErr
Set objTag = HMIRuntime.Tags("Tag1")
objTag.Read
lngLastErr = objTag.LastError
If 0 = lngLastErr Then
MsgBox objTag.QualityCode
End If
Consulte también
Tag (Página 1332)
Descripción
Determina el radio del objeto "Circle" indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Radius[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Circle
● CircleSegment
● CircularArc
● RoundButton
Int32
Opcional. Valor o constante que determina el radio (en píxeles).
Descripción
Determina el eje menor del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.RadiusHeight[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Ellipse
● EllipseSegment
● EllipticalArc
● TubeArcObject
Con la siguiente apariencia no tiene acceso en runtime:
● Circle
Int32
Opcional. Valor o constante que determina el eje menor (en píxeles).
Descripción
Determina el eje mayor del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.RadiusWidth[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Ellipse
● EllipseSegment
● EllipticalArc
● TubeArcObject
Int32
Opcional. Valor o constante que determina el eje mayor (en píxeles).
Descripción
Retorna el nombre de la receta que se muestra en ese momento en el "Visor de recetas".
Acceso en runtime: lectura
Sintaxis
Object.RecipeName[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● RecipeView
STRING
Opcional. Valor o constante que devuelve el nombre de la receta.
Descripción
Devuelve el número de la receta que aparece en ese momento en el "Visor de recetas".
Acceso en runtime: lectura
Sintaxis
Object.RecipeNumber[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● RecipeView
Int32
Opcional. Valor o constante que devuelve el número de la receta.
Descripción
Devuelve el nombre del registro de receta que aparece en ese momento en el "Visor de
recetas".
Acceso en runtime: lectura
Sintaxis
Object.RecordName[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● RecipeView
STRING
Opcional. Valor o constante que devuelve el nombre del registro de receta.
Descripción
Devuelve el número del registro de receta que aparece en ese momento en el "Visor de
recetas".
Acceso en runtime: lectura
Sintaxis
Object.RecordNumber[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● RecipeView
Int32
Opcional. Valor o constante que devuelve el número del registro de receta.
Descripción
Determina el porcentaje con el que se rellena el objeto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.RelativeFillLevel[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Button
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicView
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● TextField
● WindowsSlider
Con la siguiente apariencia no se tiene acceso en runtime:
● CheckBox
Int32
Opcional. Un valor o una constante que determina el porcentaje con el que se rellena el objeto.
Descripción
Determina el ángulo de giro del objeto indicado en grados. El ángulo de giro se mide en sentido
contrario a las agujas del reloj.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Rotation[=SymbolLibraryRotation]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● SymbolLibrary
SymbolLibraryRotation
hmiSymbolLibraryRotationNone (0): el objeto gira 0 grados.
hmiSymbolLibraryRotation90Degree (90): el objeto gira 90 grados.
hmiSymbolLibraryRotation180Degree (180): el objeto gira 180 grados.
hmiSymbolLibraryRotation270Degree (270): el objeto gira 270 grados.
Descripción
Determina el ángulo de rotación en grados.
Acceso en runtime: lectura y escritura
Sintaxis
Object.RotationAngle[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Line
● Polygon
● Polyline
● TextField
● TubeTeeObject
Int32
Opcional. Un valor o una constante que determina el ángulo de rotación en grados.
Observaciones
El objeto gira en runtime en el sentido de las agujas del reloj en torno al punto de referencia.
Descripción
Determina la coordenada X del punto de giro alrededor del cual gira el objeto en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.RotationCenterLeft[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Line
● Polygon
● Polyline
● TextField
Int32
Opcional. Un valor o una constante que determina la coordenada X del punto de giro alrededor
del cual gira el objeto en runtime.
Observaciones
El valor de la coordenada X es relativo a la anchura del objeto. Indique el valor en porcentaje
partiendo del borde izquierdo del rectángulo que abarca el objeto.
Descripción
Determina la coordenada Y del punto de giro alrededor del cual gira el objeto en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.RotationCenterTop[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Line
● Polygon
● Polyline
● TextField
Int32
Opcional. Un valor o una constante que determina la coordenada Y del punto de giro alrededor
del cual gira el objeto en runtime.
Observaciones
El valor de la coordenada Y es relativo a la anchura del objeto. Indique el valor en porcentaje
partiendo del borde superior del rectángulo que abarca el objeto.
Descripción
Define el radio angular. Introduzca el valor en porcentaje respecto a la media altura del objeto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.RoundCornerHeight[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Rectangle
Int32
Opcional. Valor o constante que determina el radio angular.
Descripción
Define el radio angular. Introduzca el valor en porcentaje respecto a la media anchura del
objeto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.RoundCornerWidth[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Rectangle
Int32
Opcional. Valor o constante que determina el radio angular.
Descripción
determina si las barras de desplazamiento de filas se deben visualizar.
Acceso en runtime: lectura y escritura
Sintaxis
Object.RowScrollbar[=ScrollbarVisibility]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
ScrollbarVisibility
Descripción
Determina cómo se alinearán los títulos de fila.
Los siguientes ajustes son seleccionables:
Consulte también
AlarmControl (Página 1338)
Descripción
Establece cómo se conservarán las configuraciones online de WinCC.
Acceso en runtime: lectura y escritura
Sintaxis
Object.RTPersistence[=RTPersistence]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
Con la siguiente apariencia no se tiene acceso en runtime:
● SysDiagControl
● UserView
RTPersistence
Descripción
Establece cómo se conservarán las configuraciones online de WinCC.
Sintaxis
Object.RTPersistenceType[=RTPersistenceType]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
Con la siguiente apariencia no se tiene acceso en runtime:
● SysDiagControl
● UserView
RTPersistenceType
Descripción
Define el color de la gradación de la escala (línea auxiliar) en la rotulación del eje del objeto
"OnlineTrendControl".
Acceso en runtime: lectura y escritura
Sintaxis
Object.RulerColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● TrendView
Color
Opcional. Valor o constante que determina el color de la gradación de la escala.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Define el color de la escala del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ScaleColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● TrendView
● Bar
Color
Opcional. Valor o constante que determina el color de la escala.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Objeto "ScreenItem" con la apariencia "Bar": para que se muestre el color, la propiedad
"ShowScale" debe estar configurada con TRUE.
Descripción
Define la distancia entre dos marcas grandes de la escala.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ScaleGradation[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
DOUBLE
Opcional. Valor o constante que determina la distancia entre dos marcas grandes de la escala.
Descripción
Define el color de la rotulación en la gradación de la escala del objeto "Gauge".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ScaleLabelColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
Color
Opcional. Valor o constante que determina el color de la rotulación en la gradación de la escala.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Ningún acceso en runtime.
Descripción
Determina la posición de la escala del objeto indicado. La propiedad "ShowScale" debe estar
fijada en TRUE para que se muestre la escala.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ScalePosition[=ScalePosition]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
Con la siguiente apariencia no se tiene acceso en runtime:
● Slider
ScalePosition
hmiScalePositionLeftUp (0): para una barra vertical la escala se muestra arriba. Para una
barra horizontal la escala se muestra a la izquierda.
hmiScalePositionRightDown (1): para una barra vertical la escala se muestra abajo. Para una
barra horizontal la escala se muestra a la derecha.
Descripción
Define el color de la gradación de la escala del objeto "Gauge".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ScaleTickColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
Gauge
Color
Opcional. Valor o constante que determina el color de la gradación de la escala.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina el diámetro del círculo imaginario en el que se encuentra la rotulación de la división
de la escala.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ScaleTickLabelPosition[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
DOUBLE
Opcional. Un valor o una constante que determina el diámetro del círculo imaginario en el que
se encuentra la rotulación de la división de la escala.
Rango de valores de 0 a 1
0: la rotulación se encuentra en el centro del cuadrante.
1: el diámetro del círculo imaginario para la rotulación es el valor menor de las propiedades
de geometría "Width" y "Height". Por tanto, una parte de la rotulación puede encontrarse fuera
de la delimitación del objeto y, en consecuencia, ser invisible.
Descripción
Determina la anchura de las divisiones principales de la escala. El valor remite a la mitad del
valor inferior de las propiedades geométricas "Width" y "Height".
La anchura de las marcas para la graduación precisa es 0,5 * ancho de escala.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ScaleTickLength[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
DOUBLE
Opcional. Valor o constante que determina la anchura de las divisiones principales de la escala.
Rango de valores de 0 al fondo de escala.
0: No existe ninguna graduación de la escala. Tampoco es visible la división de la escala en
rangos.
Fondo de escala: la graduación de la escala va desde el punto central del cuadrante hasta el
fondo de escala establecido.
Descripción
Determina el diámetro del círculo imaginario en el que se encuentra la división de la escala.
Las marcas principales de la división de la escala se encuentran en este círculo con sus
extremos orientados hacia fuera.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ScaleTickPosition[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
DOUBLE
Opcional. Un valor o una constante que determina el diámetro del círculo imaginario en el que
se encuentra la división de la escala.
Rango de valores de 0 a 1
0: la división de la escala se encuentra en el centro del cuadrante.
1: el diámetro del círculo imaginario para la división de la escala es el valor menor de las
propiedades de geometría "Width" y "Height".
Descripción
Define el contador para la escala en el cliente.
Sintaxis
Object.ScaleDenominator=[Int]
Object
Necesario. Un objeto del tipo "ScreenItem" con la especificación "SmartClientView".
Int
Opcional. Valor o constante que determina el valor.
Consulte también
SmartClientView (Página 1484)
Descripción
Ningún acceso en runtime.
Descripción
Establece el tipo de escala de barras.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ScalingType[=BarScalingType]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BarScalingType
Opcional. Valor o constante que establece el tipo de escala de barras.
● hmiBarScalingLinear (0): lineal
Las marcas grandes están distribuidas uniformemente por la escala. La distancia entre las
marcas grandes corresponde al valor del atributo "Sección del eje".
● hmiBarScalingLogarithmic (1): logarítmico
La distribución de las marcas grandes en la escala responde a una función logarítmica.
Se acentúa considerablemente la representación de los valores bajos.
Observaciones
Para que se muestre el color, la propiedad "ShowScale" debe tener el valor TRUE.
Consulte también
Bar (Página 1353)
Descripción
Devuelve la lista de ScreenItems.
Acceso en runtime: lectura
Sintaxis
Object.ScreenItems
Object
Obligatorio. Objeto del tipo "ScreenItems"..
Descripción
Determina la imagen que se muestra en la ventana de imagen en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ScreenName[=HmiObjectHandle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● ScreenWindow
HmiObjectHandle
Opcional. Valor o constante que determina la imagen que se muestra en la ventana de imagen
en runtime.
Descripción
Devuelve la lista de Screens. La lista de Screens contiene dos elementos, a saber: El primer
elemento (índice 0) representa la ventana permanente. El segundo elemento (índice 1)
representa la imagen raíz. Estos dos elementos se pueden direccionar también a través de
sus nombres. Utilice "Overview" para la ventana permanente y "Base" para la imagen raíz.
Nota
La ventana de avisos y el indicador de avisos no están contenidos en la lista Screens, aunque
estén marcados en runtime.
Acceso en runtime: lectura
Sintaxis
Object.Screens
Object
Obligatorio. Objeto del tipo "Screens".
Descripción
Define la longitud del segundero en el objeto "Clock".
Acceso en runtime: lectura y escritura
Sintaxis
Object.SecondNeedleHeight[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Clock
Int32
Opcional. Valor o constante que determina la longitud del segundero.
Indique la longitud del segundero en tantos por ciento, en relación al radio de la esfera.
Descripción
Define el ancho del segundero en el objeto "Clock".
Acceso en runtime: lectura y escritura
Sintaxis
Object.SecondNeedleWidth[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Clock
Int32
Opcional. Valor o constante que determina el ancho del segundero. Indique el ancho en tantos
por ciento, en relación a la longitud doble del segundero.
Descripción
Define el tipo de cambio de color con el que se visualiza el rebase por exceso de valores límite
en el objeto "Bar".
Acceso en runtime: lectura y escritura
Sintaxis
Object.SegmentColoring[=THmiBarColorType]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
THmiBarColorType
Opcional. Valor o constante que determina el tipo de cambio de color. Rango de valores de
0 a 1.
hmiBarColorEntire (0): el color se cambia en la barra entera.
hmiBarColorSegmented (1): el color se cambia por segmentos.
Descripción
Muestra el texto que, fijado con el atributo "Campo seleccionado" (SelIndex), aparecerá
resaltado en el Campo de combinación o en el Campo de lista.
Consulte también
Listbox (Página 1424)
Descripción
Determina el color de fondo de la entrada de texto seleccionada del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SelectBackColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● SymbolicIOField
Color
Opcional. Un valor o una constante que determina el color de fondo de la entrada de texto
seleccionada del objeto indicado.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina el color de fondo de la celda seleccionada. Con el botón se abre el cuadro de
diálogo para la selección de color.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SelectedCellColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
Color
Opcional. Valor o constante que establece el color de fondo.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina el color de fuente de la celda seleccionada. Con el botón se abre el cuadro de
diálogo para la selección de color.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SelectedCellForeColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
Color
Opcional. Valor o constante que establece el color de fuente.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Define el índice cuyo texto correspondiente se muestra resaltado en el cuadro combinado o
el cuadro de lista.
El valor máximo es el número de líneas (NumberLines) del objeto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SelectedIndex[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● ComboBox
● ListBox
Int32
Opcional. Valor o constante que determina el índice del texto resaltado.
Descripción
Determina el color de fondo de la fila seleccionada. Con el botón se abre el cuadro de diálogo
para la selección de color.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SelectedRowColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
Color
Opcional. Valor o constante que establece el color de fondo.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina el color de fuente de la fila seleccionada. Con el botón se abre el cuadro de diálogo
para la selección de color.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SelectedRowForeColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
Color
Opcional. Valor o constante que establece el color de fuente.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina el color de fondo del título de tabla seleccionado. Con el botón se abre el cuadro
de diálogo para la selección de color.
La configuración solamente será efectiva en runtime si la opción "Color de selección" está
activa.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SelectedTitleColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
Color
Opcional. Valor o constante que establece el fondo.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina el color de fuente del título de tabla seleccionado. Con el botón se abre el cuadro
de diálogo para la selección de color.
La configuración solamente será efectiva en runtime si la opción "Color de selección" está
activa.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SelectedTitleForeColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
Color
Opcional. Valor o constante que establece el color de fuente.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Consulte también
UserArchiveControl (Página 1528)
TrendRulerControl (Página 1508)
Descripción
Determina el color de la entrada de texto seleccionada del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SelectForeColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● SymbolicIOField
Color
Opcional. Un valor o una constante que determina el color de la entrada de texto seleccionada
del objeto indicado.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina el color de fondo de las celdas seleccionadas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SelectionBackColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmView
● RecipeView
● StatusForce
● UserView
Con la siguiente apariencia no se tiene acceso en runtime:
● TrendView
Color
Opcional. Valor o constante que determina el color de fondo de la fila seleccionada.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Determina si el color de selección se utilizarán para celdas o filas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SelectionColoring[=GridSelectionColoring]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
GridSelectionColoring
Descripción
Determina el color de primer plano de las celdas seleccionadas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SelectionForeColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmView
● RecipeView
● StatusForce
● UserView
Con la siguiente apariencia no se tiene acceso en runtime:
● TrendView
Color
Opcional. Valor o constante que determina el color de fondo de la fila seleccionada.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Determina si se utilizará un borde selección para las celdas o filas seleccionadas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SelectionRect[=GridSelectionBorder]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
GridSelectionBorder
Descripción
Define el color del rectángulo de selección en la ventana de avisos cuando SelectionType es
"1".
Acceso en runtime: lectura y escritura
Sintaxis
Object.SelectionRectColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
Color
Opcional. Valor o constante que establece el color.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Establece el grosor de la línea del rectángulo de selección en la ventana de avisos cuando
SelectionType sea "1".
Acceso en runtime: lectura y escritura
Sintaxis
Object.SelectionRectWidth[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
Int32
Opcional. Valor o constante que establece el grosor de la línea.
Descripción
Determina cuántas líneas pueden seleccionarse.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SelectionType[=GridSelectionType]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
GridSelectionType
Opcional. Valor o constante que establece el número de líneas que pueden seleccionarse.
Están disponibles los siguientes ajustes:
Descripción
Determina el color de fondo de las líneas de separación quebradas en la lista de selección
del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SeparatorBackColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● SymbolicIOField
Color
Opcional. Un valor o una constante que determina el color de fondo de las líneas de separación
quebradas en la lista de selección del objeto indicado.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina el color de las líneas de separación en la lista de selección del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SeparatorColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● SymbolicIOField
Con la siguiente apariencia no se tiene acceso en runtime:
● S7GraphOverview
Color
Opcional. Un valor o una constante que determina el color de las líneas de separación en la
lista de selección del objeto indicado.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Ningún acceso en runtime
Descripción
Establece el tipo de las líneas de separación en la lista de selección del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SeparatorStyle[=LineStyle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● SymbolicIOField
LineStyle
hmiLineStyleNone (-1): la lista de selección no tiene líneas de separación.
hmiLineStyleSolid (0): la lista de selección tiene líneas de separación continuas.
hmiLineStyleDash (1): la lista de selección tiene líneas de separación discontinuas.
hmiLineStyleDot (2): la lista de selección tiene líneas de separación de puntos.
hmiLineStyleDashDot (3): la lista de selección tiene líneas de separación punto raya.
hmiLineStyleDashDotDot (4): la lista de selección tiene líneas de separación punto punto raya.
Descripción
Determina el ancho de las líneas de separación en la lista de selección del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SeparatorWidth[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● SymbolicIOField
Int32
Opcional. Un valor o una constante que determina el ancho de las líneas de separación en la
lista de selección del objeto indicado.
Descripción
Define la forma de los finales de línea para el objeto del tipo "ScreenItem" con la especificación
"SymbolicIOField".
Consulte también
SymbolicIOField (Página 1491)
Descripción
Ningún acceso en runtime.
Descripción
Establece los servidores de un sistema distribuido de los que recibe datos el visor de avisos.
Se indica de esta forma: NameServer1;NameServer2;NameServer3.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ServerNames[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
STRING
Opcional. Valor o constante que establece los servidores de un sistema distribuido de los que
recibe datos la ventana de avisos.
Descripción
Ningún acceso en runtime
Descripción
Ningún acceso en runtime.
Descripción
Determina que el campo "Desplazar punto decimal" sea de sólo lectura.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShiftDecimalPoint[=BOOLEAN]
Object
Necesario. Un objeto del tipo "ScreenItem" con la especificación "IOField".
BOOLEAN
Opcional. TRUE si el campo "Desplazar punto decimal" es de sólo lectura.
Consulte también
IOField (Página 1418)
Descripción
Establece que solo se muestren los eventos de aviso que estén guardados en esa variable.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowAlarmsFromDate[=HmiObjectHandle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmView
HmiObjectHandle
Opcional. Valor o constante que establece que solo se muestren los eventos de aviso que
estén guardados en esa variable.
Descripción
Determina si el objeto debe mostrarse atenuado cuando el QualityCode o el estado de la
variable no sea bueno.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowBadTagState[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
● IOField
● OptionGroup
● SymbolicIOField
● WindowsSlider
Con las siguientes apariencias no se tiene acceso en runtime:
● CheckBox
BOOLEAN
Descripción
Determina si el valor de proceso visualizado en el objeto "Slider" se muestra adicionalmente
con una barra llena.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowBar[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Slider
BOOLEAN
Opcional. TRUE si el valor de proceso debe mostrarse adicionalmente con una barra llena.
Descripción
Determina si la barra de título se muestra u oculta.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowCaption[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● ApplicationWindow
● Screenwindow
Con la siguiente apariencia no se tiene acceso en runtime:
● Switch
BOOLEAN
Opcional. TRUE si la barra de título se muestra.
Descripción
Determina si la escala con números decimales (punto decimal y un decimal) se rotula con
números enteros.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowDecimalPoint[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
BOOLEAN
Opcional. TRUE si la escala con números decimales (punto decimal y un decimal) se rotula.
Descripción
Determina si el objeto indicado se rellena.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowFillLevel[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Button
● Circle
● CircleSegment
● Ellipse
● EllipseSegment
● GraphicView
● OptionGroup
● Polygon
● Rectangle
● RoundButton
● TextField
● WindowsSlider
Con la siguiente apariencia no se tiene acceso en runtime:
● CheckBox
BOOLEAN
Opcional. TRUE si el objeto indicado se rellena.
Descripción
Determina si el botón tendrá un borde de selección en runtime cuando se active.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowFocusRectangle[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Clock
BOOLEAN
Opcional. TRUE si en runtime el botón recibe un borde de selección cuando se activa.
Descripción
Determina si han de representarse solo las marcas grandes de la escala.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowLargeTicksOnly[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional. TRUE si se representan solo las marcas grandes de la escala.
Descripción
Determina si los valores límite se muestran como valor de escala.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowLimitMarkers[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
BOOLEAN
Opcional. TRUE si los valores límite se muestran como valor de escala.
Descripción
Determina si para el objeto indicado se utiliza una aguja de máximo/mínimo.
La aguja de máximo/mínimo indica en runtime la desviación de agua máxima mientras está
cargado el sinóptico del proceso. Si se recarga el sinóptico del proceso se resetea la aguja
de máximo/mínimo.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowPeakValuePointer[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
BOOLEAN
Opcional. TRUE si se utiliza la aguja de máximo/mínimo.
Descripción
Determina si el valor de la posición actual del regulador debe mostrarse adicionalmente en
formato numérico. En este caso, el valor se visualizará debajo del regulador.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowPosition[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Slider
BOOLEAN
Opcional. TRUE si el valor debe mostrarse adicionalmente en formato numérico.
Descripción
Determina si el visor de avisos contiene una columna con una numeración correlativa de los
avisos pendientes.
Acceso en runtime: lectura y escritura
Sintaxis
Object.RowTitles[=BOOLEAN]
Object
Necesario. Objeto del tipo "ScreenItem" con la especificación "AlarmControl".
BOOLEAN
Opcional. TRUE si el visor de avisos contiene una columna con una numeración correlativa
de los avisos pendientes.
Consulte también
AlarmControl (Página 1338)
Descripción
Determina si se muestra una escala graduada (línea auxiliar) para la rotulación de eje del
objeto "OnlineTrendControl".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowRuler[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
● TrendView
BOOLEAN
Opcional. TRUE si se muestra la escala graduada.
Descripción
Determina si la regla se mostrará también en el eje de tiempos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowRulerInAxis[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
BOOLEAN
TRUE: las reglas se mostrarán también en los ejes de tiempo.
FALSE: las reglas no se mostrarán en los ejes de tiempo.
Descripción
Determina si los valores se muestran adicionalmente en una escala.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowScale[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
Con la siguiente apariencia no se tiene acceso en runtime:
● Slider
BOOLEAN
Opcional. TRUE si los valores se muestran adicionalmente en una escala.
Descripción
Determina si se deben visualizar las barras de desplazamiento.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowScrollbars[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● FunctionTrendControl
● OnlineTrendControl
● Screenwindow
ShowScrollbars
Opcional. TRUE si se muestran barras de desplazamiento.
Descripción
Determina si se mostrará la tecla de clasificación en la barra de desplazamiento. Mediante la
tecla de clasificación podrá clasificar mediante un clic del ratón la columna seleccionada en
la secuencia de clasificación configurada. Si en la tabla no hay ninguna barra de
desplazamiento, no se mostrará la tecla de clasificación.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowSortButton[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: la tecla de clasificación se muestra. Puede clasificar la columna seleccionada.
Descripción
Determina si se debe mostrar el símbolo de clasificación.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowSortIcon[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: el símbolo de clasificación se muestra.
FALSE: el símbolo de clasificación no se muestra.
Descripción
Determina si se mostrará un índice de clasificación.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowSortIndex[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: se mostrará un índice de clasificación.
FALSE: no se mostrará un índice de clasificación.
Descripción
Determina si se muestra la barra de estado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowStatusBar[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● HTML-Browser
Con la siguiente apariencia no se tiene acceso en runtime:
● MediaPlayer
BOOLEAN
Opcional. TRUE si se muestra la barra de estado.
Descripción
Determina si en la tabla del objeto indicado se deben mostrar líneas de retícula.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowTableGridlines[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● StatusForce
Con la siguiente apariencia no se tiene acceso en runtime:
● TrendView
● UserView
BOOLEAN
Opcional. TRUE si se muestran líneas de retícula en la tabla.
Descripción
Determina si debe mostrarse el deslizador del objeto "Slider".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowThumb[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Slider
BOOLEAN
Opcional. TRUE si debe mostrarse el deslizador.
Descripción
Determina si debe mostrarse la rotulación en la escala.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowTickLabels[= BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Slider
Con la siguiente apariencia no se tiene acceso en runtime:
● Bar
BOOLEAN
Opcional. TRUE si debe mostrarse la rotulación.
Observaciones
El incremento de los valores de medida se determina automáticamente en función del rango
de medición indicado y del tamaño del objeto.
Descripción
Determina si deben mostrarse las marcas en la escala del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowTicks[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Clock
● Slider
BOOLEAN
Opcional. TRUE si deben mostrarse las marcas.
Descripción
Determina el título de la ventana del control.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowTitle[=WindowHeaderStyle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
WindowHeaderStyle
Descripción
Determina si se muestra una barra de herramientas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowToolBar[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● HTMLBrowser
BOOLEAN
Opcional. TRUE si se muestra una barra de herramientas.
Descripción
Determina si debajo de los ejes de valores se mostrará un símbolo. El símbolo muestra qué
curva se mostrará en primer plano.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowTrendIcon[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
BOOLEAN
TRUE: el símbolo se muestra.
FALSE: el símbolo no se muestra.
Descripción
Determina si la tendencia (ascendente o descendente) del valor medido que debe
supervisarse se muestra con una pequeña flecha.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowTrendIndicator[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional. TRUE si la tendencia (ascendente o descendente) del valor medido que debe
supervisarse se muestra con una pequeña flecha.
Descripción
TRUE si en Runtime se puede modificar el tamaño del objeto. Acceso de escritura y lectura
BOOLEAN.
En una ventana de aplicación y en una ventana de imagen: Sólo acceso de lectura.
Consulte también
TrendRulerControl (Página 1508)
OnlineTableControl (Página 1434)
OnlineTrendControl (Página 1443)
AlarmControl (Página 1338)
Descripción
En este campo de selección se define el estilo del control.
Acceso en runtime: escritura
Sintaxis
Object.ControlDesignMode[=RTControlModes]
Object
Necesario. Objeto del tipo "ScreenItem" con las apariencias "MessageView",
"OnlineTableControl", "OnlineTrendControl", "FunctionTrendControl", "RecipeView",
"RulerControl".
RTControlModes
Los siguientes ajustes están a disposición:
Descripción
Devuelve la lista de SmartTags.
Acceso en runtime: lectura
Sintaxis
Object.SmartTags
Object
Obligatorio. Objeto del tipo "HMIRuntime".
Descripción
Determina si el último aviso entrante se muestra arriba en el objeto "AlarmControl" (orden de
clasificación ascendente).
Sintaxis
Object.SortByTimeDirection[=SortByTimeDirection]
Object
Obligatorio. Objeto del tipo "ScreenItems" con la apariencia siguiente:
● AlarmView
SortByTimeDirection
Opcional. TRUE si el último aviso entrante se muestra arriba.
Descripción
Determina si puede modificarse la clasificación de los avisos por hora en el objeto
"AlarmView".
Acceso en runtime: lectura y escritura
Sintaxis
Object.SortByTimeEnabled[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItems" con la apariencia siguiente:
● AlarmView
BOOLEAN
Opcional. TRUE si el operador puede modificar la clasificación en el equipo.
Descripción
Determina cómo se deben puede modificar la secuencia de clasificación mediante haciendo
clic con el ratón.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SortSequence[=GridSortSequence]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveConrol
GridSortSequence
Descripción
Determina el ángulo por el cual el punto inicial del objeto indicado se desvía de la posición
cero (0º).
Acceso en runtime: lectura y escritura
Sintaxis
Object.StartAngle[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● CircleSegment
● CircularArc
● EllipseSegment
● EllipticalArc
● TubeArcObject
Int32
Opcional. Un valor o una constante que determina el ángulo por el cual el punto inicial del
objeto indicado se desvía de la posición cero (0º).
Descripción
Determina cómo se debe representar el comienzo de línea del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StartStyle[=LineEndStyle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Line
● Polyline
LineEndStyle
Opcional. Valor o constante que determina el comienzo de línea. Rango de valores de 0 a 6.
hmiLineEndStyleNone (0): la línea no tiene ningún símbolo inicial.
hmiLineEndStyleArrow (1): la línea comienza con una punta de flecha.
hmiLineEndStyleFilledArrow (2): la línea comienza con una punta de flecha rellena.
hmiLineEndStyleFilledArrowReversed (3): la línea comienza con una punta de flecha invertida.
hmiLineEndStyleLine (4): la línea comienza con una línea vertical.
hmiLineEndStyleCircle (5): la línea comienza con un círculo.
hmiLineEndStyleFilledCircle (6): la línea comienza con un círculo rellenado.
Descripción
Ningún acceso en runtime.
Descripción
Define el valor absoluto del punto cero de la visualización de la escala.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StartValue[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
DOUBLE
Opcional. Valor o constante que define el valor absoluto del punto cero de la visualización de
la escala.
Descripción
Devuelve el estado de un aviso.
La siguiente tabla muestra los estados posibles de un aviso:
Descripción
Determina el color de fondo de la barra de estado. Con el botón se abre el cuadro de diálogo
para la selección de color. Para que el ajuste tenga efecto debe activar la opción "Visualizar".
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarBackColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
Color
Opcional. Valor o constante que determina el color de fondo de la barra de estado.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Crea un nuevo elemento de la barra de estado definida por el usuario. El nombre asignado
por WinCC se puede modificar en el campo "Nombre de objeto".
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarElementAdd[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
STRING
Opcional. Valor o constante que determina un nuevo elemento definido por el usuario de la
barra de estado.
Descripción
Establece si el ancho de los elementos seleccionados de la barra se ajustará
automáticamente.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarElementAutoSize[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: el ancho del elemento seleccionado se ajustará automáticamente.
FALSE: el ancho del elemento seleccionado no se ajustará automáticamente.
Consulte también
UserArchiveControl (Página 1528)
TrendRulerControl (Página 1508)
FunctionTrendControl (Página 1397)
OnlineTableControl (Página 1434)
OnlineTrendControl (Página 1443)
AlarmControl (Página 1338)
Descripción
Determina el número de elementos configurables de la barra de estado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarElementCount[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
Int32
Opcional. Valor o constante que determina el número de elementos configurables de la barra
de estado.
Descripción
Define la asignación del número de identidad y del símbolo de un elemento de la barra de
estado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarElementIconId[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
Int32
Opcional. Valor o constante que define la asignación del número de identidad y del símbolo
de un elemento de la barra de estado.
Descripción
Define el número de identidad para el elemento seleccionado de la barra de estado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarElementID[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
Int32
Opcional. Valor o constante que define el número de identidad del elemento seleccionado de
la barra de estado.
Descripción
Define la referencia de un elemento de la barra de estado.
Los valores válidos para "StatusbarElementIndex" se encuentran entre 0 y
"StatusbarElementCount" menos 1.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarElementIndex[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
Int32
Opcional. Valor o constante que define la referencia de un elemento de la barra de estado.
Descripción
Define el nombre de objeto para el elemento seleccionado de la barra de estado.
Se puede modificar el nombre de objeto para elementos definidos por el usuario de la barra
de estado. La propiedad "StatusbarElementName" para elementos definidos por el usuario
se puede dinamizar con la propiedad "StatusbarElementRename".
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarElementName[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
STRING
Opcional. Valor o constante que define el nombre de objeto del elemento seleccionado de la
barra de estado.
Descripción
Elimina el elemento definido por el usuario seleccionado en la barra de estado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarElementRemove[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
STRING
Opcional. Valor o constante que define el nombre del elemento definido por el usuario que se
eliminará de la barra de estado.
Descripción
Modifica el nombre del elemento definido por el usuario de la barra de estado que está
referenciado mediante la propiedad "StatusbarElementIndex".
Para elementos definidos por el usuario, la propiedad se puede dinamizar con el nombre
"StatusbarElementRename". Con "StatusbarElementRename" podrá dinamizar también la
propiedad "StatusbarElementName".
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarElementRename[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
STRING
Opcional. Valor o constante que define el nuevo nombre de objeto del elemento seleccionado
de la barra de estado.
Descripción
Determina los elementos que deben representarse en la barra de estado.
Descripción
Determina el texto para el tooltip del elemento definido por el usuario seleccionado en la barra
de estado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarElementTooltipText[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
STRING
Opcional. Valor o constante que determina el texto para el tooltip del elemento definido por el
usuario seleccionado en la barra de estado.
Descripción
Determina si el elemento de la barra de estado ha sido agregado por el ingeniero como nuevo
elemento definido por el usuario.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarElementUserDefined[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: el elemento de la barra de estado ha sido definido por el usuario.
FALSE: el elemento de la barra de estado está predefinido por el sistema.
Descripción
Determina si el elemento definido por el usuario seleccionado en la barra de estado se
mostrará en runtime.
En la lista, active los elementos de la barra de estado que desee mostrar en runtime.
Haga clic sobre una entrada de la lista para adaptar las propiedades o para modificar la
posición en la fila de estado de Control con las teclas "Arriba" y "Abajo".
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarElementVisible[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: se muestra el elemento definido por el usuario seleccionado en la barra de estado.
FALSE: no se muestra el elemento definido por el usuario seleccionado en la barra de estado.
Descripción
Indica el ancho en píxeles del elemento definido por el usuario seleccionado en la barra de
estado.
Si la opción "Automático" no está activada, podrá ajustar el ancho.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarElementWidth[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
Int32
Opcional. Valor o constante que determina el ancho en píxeles del elemento definido por el
usuario seleccionado en la barra de estado.
Descripción
Define el color de fuente de los textos de la barra de estado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarFontColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
Color
Opcional. Valor o constante que define el color de los textos de la barra de estado.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Determina si en runtime se mostrarán los tooltips de los elementos de la barra de estado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarShowTooltips[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: se mostrarán los tooltips.
FALSE: no se mostrarán los tooltips.
Descripción
Define el texto estándar de la barra de estado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarText[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
STRING
Opcional. Valor o constante que define el texto estándar de la barra de estado.
Descripción
Determina si se debe visualizar el color de fondo de la barra de estado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarUseBackColor[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: se mostrará el color de fondo de la barra de estado.
FALSE: no se mostrará el color de fondo de la barra de estado.
Descripción
Determina si se debe visualizar la barra de estado del control.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarVisible[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: se mostrará la barra de estado.
FALSE: no se mostrará la barra de estado.
Descripción
Determina el estilo de línea del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Style[=LineStyle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● CircularArc
● EllipticalArc
● Line
● Polyline
LineStyle
Opcional. Un valor o una constante que determina el estilo de línea. Rango de valores de 0
a 4.
hmiLineStyleSolid (0): línea continua
hmiLineStyleDash (1): línea rayada
hmiLineStyleDot (2): línea punteada
hmiLineStyleDashDot (3): línea punto raya
hmiLineStyleDashDotDot (4): línea punto punto raya
Ajuste estándar: hmiLineStyleSolid
Descripción
Determina el estilo con el que se representa el objeto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StyleSettings[=WinCCStyle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Button
● RoundButton
● WindowsSlider
WinCCStyle
Opcional. Valor o constante que determina el estilo con el que se representa el objeto.
Descripción
Determina si el texto del objeto se representa en posición horizontal.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SwapFirstWithLastConnection[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "Connector".
BOOLEAN
Opcional. TRUE si el texto del objeto se representa en posición horizontal.
Consulte también
Connector (Página 1379)
Descripción
Determina el color de fondo de las celdas de la tabla del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TableBackColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmView
● RecipeView
● StatusForce
● TrendView
● UserView
Color
Opcional. Valor o constante que determina el color de fondo de las celdas de la tabla.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Determina el color de fondo de las filas.
Con el botón se abre el cuadro de diálogo para la selección de color.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TableColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
Color
Opcional. Valor o constante que determina el color de fondo de las filas de la tabla.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Determina el segundo color de fondo de las filas.
Con el botón se abre el cuadro de diálogo para la selección de color.
La configuración solamente será efectiva en runtime, si la opción "Color de fila 2" está activa.
Para el fondo de las filas se utilizarán alternativamente el "Color de fila 1" y el "Color de fila
2".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TableColor2[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
Color
Opcional. Valor o constante que determina el segundo color de fondo de las filas de la tabla.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Determina el color del texto en las celdas de tabla del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TableForeColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● AlarmView
● OnlineTableControl
● RecipeView
● StatusForce
● TrendRulerControl
● UserArchiveControl
● UserView
Color
Opcional. Un valor o una constante que determina el color del texto en las celdas de tabla.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina el segundo color de fuente.
Con el botón se abre el cuadro de diálogo para la selección de color.
La configuración solamente será efectiva en runtime, si la opción "Color de fila 2" está activa.
Como color de fuente se utilizarán alternativamente el "Color de fila 1" y el "Color de fila 2".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TableForeColor2[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
Color
Opcional. Valor o constante que determina el segundo color de fuente en las celdas de la tabla.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina el color de las líneas de retícula en la tabla del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TableGridLineColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● RecipeView
● TrendView
● UserView
Con la siguiente apariencia no se tiene acceso en runtime:
● StatusForce
● SysDiagControl
Color
Opcional. Valor o constante que determina el color de las líneas de retícula en la tabla.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Define el color de fondo del encabezado de la tabla del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TableHeaderBackColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmView
● RecipeView
● StatusForce
● TrendView
● UserView
Color
Opcional. Valor o constante que determina el color de fondo del encabezado.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Define el color de texto del encabezado de la tabla del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TableHeaderForeColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmView
● RecipeView
● StatusForce
● TrendView
● UserView
Color
Opcional. Valor o constante que determina el color de texto del encabezado.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Define un prefijo que se antepondrá a todas las variables que se utilicen en la imagen.
Para cada ventana de imagen puede asignarse un prefijo de variable que se antepondrá a
todas las variables que se utilicen en la imagen. De esta forma la imagen mantiene una
imagen, que está conectada a una ventana de imagen, el acceso a sus propias variables,
mientras que otra accede a otras variables.
La modificación del prefijo de variable no tendrá efecto hasta la próxima vez que se cargue
la imagen. En un cambio de imagen esto sucede automáticamente; en los demás casos,
cuando se asigne nuevamente el nombre de imagen.
El prefijo se puede definir libremente, pero debe coincidir con el nombre de las variables de
estructura.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TagPrefix[= STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Screenwindow
STRING
Opcional. Valor o constante que determina el prefijo de variable.
Ejemplo
En la ventana de imagen ha de aparecer la imagen "EntradaSalida". La imagen
"EntradaSalida" contiene tres campos E/S vinculados a una variable de estructura. La variable
de estructura se compone de los elementos EA1, EA2, EA3; un elemento para cada campo
E/S.
En el proyecto se han definido, p. ej., tres variables de estructura con los nombres de estructura
Struct1, Struct2 y Struct3.
En este caso, el prefijo de variable es el nombre de estructura seguido de punto. Si se
introduce, p. ej., "Struct2." como prefijo de variable (el punto es necesario para acceder con
la sintaxis correcta a los elementos de las variables de estructura como elementos de
estructura), los campos E/S de la imagen "EntradaSalida" se vinculan con los elementos de
las variables de estructura Struct2:
Prefijo de variable: "Struct2."
● Valor de salida (primer campo E/S): EA1
● Valor de salida (segundo campo E/S): EA2
● Valor de salida (tercer campo E/S): EA3
Por tanto, el enlace de variables actual en la ventana de imagen es
● Valor de salida (primer campo E/S): Struct2.EA1
● Valor de salida (segundo campo E/S): Struct2.EA2
● Valor de salida (tercer campo E/S): Struct2.EA3
Descripción
Devuelve el objeto del tipo "Tags".
Acceso en runtime: lectura
Sintaxis
Object.Tags
Object
Obligatorio. Un objeto del tipo "HMIRuntime".
Ejemplo
El siguiente ejemplo accede a la variable "Tag1":
'VBS86
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
Consulte también
HMIRuntime (Página 1313)
Descripción
Define la plantilla para la visualización del contenido de la ventana del objeto "Ventana de la
aplicación".
Acceso en runtime: lectura y escritura
Sintaxis
Object.Template[=TemplateType]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● ApplicationWindow
TemplateType
Opcional. Valor o constante que define la plantilla.
De acuerdo al valor de la propiedad se pueden usar los siguientes modelos:
Descripción
Determina la rotulación del campo de texto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Text[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● TextField
● CheckBox
● ComboBox
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
STRING
Opcional. Un valor o una constante que determina la rotulación.
Descripción
Devuelve un listado que contiene las asignaciones entre el valor de salida y el texto de salida
que realmente se mostrará.
Las asignaciones dependen del tipo de lista ajustado. El tipo de lista se define con la propiedad
"ListType".
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura
Sintaxis
Object.TextList[=HmiObjectHandle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● SymbolicIOField
Con las siguientes apariencias no se tiene acceso en runtime:
● Button
HmiObjectHandle
Listado que contiene las asignaciones entre el valor de salida y el texto de salida que realmente
será mostrado.
Descripción
Determina el texto que se muestra en el estado "Off" del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TextOff[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Button
● Switch
STRING
Opcional. Un valor o una constante que determina la rotulación del estado "Off".
Observaciones
La propiedad solo está disponible cuando el objeto referenciado "SymbolicIOField", "Button"
o "Switch" es del tipo "Text".
Descripción
Determina el texto que se muestra en el estado "On" del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TextOn[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Switch
Con las siguientes apariencias no se tiene acceso en runtime:
● Button
● SymbolicIOField
STRING
Opcional. Un valor o una constante que determina la rotulación para el estado "On".
Observaciones
La propiedad solo está disponible cuando el objeto referenciado "SymbolicIOField", "Button"
o "Switch" es del tipo "Text".
Descripción
Establece la dirección del texto del objeto indicado.
Acceso en runtime:
● RT Advanced: ningún acceso
● RT Professional: lectura/escritura
Sintaxis
Object.TextOrientation[=TextOrientation]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Button
● IOField
● OptionGroup
● RoundButton
● SymbolicIOField
● TextField
● WindowSlider
Con las siguientes apariencias no se tiene acceso en runtime:
● CheckBox
● DateTimeField
● Switch
TextOrientation
hmiTextHorizontal (0): el texto se muestra horizontalmente.
hmiTextRotated90Degree (-1): el texto se muestra verticalmente y alineado a la izquierda.
hmiTextRotated270Degree (1): el texto se muestra verticalmente y alineado a la derecha.
Descripción
Determina el color de fondo del regulador en el objeto "Slider".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ThumbBackColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Slider
● WindowsSlider
Color
Opcional. Un valor o una constante que determina el color de fondo del regulador.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Define el color de las marcas horarias en la esfera del objeto "Clock".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TicksColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Clock
Color
Opcional. Valor o constante que determina el color de las marcas horarias.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Determina la representación de la escala.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TickStyle[=SliderTickStyle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Slider
Con las siguientes apariencias no se tiene acceso en runtime:
● Clock
SliderTickStyle
hmiSliderTickStyleNone (0): el objeto no tiene escala.
hmiSliderTickStyleEffect1 (1): la escala está formada únicamente por graduaciones
principales. La escala es negra sobre fondo blanco.
hmiSliderTickStyleEffect2 (2): la escala está formada únicamente por graduaciones
principales. La escala es blanca sobre fondo negro.
hmiSliderTickStyleNormal (3): la escala está formada por graduaciones sencillas.
Observaciones
Debido a la escala automática es posible que en algunos puntos haya dos marcas de la escala
que se encuentren directamente una junto a la otra (parece una marca más ancha). Este
efecto se corrige alargando o acortando ligeramente el objeto deslizante.
Además también es posible suprimir completamente la representación de la escala
("WithAxes").
Descripción
Define el punto de inicio de la representación de la curva indicada. El dato se evaluará o no
dependiendo de las propiedades "UseTimeRange(i)" y "ShareTimeAxis".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeAxisBeginTime(i)[=DateTime]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTrendControl
Con la siguiente apariencia no se tiene acceso en runtime:
● TrendView
DateTime
Opcional. Valor o constante que determina el punto de inicio de la representación de la curva
indicada
Descripción
Define el instante final de la representación de la curva indicada. La indicación se evaluará o
no en función de las propiedades "Autorange", "UseTimeRange(i)" y "ShareTimeAxis".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeAxisEndTime[=DateTime]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTrendControl
DateTime
Opcional. Valor o constante que determina el instante final de la representación de la curva
indicada.
Descripción
Determina la denominación del eje de tiempo. El dato se evaluará o no dependiendo de la
propiedad "ConfigureTimeAxis(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeAxisLabel(i)[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTrendControl
STRING
Opcional. Un valor o una constante que determina la denominación del eje de tiempo.
Observaciones
El parámetro i indica el número de la curva.
Descripción
Ningún acceso en runtime.
Descripción
Define el formato de datos a lo largo del eje de tiempos de la curva especificada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeAxisTimeFormat(i)[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTrendControl
STRING
Opcional. Valor o constante que establece el formato del eje de tiempo.
Observaciones
El parámetro i indica el número de la curva.
Descripción
Define la zona horaria que sirve de base para mostrar los valores de tiempo.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeBase[=TimeBase]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● UserArchiveControl
TimeBase
hmiTimeBaseLocalTimezone (0): hora local
hmiTimeBaseServerTimezone (1): zona horaria del servidor
hmiTimeBaseUTC (2): UTC (Universal Time Coordinated)
hmiTimeBaseProjectSetting (3): configuración del proyecto
Observaciones
El modo horario puede definirse específicamente para cada ordenador mediante WinCC
Explorer en la página de propiedades del equipo.
Descripción
Determina si se actualizarán los valores de la columna seleccionada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnActualize[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
BOOLEAN
TRUE: se actualiza la columna de tiempo.
FALSE: no se actualiza la columna de tiempo. Este ajuste procede si se compara una tabla
con otra.
Descripción
Crea una nueva columna de tiempo.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnAdd[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
STRING
Opcional. Valor o constante que define una columna de tiempo nueva.
Descripción
Determina cómo se alineará la columna de tiempo seleccionada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnAlignment [=HorizontalAlignment]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
HorizontalAlignment
Consulte también
OnlineTableControl (Página 1434)
Descripción
Define la alineación de la columna de tiempo de un par de columnas i. El parámetro i indica
el número del par de columnas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnAlignment(i)[=AlignmentHorizontal]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "TableView".
AlignmentHorizontal
hmiAlignmentLeft ( 0): el texto se alinea a la izquierda.
hmiAlignmentCentered ( 1): el texto se centra.
hmiAlignmentRight ( 2): el texto se alinea a la derecha.
Consulte también
OnlineTableControl (Página 1434)
Descripción
Determina el color de fondo de la columna de tiempo seleccionada.
El ajuste es efectivo:
● Si la opción "en los colores de la columna de valores" no está activada.
● Si está activada la opción "Color de fuente" en la ficha "General" en el área de "Utilizar
color de columna".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnBackColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
Color
Opcional. Valor o constante que determina el color de fondo de la columna de tiempo
seleccionada.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Establece el instante de inicio del intervalo de tiempo para la columna de tiempo seleccionada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnBeginTime[=DateTime]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
DateTime
Opcional. Valor o constante que establece el punto de inicio para la columna de tiempo
seleccionada.
Descripción
Define la denominación de la columna de tiempos seleccionada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnCaption[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
STRING
Opcional. Valor o constante que determina la denominación de la columna de tiempo.
Descripción
Determina el número de columnas de tiempo configuradas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnCount[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
Int32
Opcional. Valor o constante que determina el número de columnas de tiempo configuradas.
Descripción
Determina qué formato de fecha se utilizará para la visualización de la columna de tiempo
seleccionada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnDateFormat[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
STRING
Pueden utilizarse los siguientes formatos de fecha:
Valor Explicación
dd.MM.yy día.mes.año, p. ej. 24.12.13.
dd.yyyyd.MM día.mes.año, p. ej. 24.12.2013.
dd/MM/yy día/mes/año, p. ej. 24/12/13
dd/MM/yyyy día/mes/año, p. ej. 24/12/2013.
Descripción
Establece el instante final del intervalo de tiempo para la columna de tiempo seleccionada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnBeginTime[=DateTime]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
DateTime
Opcional. Valor o constante que determina el instante final.
Descripción
Determina el color de fuente de la columna de tiempo seleccionada.
El ajuste es efectivo:
● Si la opción "en colores de la columna de valores" no está activada.
● Si está activada la opción "Color de fuente" en la ficha "General" en el área de "Utilizar
color de columna".
Sintaxis
Object.TimeColumnForeColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
OnlineTableControl
Color
Opcional. Valor o constante que determina el color de fuente de la columna de tiempo
seleccionada.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina si el contenido de la columna de tiempo se mostrará en forma de texto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnHideText[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
BOOLEAN
TRUE: el contenido no se muestra en forma de texto.
FALSE: el contenido se muestra en forma de texto.
Descripción
Determina si el título de la columna de tiempo se mostrará en forma de texto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnHideTitleText[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
BOOLEAN
TRUE: el título no se mostrará en forma de texto.
FALSE: el título se mostrará en forma de texto.
Descripción
Hace referencia a una columna de tiempo configurada. Esta propiedad permite asignar los
valores de otras propiedades a una determinada columna de tiempo.
Los valores válidos para "TimeColumnIndex" se encuentran entre 0 y "TimeColumnCount"
menos 1. La propiedad "TimeColumnCount" indica el número de columnas de tiempos
configuradas.
Sintaxis
Object.TimeColumnIndex[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
Int32
Opcional. Valor o constante que referencia un intervalo de tiempo configurado.
Descripción
Define el ancho para la columna de tiempos seleccionada:
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnLength[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● OnlineTableControl
Int32
Opcional. Valor o constante que define el ancho para la columna de tiempo seleccionada.
Descripción
Determina el número de puntos de medida que se mostrarán en la columna de tiempo
seleccionada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnMeasurePoints[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
Int32
Opcional. Valor o constante que determina el número de puntos de medida.
Descripción
Especifica el nombre de la columna de tiempo seleccionada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnName[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
STRING
Opcional. Valor o constante que especifica el nombre de la columna de tiempo seleccionada.
Descripción
Determina el intervalo de tiempo para la columna de tiempo seleccionada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnRangeType[=TimeRangeMode]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
TimeRangeMode
Descripción
Elimina la columna de tiempo seleccionada de la lista.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnRemove[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
STRING
Opcional. Elimina la columna de tiempo seleccionada de la lista.
Descripción
Modifica el nombre de la columna de tiempo que será referenciada mediante la propiedad
"TimeColumnIndex". Con "TimeColumnRename" podrá dinamizar también la propiedad
"TimeColumnName".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnRename[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
STRING
Opcional. Modifica el nombre de la columna de tiempo que será referenciada mediante la
propiedad "TimeColumnIndex".
Descripción
Modifica la secuencia de las columnas de tiempos con las correspondientes columnas de
valor. "Arriba" y "Abajo" desplazan la columna de tiempo seleccionada en la lista. De esta
forma se desplazará hacia delante o hacia atrás la columna de tiempos con las
correspondientes columnas de valores en la tabla.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnRepos[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
Int32
Opcional. Valor o constante que modifica la secuencia de las columnas de tiempos con las
correspondientes columnas de valor.
Descripción
Determina si se debe mostrar la columna de tiempo seleccionada en la Ventana de curvas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnShowDate[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
BOOLEAN
TRUE: se mostrarán la fecha y la hora. El formato de fecha se establece en el campo "Formato
de fecha".
FALSE: no se mostrará la fecha. Solamente se visualiza la hora.
Descripción
Determina si el contenido de la columna de tiempo se mostrará como símbolo.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnActualize[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● OnlineTableControl
BOOLEAN
TRUE: el contenido se muestra en forma de símbolo.
FALSE: el contenido no se muestra en forma de símbolo.
Descripción
Determina si se debe mostrar el título en forma de símbolo.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnShowTitleIcon[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
BOOLEAN
TRUE: el título se mostrará en forma de símbolo.
FALSE: el título no se mostrará en forma de símbolo.
Descripción
Establece cómo se clasificará la columna de tiempo referenciada en "TimeColumnIndex".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnSort[=SortMode]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
SortMode
Descripción
Define la secuencia de clasificación de la columna de tiempo referenciada en
"TimeColumnIndex". Si establece en valor en "0", el criterio de clasificación se eliminará de
"TimeColumnSort".
Sintaxis
Object.TimeColumnSortIndex[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
Int32
Opcional. Valor o constante que indica la secuencia de clasificación de la columna de tiempo
referenciada en "TimeColumnIndex". Si ajusta el valor a "0", el criterio de clasificación se
eliminará de "TimeColumnSort".
Descripción
Determina qué formato de hora se utilizará para la visualización de la columna tiempo
seleccionada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnTimeFormat[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
STRING
Valor Explicación
Automático El formato de tiempo se generará automáticamente.
HH:mm:ss.ms Horas:Minutos:Segundos, por ejemplo 15:35:44.240.
hh:mm:ss tt Horas:Minutos:Segundos, AM/PM, por ejemplo 03:35:44 PM.
hh:mm:ss.ms tt Horas:Minutos:Segundos.milisegundos, AM/PM, por ejemplo 03:35:44.240
PM.
Descripción
Define la unidad de tiempo para la determinación del intervalo de tiempo.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnTimeRangeBase[=TagLoggingTimeUnit]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
TagLoggingTimeUnit
Valor Descripción
500 500 ms
1000 1 segundo
60000 1 minuto
3600000 1 hora
86400000 1 día
Descripción
Define el factor para la determinación del intervalo de tiempo. Solamente se aceptan factores
que sean números enteros.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnTimeRangeFactor[=Int16]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
Int16
Opcional. Valor o constante que establece el factor para determinar el rango de tiempo.
Descripción
Determina si se debe mostrar la columna de tiempo seleccionada en el En el color de la
columna de valores.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnUseValueColumnColors[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
BOOLEAN
TRUE: la columna de tiempo seleccionada se mostrará en el color de la columna de valores.
Los ajustes de los campos "Color de fuente" y "Color de fondo" no serán efectivos.
FALSE: la columna de tiempo seleccionada se mostrará en los colores definidos en los
campos "Color de fuente" y "Color de fondo".
Descripción
En esta lista se mostrarán los ejes de tiempos que haya creado. Active en la lista las columnas
de tiempos que quiera mostrar en la tabla.
Haga clic sobre una columna de tiempos de la lista para ajustar las propiedades y para
establecer el intervalo de tiempo de la columna de tiempos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnVisible[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
BOOLEAN
Opcional. TRUE si se muestra la columna de tiempo en la tabla.
Descripción
Devuelve como DATE el sello de tiempo del último acceso de lectura de una variable en tiempo
local.
Acceso en runtime: lectura
Sintaxis
Object.TimeStamp
Object
Obligatorio. Un objeto del tipo "Tag".
Observaciones
Para emitir la propiedad TimeStamp como texto claro, utilice la función VBS
"FormatDateTime(Date[, NamedFormat])". La salida depende del ajuste del ajuste de idioma.
Para ajustar el idioma, utilice la función VBS "SetLocale()".
Si desea devolver el sello de tiempo, por ejemplo, separado por fecha, día y hora, utilice el
parámetro NamedFormat o funciones VBS como Year, WeekDay, Day, Hour, Minute, Second.
El nombre de un día de la semana se obtiene con la función VBS WeekdayName.
Ejemplos
El siguiente ejemplo muestra el sello de tiempo de la variable "Tag11" por medio de la función
"FormatDateTime":
'VBS87
Dim objTag
Dim lngCount
lngCount = 0
Set objTag = HMIRuntime.Tags("Tag11")
objTag.Read
SetLocale("en-gb")
MsgBox FormatDateTime(objTag.TimeStamp) 'Output: e.g. 06/08/2002 9:07:50
MsgBox Year(objTag.TimeStamp) 'Output: e.g. 2002
MsgBox Month(objTag.TimeStamp) 'Output: e.g. 8
MsgBox Weekday(objTag.TimeStamp) 'Output: e.g. 3
MsgBox WeekdayName(Weekday(objTag.TimeStamp)) 'Output: e.g. Tuesday
MsgBox Day(objTag.TimeStamp) 'Output: e.g. 6
MsgBox Hour(objTag.TimeStamp) 'Output: e.g. 9
MsgBox Minute(objTag.TimeStamp) 'Output: e.g. 7
MsgBox Second(objTag.TimeStamp) 'Output: e.g. 50
For lngCount = 0 To 4
MsgBox FormatDateTime(objTag.TimeStamp, lngCount)
Next
'lngCount = 0: Output: e.g. 06/08/2002 9:07:50
'lngCount = 1: Output: e.g. 06 August 2002
'lngCount = 2: Output: e.g. 06/08/2002
'lngCount = 3: Output: e.g. 9:07:50
'lngCount = 4: Output: e.g. 9:07
'VBS88
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
objTag.Read
MsgBox objTag.TimeStamp
Consulte también
Tag (Página 1332)
Descripción
Determina si los contenidos de los campos de una barra de título se acortan cuando el ancho
de columna es demasiado pequeño.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TitleCut[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
Opcional. TRUE si los títulos de las columnas de la barra de título se acortan cuando el ancho
de columna es demasiado pequeño.
Descripción
Define el color para la parte oscura del sombreado.
Con el botón se abre la selección de color. El ajuste solamente será efectivo si la opción "Color
de sombreado" está activa.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TitleDarkShadowColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
Color
Opcional. Valor o constante que define el color para la parte oscura del sombreado.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Determina el color de fuente del título de la tabla para el estado seleccionado.
Con el botón se abre el cuadro de diálogo para la selección de color.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TitleForeColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
Color
Opcional. Valor o constante que determina el color de fuente de la barra de título de la tabla.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Determina el color de las líneas de separación en la barra de título de la tabla.
Con el botón se abre el cuadro de diálogo para la selección de color.
Sintaxis
Object.TitleGridLineColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
Color
Opcional. Valor o constante que determina el color de las líneas de separación en la barra de
título de la tabla.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Define el color para la parte clara del sombreado.
Con el botón se abre el cuadro de diálogo para la selección de color. El ajuste solamente será
efectivo si la opción "Color de sombreado" está activa.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TitleLightShadowColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
Color
Opcional. Valor o constante que define el color para la parte clara del sombreado.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBScript, tales como vbRed o vbGreen.
Descripción
Determina cómo se activa la clasificación por título de columna. La opción "Desplazamiento
automático" debe estar desactivada para clasificar por título de columna.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TitleSort[=GridSortTrigger]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
GridSortTrigger
Descripción
Determina qué color de sombreado se usa para el título de tabla.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TitleStyle[=GridHeaderStyle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
GridHeaderStyle
Descripción
Determina si el objeto indicado encaja en runtime tras la activación.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Toggle[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Button
● RoundButton
BOOLEAN
Opcional. TRUE si el objeto indicado encaja en runtime tras la activación.
Descripción
Determina el valor límite para el visor de memoria a partir del cual se notifica una desviación.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Tolerance[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● DiscSpaceView
Int32
Opcional. Un valor o una constante que determina el valor límite para el visor de memoria a
partir del cual se comunica una desviación.
Descripción
Determina los colores en los que se representa la barra del visor de memoria en cuanto se
rebasa por exceso el rango de tolerancia.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToleranceColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● DiscSpaceView
Color
Opcional. Valor o constante que determina los colores en los que se representa la barra del
visor de memoria en cuanto se rebasa por exceso el rango de tolerancia.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Establece el límite inferior para la tolerancia 1.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToleranceLowerLimit[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
DOUBLE
Opcional. Valor o constante que establece el límite inferior para la tolerancia 1.
Observaciones
Los siguientes valores se determinan por medio de las propiedades "ToleranceLowerLimit",
"ToleranceLowerLimitColor" y "ToleranceLowerLimitRelative":
● Valor límite
● Representación al alcanzarse el valor límite
● Tipo de evaluación
Descripción
Determina el color para el valor límite inferior "ToleranceLowerLimit".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToleranceLowerLimitColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
Color
Opcional. Un valor o una constante que determina el color para el valor límite inferior
"ToleranceLowerLimit" .
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
La propiedad "ToleranceLowerLimitEnabled" debe tener el valor TRUE cuando debe
modificarse el color de barra al alcanzar el valor límite.
Descripción
Determina si se vigila el valor límite "ToleranceLowerLimit". El valor límite, la representación
al alcanzar el valor límite y el tipo de evaluación se determinan por medio de las propiedades
"ToleranceLowerLimit", "ToleranceLowerLimitColor" y "ToleranceLowerLimitRelative".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToleranceLowerLimitEnabled[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional. TRUE, cuando se vigila el valor límite "ToleranceLowerLimit".
Descripción
Determina si el valor límite inferior "ToleranceLowerLimit" se evalúa en porcentaje o de forma
absoluta.
Sintaxis
Object.ToleranceLowerLimitRelative[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional.
TRUE: el valor límite inferior "ToleranceLowerLimit" se evalúa en porcentaje.
FALSE: el valor límite inferior "ToleranceLowerLimit" se evalúa de forma absoluta.
Descripción
Establece el límite superior para la tolerancia 1.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToleranceUpperLimit[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
DOUBLE
Opcional. Valor o constante que establece el límite superior para la tolerancia 1.
Observaciones
Los siguientes valores se determinan por medio de las propiedades "ToleranceUpperLimit",
"ToleranceUpperLimitColor" y "ToleranceUpperLimitRelative":
● Valor límite
● Representación al alcanzarse el valor límite
● Tipo de evaluación
Descripción
Determina el color para el valor límite superior "ToleranceUpperLimit".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToleranceUpperLimitColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
Color
Opcional. Un valor o una constante que determina el color para el límite superior
"ToleranceUpperLimit".
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina si se vigila el valor límite "ToleranceUpperLimit".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToleranceUpperLimitEnabled[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional. TRUE, cuando se vigila el valor límite "ToleranceUpperLimit".
Observaciones
Los siguientes valores se determinan por medio de las propiedades "ToleranceUpperLimit",
"ToleranceUpperLimitColor" y "ToleranceUpperLimitRelative":
● Valor límite
● Representación al alcanzar el valor límite
● Tipo de evaluación
Descripción
Determina si el valor límite superior "ToleranceUpperLimit" se evalúa en porcentaje o de forma
absoluta.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToleranceUpperLimitRelative[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional.
TRUE: el valor límite superior "ToleranceUpperLimit" se evalúa en porcentaje.
FALSE: el valor límite superior "ToleranceUpperLimit" se evalúa de forma absoluta.
Descripción
Determina la posición de la barra de herramientas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToolbarAlignment[=ToolbarPosition]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
Con la siguiente apariencia no se tiene acceso en runtime:
● SysDiagControl
ToolbarPosition
Opcional. Valor o constante que determina la posición de la barra de herramientas.
Descripción
Color de fondo - ToolbarBackColor
Determina el color de fondo de la barra de herramientas. Mediante el botón abra el cuadro de
diálogo "Selección de color" para seleccionar el color.
El color de fondo configurado solamente se mostrará cuando la opción "Visualizar" está
activada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToolbarBackColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
Color
Opcional. Valor o constante que determina el color de fondo de la barra de herramientas.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Establece si la función enlazada a la tecla se puede activar en runtime. Haga clic en la tecla
en runtime para activar la función correspondiente.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToolbarButtonActive[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: la función enlazada a la tecla está activa.
FALSE: la función enlazada a la tecla no está activa. Mediante scripts locales pueden
enlazarse funciones propias con la tecla.
Descripción
Establece una nueva función de teclas definida por el usuario.
El nombre asignado por WinCC se puede modificar en el campo "Nombre de objeto".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToolbarButtonAdd[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
STRING
Opcional. Valor o constante que establece el nombre de la nueva función de tecla.
Descripción
Determina si se añadirá un separador antes de la función de teclas seleccionada. Con el
separador puede agrupar los botones de las funciones de teclas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToolbarButtonBeginGroup[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: antes de la función de teclas seleccionada se añadirá el separador.
FALSE: antes de la función de teclas seleccionada no se añadirá ningún separador.
Descripción
Define el número de botones que contiene la barra de herramientas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToolbarButtonCount[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
Int32
Opcional. Valor o constante que define el número de botones de la barra de herramientas.
Descripción
Determina si se puede utilizar la tecla de la barra de herramientas definida por el usuario.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToolbarButtonEnabled[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
Opcional. TRUE si puede utilizarse la tecla definida por el usuario seleccionada en la barra
de herramientas.
Descripción
Define la tecla de acceso directo para la función de tecla seleccionada.
Para crear o modificar una tecla de acceso directo, haga clic en el campo "Tecla de acceso
directo" y pulse la tecla o combinación de teclas deseada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToolbarButtonHotKey[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
Int32
Opcional. Valor o constante que define la tecla de acceso directo para la función de tecla
seleccionada.
Descripción
Define un número de identidad unívoco para la función de tecla seleccionada.
WinCC asigna el ID y no se puede modificar.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToolbarButtonID[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
Int32
Opcional. Valor o constante que define el número de identidad de la función de tecla
seleccionada.
Descripción
Hace referencia a una función de tecla.
Mediante la utilización de este atributo podrá asignar a una función de tecla determinada los
atributos de otro.
Los valores válidos para "ToolbarButtonIndex" se encuentran entre 0 y "ToolbarButtonCount"
menos 1. El atributo "ToolbarButtonCount" indica el número de funciones de teclas que
pueden configurarse.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToolbarButtonIndex[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
Int32
Opcional. Valor o constante que define el número de la función de tecla seleccionada.
Descripción
Determina si se mostrará el estado pulsado (encajado) de un botón definido por el usuario en
la barra de herramientas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToolbarButtonLocked[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
Opcional. TRUE si se muestra el estado pulsado del botón definido por el usuario seleccionado
en la barra de herramientas.
Descripción
Define el nombre del botón definido por el usuario seleccionado.
El nombre de un botón definido por el usuario puede modificarse. La propiedad
"ToolbarButtonName" para botones definidos por el usuario se puede dinamizar con la
propiedad "ToolbarButtonRename".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToolbarButtonName[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
STRING
Opcional. Valor o constante que define el nombre del botón definido por el usuario
seleccionado.
Descripción
Muestra el permiso para la función de teclas seleccionada. A través del botón de selección
puede modificar el permiso. Los permisos se configuran en la administración de usuarios.
Consulte también
UserArchiveControl (Página 1528)
TrendRulerControl (Página 1508)
FunctionTrendControl (Página 1397)
OnlineTableControl (Página 1434)
OnlineTrendControl (Página 1443)
Descripción
Elimina el botón definido por el usuario seleccionado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToolbarButtonRemove[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
STRING
Opcional. Valor o constante que define el nombre del botón definido por el usuario que se va
a eliminar.
Descripción
Devuelve el nombre del botón de la barra de herramientas definido por el usuario que está
referenciado mediante la propiedad "ToolbarButtonID".
Con "ToolbarButtonRename" podrá dinamizar también la propiedad "ToolbarButtonName".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToolbarButtonRename[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
STRING
Opcional. Valor o constante que define el nuevo nombre del botón definido por el usuario
seleccionado.
Descripción
Modifica el orden de las funciones de tecla definidas por el usuario en la barra de
herramientas.
"Arriba" y "Abajo" desplazan la función de tecla seleccionada en la lista. De esta forma en el
runtime se desplazará hacia arriba o abajo la barra de herramientas en Control.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToolbarButtonRepos[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
Int32
Opcional. Valor o constante que determina la posición del botón definido por el usuario
seleccionado en la barra de herramientas.
Descripción
Define el texto para el tooltip del botón definido por el usuario en la barra de herramientas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToolbarButtonTooltipText[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
STRING
Opcional. Valor o constante que determina el texto del tooltip del botón definido por el usuario
seleccionado.
Descripción
Determina si la tecla de la barra de herramientas ha sido agregada por el ingeniero como tecla
nueva definida por el usuario.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToolbarButtonUserDefined[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
Boolean
TRUE: la tecla de la barra de herramientas está definida por el usuario.
FALSE: la tecla de la barra de herramientas está predefinida en el sistema.
Descripción
Determina si en runtime se mostrarán los tooltips de las funciones de tecla. La propiedad
puede dinamizarse con el nombre ToolbarShowTooltips. La propiedad para definir el texto del
tooltip es "ToolbarButtonTooltipText".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToolbarShowTooltips[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: se mostrarán los tooltips.
FALSE: no se mostrarán los tooltips.
Descripción
Determina si se debe visualizar el color de fondo de la barra de herramientas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToolbarUseBackColor[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: se muestra el color de fondo de la barra de herramientas.
FALSE: no se muestra el color de fondo de la barra de herramientas.
Descripción
Determina si las teclas de acceso directo están activas para las funciones de teclas en runtime.
Las teclas de acceso directo para la función de teclas se insertan en el campo "tecla de acceso
directo".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToolbarUseHotKeys[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: las teclas de acceso directo están activas.
FALSE: las teclas de acceso directo no están activas.
Descripción
Determina si se debe visualizar la barra de herramientas del control.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToolbarVisible[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● FunctionTrendControl
● OnlineTableControl
● OnlineTrendControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: se muestra la barra de herramientas.
FALSE: no se muestra la barra de herramientas.
Descripción
Determina el texto del tooltip.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ToolTipText[=STRING]
ToolTipText
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● ComboBox
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicIOField
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● StatusForce
● Switch
● SymbolicIOField
● TextField
● TubeArcObject
STRING
Opcional. Un valor o una constante que determina el texto del tooltip.
Descripción
Define el valor de la coordenada Y del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Top[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● AlarmView
● ApplicationWindow
● Bar
● BatteryView
● Button
● ChannelDiagnose
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Clock
● ComboBox
● DateTimeField
● DiscSpaceView
● Ellipse
● EllipseSegment
● EllipticalArc
● FunctionTrendControl
● Gauge
● GraphicIOField
● GraphicView
● HTML-Browser
● IOField
● Line
● ListBox
● MediaPlayer
● MultiLineEdit
● OnlineTableControl
● OnlineTrendControl
● OptionGroup
● PLCCodeViewer
● Polygon
● Polyline
● ProtectedAreaNameView
● RangeLabelView
● RangeQualityView
● RecipeView
● Rectangle
● RoundButton
● Screenwindow
● Slider
● SmartClientView
● StatusForce
● Switch
● SymbolLibrary
● SymbolicIOField
● SysDiagControl
● TextField
● TrendRulerControl
● TrendView
● TubeArcObject
● TubeDoubleTeeObject
● TubeTeeObject
● Tubepolyline
● UserArchiveControl
● UserView
● WLanQualityView
● WindowsSlider
● ZoneLabelView
● ZoneQualityView
Con la siguiente apariencia no se tiene acceso en runtime:
● S7GraphOverview
Int32
Opcional. Valor o constante que contiene el valor de la coordenada Y en píxeles (medido
desde el borde superior izquierdo de la imagen).
Observaciones
La coordenada Y hace referencia al ángulo superior izquierdo del recuadro que rodea al objeto.
En runtime se vigilan también los límites de la imagen. Si el valor de coordenada asignado
excede el tamaño de la pantalla, el script de usuario se cancelará con un mensaje de error.
Descripción
Determina la distancia de la imagen desde el borde superior de la ventana de imagen.
La imagen se visualizará como corte de la ventana de imagen. Las barras de desplazamiento
están ubicadas en los bordes izquierdo y superior de la imagen. Si desea representar la
imagen en la ventana de imagen con el desplazamiento horizontal y vertical de las barras de
desplazamiento de la imagen, utilice para el desplazamiento las propiedades
"HorizontalScrollBarPosition" y "VerticalScrollBarPosition".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TopOffset[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Screenwindow
Int32
Opcional. Valor o constante que determina la distancia de la imagen desde el borde superior
de la ventana de imagen.
Descripción
Define la capacidad de memoria.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Total[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● DiskSpaceView
DOUBLE
Opcional. Valor o constante que define la capacidad de memoria.
Descripción
Define la transparencia del objeto en forma de porcentaje.
Significado: 0 = sin transparencia y 100 = transparencia completa (invisibilidad).
Los textos y los campos de los objetos gráficos se representan transparentes solo con el valor
"100".
En Runtime funciona también un objeto completamente transparente y por lo tanto invisible.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Transparency[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Clock
● ComboBox
● Ellipse
● EllipseSegment
● EllipticalArc
● Gauge
● GraphicIOField
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● Slider
● SymbolicIOField
● TextField
● TubeArcObject
● TubeDoubleTeeObject
● TubeTeeObject
● Tubepolyline
● WindowsSlider
Int32
Opcional. Valor o constante que define la transparencia del objeto en forma de porcentaje.
Descripción
Determina qué color del gráfico asignado (*.bmp, *.dib) del objeto indicado se pondrá en
"transparente".
La propiedad "UseTransparentColor" debe tener el valor TRUE para que el color se vea
transparente.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TransparentColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● GraphicView
● GraphicIOField
Color
Opcional. Valor o constante que determina el color que se verá transparente.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina qué color del objeto de mapa de bits asignado se pone en "transparent" para el
estado "Desactivado".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TransparentColorDeactivatedPicture[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● RoundButton
Color
Opcional. Un valor o una constante que determina el color del objeto de mapa de bits asignado
que se pone en transparent" para el estado "Desactivado".
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
La propiedad "PicDeactUseTransColor" debe tener el valor TRUE para que el color se ponga
en "transparent".
Descripción
Determina qué color del objeto de mapa de bits asignado para el estado "Off" se pone en
transparent".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TransparentColorPictureOff[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Button
● RoundButton
Color
Opcional. Un valor o una constante que determina el color del objeto de mapa de bits asignado
que se pone en transparent" para el estado "Off".
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina qué color del objeto de mapa de bits asignado para el estado "On" se pone en
transparent".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TransparentColorPictureOn[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Button
● RoundButton
Color
Opcional. Valor o constante que determina el color del objeto de mapa de bits asignado que
se pone en "transparent" para el estado "On".
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
La propiedad "PicDownUseTransColor" debe tener el valor TRUE para que el color se ponga
en "transparent".
Descripción
Determina si se actualizará la curva seleccionada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendActualize[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
BOOLEAN
TRUE: la curva seleccionada se actualizará siempre.
FALSE: no se actualizará la curva seleccionada. Este ajuste es útil si se compara una curva
archivada con una curva actual.
Descripción
Crea una curva nueva.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendAdd[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
STRING
Opcional. Nombre de la nueva curva.
Descripción
Establece el instante de inicio del intervalo de tiempo para el suministro de datos para la curva
seleccionada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendBeginTime[=DateTime]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
DateTime
Opcional. Define el instante de inicio para el suministro de datos de la curva seleccionada.
Descripción
Define o devuelve el color del objeto.
El visor de tendencias representa con una pequeña flecha la tendencia (ascendente o
descendente) del valor medido que debe vigilarse. Para activar la visualización de tendencia,
la propiedad "Trend" debe estar puesta en "TRUE".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
Color
Opcional. Valor o constante que determina el color del objeto.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina el número de curvas configuradas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendCount[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
Int32
Opcional. Valor o constante que determina el número de curvas del objeto indicado.
Descripción
Establece el instante final del intervalo de tiempo para conexión de datos para la curva
seleccionada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendEndTime[=DateTime]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
DateTime
Opcional. Define el instante final para el suministro de datos de la curva seleccionada.
Descripción
Determina si se puede configurar el color de punto y el color de relleno y si se mostrarán los
colores en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendExtendedColorSet[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
BOOLEAN
TRUE: los ajustes de los campos "Punto Color" y "Color de relleno" se pueden configurar y
serán efectivos en runtime.
FALSE: los ajustes de los campos "Punto Color" y "Color de relleno" no se pueden configurar
ni serán efectivos en runtime.
Consulte también
FunctionTrendControl (Página 1397)
OnlineTrendControl (Página 1443)
Descripción
Determina si se debe mostrar rellena la superficie debajo de la curva.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendFill[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
BOOLEAN
TRUE: la superficie debajo de la curva se mostrará rellenada. Si la opción "Avanzado" no está
activada, se utilizará el color de la curva como color de relleno.
FALSE: la curva no se mostrará rellenada.
Descripción
Define el color de relleno de la curva.
Se utilizará color de relleno si la opción "Relleno" está activada. Mediante el botón abra el
cuadro de diálogo "Selección de color" para seleccionar el color.
La configuración solamente será efectiva si la opción "Ampliado" está activa.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendFillColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
Color
Opcional. Valor o constante que determina el color de relleno de la curva seleccionada.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Hace referencia a una curva configurada. Esta propiedad permite asignar los valores de otras
propiedades a una determinada curva. El índice debe fijarse siempre antes de modificar las
propiedades de una curva en runtime.
Los valores válidos para "TrendIndex" se encuentran entre 0 y "TrendCount" menos 1. La
propiedad "TrendCount" indica el número de curvas configuradas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendIndex[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
Int32
Opcional. Valor o constante que determina el número de la curva seleccionada.
Descripción
Determina el color del visor de tendencias. El visor de tendencias representa con una pequeña
flecha la tendencia (ascendente o descendente) del valor medido que debe vigilarse. Para
activar el visor de tendencias, la propiedad "ShowTrendIndicator" debe tener el valor "TRUE".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendIndicatorColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
Color
Opcional. Un valor o una constante que determina el color del visor de tendencias.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Define la denominación de la curva seleccionada. La designación se muestra en runtime si el
atributo "UseTrendNameAsLabel" tiene el valor "FALSE".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendLabel[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
STRING
Opcional. Valor o constante que define la denominación de la curva seleccionada.
Ejemplo
Determina qué tipo de línea se utilizará para la representación de la curva.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendLineStyle[=LineStyle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● FunctionTrendControl
● OnlineTrendControl
LineStyle
Descripción
Determina cómo se debe mostrar la curva.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendLineType[=TrendLineTypeScada]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
FunctionTrendControl
OnlineTrendControl
TrendLineTypeScada
Descripción
Define el grosor de línea en píxeles de la curva seleccionada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendLineWidth[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
Int32
Opcional. Valor o constante que define el grosor de línea en píxeles de la curva seleccionada.
Descripción
Indica el valor límite inferior para una variable. Si la variable rebasa por defecto el valor de
"TrendLowerLimit", se marcarán los valores con el color configurado en
"TrendLowerLimitColor". El valor será efectivo si la propiedad "TrendLowerLimitColoring" tiene
el valor "TRUE".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendLowerLimit[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
DOUBLE
Opcional. Valor o constante que determina el valor límite inferior de una variable.
Descripción
Establece el color que marca los valores de variable que se encuentran por debajo del valor
de "TrendLowerLimit". El ajuste será efectivo si el atributo "TrendLowerLimitColoring" tiene el
valor "TRUE"".
Sintaxis
Object.TrendLowerLimitColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
Color
Opcional. Valor o constante que establece el color de los valores de variable situados por
debajo del valor de "TrendLowerLimit".
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Establece si se utilizará el atributo "TrendLowerLimitColor" para marcar los valores de variable
que se encuentran por debajo del valor "TrendLowerLimit".
Sintaxis
Object.TrendLowerLimitColoring[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
BOOLEAN
TRUE: la propiedad "TrendLowerLimitColor" es efectiva.
FALSE: la propiedad "TrendLowerLimitColor" no es efectiva.
Descripción
Determina el número de puntos de medida que se utilizará para la representación de la curva
seleccionada.
Establece la cantidad de pares de valores si la curva serán suministrados a través del fichero
de usuario.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendMeasurePoints[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
Int32
Opcional. Valor o constante que determina el número de puntos de medición o de pares de
valores de la curva seleccionada.
Descripción
Muestra el nombre de la curva seleccionada. Puede determinar el nombre en la ficha "Curvas".
La propiedad "TrendName" puede dinamizarse mediante la propiedad "TrendRename".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendName[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
STRING
Opcional. Valor o constante que determina el nombre de la curva seleccionada.
Descripción
Indica el color de los puntos de la curva seleccionada.
Mediante el botón abra el cuadro de diálogo "Selección de color" para seleccionar el color.
La configuración solamente será efectiva si la opción "Ampliado" está activa.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendPointColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
Color
Opcional. Valor o constante que determina el color de los puntos de la curva seleccionada.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina cómo se mostrarán los puntos en la curva.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendPointStyle[=PointStyle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
PointStyle
Descripción
Establece el ancho de punto en píxeles. El ancho de punto solamente se puede configurar
para los tipos de punto "Cuadrados" y "Círculos".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendPointWidth[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
Int32
Opcional. Valor o constante que establece el ancho de punto en píxeles de la curva
seleccionada.
Descripción
Define el origen de datos de la curva seleccionada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendProvider[=Provider]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
Provider
Descripción
Establece el intervalo de tiempo en el que se suministrarán datos a la curva seleccionada.
Mediante un suministro de datos mediante archivo de usuario solamente podrá establecer el
número de puntos de medición.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendRangeType[=RangeType]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
RangeType
Descripción
Elimina las curvas seleccionadas de la lista.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendRemove[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
STRING
Opcional. Valor o constante que determina el nombre de la curva que se va a eliminar.
Descripción
Modifica el nombre de la curva que será referenciada mediante la propiedad "TrendIndex".
Con "TrendRename" podrá dinamizar también la propiedad "TrendName".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendRename[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
STRING
Opcional. Valor o constante que determina el nuevo nombre de la curva seleccionada.
Descripción
Modifica la secuencia de la curva seleccionada en la ventana de curvas.
"Arriba" y "Abajo" desplazan la curva seleccionada en la lista. De esta forma la curva se
mostrará en runtime en el primer plano o en el fondo.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendRepos[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
Int32
Opcional. Valor o constante que determina la nueva posición de la curva seleccionada.
Descripción
Abre el dialogo para la selección del nombre de variable para el suministro de datos del eje
X en el visor de curvas f(x). Esta propiedad pueden utilizarla los programadores para que,
por ejemplo, el usuario pueda seleccionar un nombre de variable con un botón.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendSelectTagNameX[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
BOOLEAN
TRUE:
FALSE:
Descripción
Abre el diálogo para la selección del nombre de variable para el suministro de datos del eje
Y en el visor de curvas f(x). Esta propiedad pueden utilizarla los programadores para que,
por ejemplo, el usuario pueda seleccionar un nombre de variable con un botón.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendSelectTagNameY[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
BOOLEAN
TRUE:
FALSE:
Descripción
Define el nombre de las variables HMI o columnas asociadas para el eje X. Con el botón de
selección se selecciona una variable HMI o una columna.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendTagNameX[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
STRING
Opcional. Valor o constante que determina el nombre de las variables HMI o la columna del
eje X.
Descripción
Define el nombre de las variables HMI o columnas asociadas para el eje Y. Con el botón de
selección se selecciona una variable HMI o una columna.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendTagNameY[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
STRING
Opcional. Valor o constante que establece el nombre de la variable HMI o la columna del eje
Y.
Descripción
Define la unidad de tiempo para la determinación del intervalo de tiempo.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendTimeRangeBase[=TagLoggingTimeUnit]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
TagLoggingTimeUnit
Valor Descripción
500 500 ms
1000 1 segundo
60000 1 minuto
3600000 1 hora
86400000 1 día
Descripción
Define el factor para la determinación del intervalo de tiempo. Solamente se aceptan factores
que sean números enteros.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeRangeFactor[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
Int32
Opcional. Valor o constante que establece el factor para determinar el rango de tiempo.
Descripción
Determina en qué ventana de curvas se mostrará la curva seleccionada.
Las ventanas de curvas disponibles se establecerán en la ficha "Ventana de curvas".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendTrendWindow[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
STRING
Opcional. Valor o constante que establece el nombre de la ventana de curvas para la curva
seleccionada.
Descripción
Los valores tienen un estado inseguro, si el valor inicial después de activar runtime es
desconocido o se utilizará un valor de sustitución.
Con la propiedad "TrendUncertainColor" se define el color que se utilizará para caracterizar
estos valores. El dato se evaluará o no dependiendo de la propiedad
"TrendUncertainColoring".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendUncertainColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
Color
Opcional. Valor o constante que determina el color de los valores con estado inseguro de la
curva seleccionada.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Los valores tienen un estado inseguro, si el valor inicial después de activar runtime es
desconocido o se utilizará un valor de sustitución. Mediante "TrendUncertainColoring" puede
definir si dichos valores deben ser marcados con el color definido en "TrendUncertainColor".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendUncertainColoring[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
BOOLEAN
TRUE: la configuración de la propiedad "TrendUncertainColor" tiene efecto.
FALSE: la configuración de la propiedad "TrendUncertainColor" no tiene efecto.
Descripción
Indica el valor límite superior para una variable.
Si la variable rebasa por defecto el valor de "TrendUpperLimit", se representarán los valores
con el color configurado en "TrendUpperLimitColor". El valor tendrá efecto si el atributo
"TrendUpperLimitColoring" tiene el valor "TRUE".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendUpperLimit[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
DOUBLE
Opcional. Valor o constante que determina el valor límite superior para los valores de la curva
seleccionada.
Descripción
Establece el color que marca los valores de variable que se encuentran por debajo del valor
de "TrendLowerLimit". El ajuste será efectivo si el atributo "TrendUpperLimitColoring" tiene el
valor "TRUE".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendUpperLimitColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
Color
Opcional. Valor o constante que determina el color de los valores inferiores al valor límite de
la curva seleccionada.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Define si el borde de selección se coloreará con el color definido por el sistema.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendUpperLimitColoring[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● FunctionTrendControl
● OnlineTrendControl
BOOLEAN
TRUE: la configuración del atributo "TrendUpperLimitColor" tiene efecto.
FALSE: la configuración del atributo "TrendUpperLimitColor" no tiene efecto.
Descripción
Determina si se mostrará la curva seleccionada.
En esta lista se mostrarán las curvas que haya creado.
Active en la lista las curvas que quiera mostrar en la ventana de curvas.
Haga clic sobre una curva de la lista para ajustar las propiedades y para asignar los ejes y la
ventana de curvas de la curva.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendVisible[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
BOOLEAN
TRUE: se mostrará la curva seleccionada.
FALSE: no se mostrará la curva seleccionada.
Descripción
Crea un nuevo visor de curvas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendWindowAdd[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
STRING
Opcional. Valor o constante que define el nombre del nuevo visor de curvas.
Descripción
Determina si se mostrarán las líneas de retícula y la escala principal.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendWindowCoarseGrid[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
BOOLEAN
TRUE: se mostrarán las líneas de retícula para la escala principal.
FALSE: no se mostrarán las líneas de retícula para la escala principal.
Descripción
Indica el color de las líneas de retícula para la escala principal.
Mediante el botón abra el cuadro de diálogo "Selección de color" para seleccionar el color.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendWindowCoarseGridColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
Color
Opcional. Valor o constante que determina el color de las líneas de retícula para la escala
principal.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina si se mostrarán las líneas de retícula para la escala auxiliar.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendWindowFineGrid[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
BOOLEAN
TRUE: se mostrarán las líneas de retícula de la escala auxiliar.
FALSE: no se mostrarán las líneas de retícula de la escala auxiliar.
Descripción
Indica el color de las líneas de retícula para la escala auxiliar.
Mediante el botón abra el cuadro de diálogo "Selección de color" para seleccionar el color.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendWindowFineGridColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
Color
Opcional. Valor o constante que determina el color de las líneas de retícula para la escala
auxiliar.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina si se mostrarán solamente las líneas de retícula para la curva de primer plano de
la ventana de curvas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendWindowForegroundTrendGrid[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
BOOLEAN
TRUE: en la ventana de curvas se mostrarán las líneas de retícula para la curva de primer
plano.
FALSE: en la ventana de curvas se mostrarán las líneas de retícula para todas las curvas.
Descripción
Determina si se mostrarán las líneas de retícula para la escala principal en el color de la
curva.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendWindowGridInTrendColor[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
BOOLEAN
TRUE: las líneas de retícula se mostrarán en el color de la curva.
FALSE: las líneas de retícula se mostrarán en el color ajustado en el campo "Color".
Descripción
Determina si se mostrarán las líneas de retícula horizontales.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendWindowHorizontalGrid[=BOOLEAN]
Object
● FunctionTrendControl
BOOLEAN
TRUE: se mostrarán las líneas de retícula horizontales.
FALSE: no se mostrarán las líneas de retícula horizontales.
Descripción
Hace referencia a una ventana de curvas configurada. Esta propiedad permite asignar los
valores de otras propiedades a una determinada ventana de curvas.
Los valores válidos para "TrendWindowIndex" se encuentran entre 0 y "TrendWindowCount"
menos 1. La propiedad "TrendWindowCount" indica el número de ventanas de curvas
configuradas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendWindowIndex[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
Int32
Opcional. Valor o constante que define el número de la ventana de curvas seleccionada.
Descripción
Establece el nombre de la ventana de curvas seleccionada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendWindowName[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
STRING
Opcional. Valor o constante que define el nombre de la ventana de curvas seleccionada.
Descripción
Elimina el visor de curvas seleccionado de la lista.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendWindowRemove[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
STRING
Opcional. Valor o constante que determina el nombre de la ventana de curvas que se va a
eliminar.
Descripción
Modifica el nombre de la ventana de curvas que será referenciado mediante la propiedad
"TrendWindowIndex".
Con "TrendWindowRename" se puede dinamizar también la propiedad "TrendWindowName".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendWindowRename[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
STRING
Opcional. Valor o constante que determina el nuevo nombre de la ventana de curvas
seleccionada.
Descripción
Modifica la secuencia del visor de curvas.
"Arriba" y "Abajo" desplazan la curva seleccionada en la lista. La secuencia en la lista
determina la posición en Control. El primer visor de curvas se muestra en la posición inferior;
el último visor de curvas, en la posición superior.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendWindwRepos[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
Int32
Opcional. Valor o constante que determina la nueva posición de la ventana de curvas
seleccionada.
Descripción
Indica el color de la regla.
Mediante el botón abra el cuadro de diálogo "Selección de color" para seleccionar el color. El
color se podrá configurar y mostrar si se ha ajustado la representación "1 - gráfico".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendWindowRulerColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
Color
Opcional. Valor o constante que determina el color de la regla.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina el nivel de representación de la regla en el visor de curvas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendWindowRulerLayer[=RulerLayer]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
RulerLayer
Descripción
Establece la representación de la regla.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendWindowRulerStyle[=RulerStyle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
RulerStyle
TRUE: la regla se mostrará como una sencilla línea negra.
FALSE: la regla se mostrará con el "Color" y "Grosor" configurados.
Descripción
Define en píxeles el grosor de la regla.
El grosor se podrá configurar y mostrar si se ha ajustado la representación "1 - gráfico".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendWindowRulerWidth[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
Int32
Opcional. Valor o constante que determina el grosor en píxeles de la regla.
Descripción
Establece el nombre de la ventana de curvas seleccionada en la representación de Control.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendWindowSpacePortion[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
Int32
Opcional. Valor o constante que define en forma de porcentaje la proporción de la ventana
de curvas seleccionada en Control.
Descripción
Determina si se mostrarán las líneas de retícula verticales.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendWindowVerticalGrid[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
BOOLEAN
TRUE: se mostrarán las líneas de retícula verticales.
FALSE: no se mostrarán las líneas de retícula verticales.
Descripción
Determina si se mostrará la ventana de curvas seleccionada.
En esta lista se mostrarán los visores de curvas que se hayan creado.
Active en la lista los visores de curvas que quiera mostrar en Control.
Haga clic sobre una entrada de la lista para ajustar las propiedades de la regla y ajustar las
líneas de cuadrícula.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendWindowVisible[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
BOOLEAN
TRUE: se mostrará la ventana de curvas seleccionada.
FALSE: no se mostrará la ventana de curvas seleccionada.
Descripción
Determina qué eje X se utilizará para la representación de la curva.
Los ejes X disponibles se establecerán en la ficha "Ejes X".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendXAxis[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
STRING
Opcional. Valor o constante que define el nombre del eje X utilizado para la curva seleccionada.
Descripción
Determina qué eje Y se utilizará para la representación de la curva.
Los ejes Y disponibles se establecerán en la ficha "Ejes Y".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendYAxis[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
STRING
Opcional. Valor o constante que define el nombre del eje Y utilizado para la curva seleccionada.
Descripción
Define la unidad de medida.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Unit[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
● IOField
STRING
Opcional. Valor o constante que determina la unidad de medida.
Descripción
Define el color de texto para el nombre de la unidad de medida en el objeto "Gauge".
Acceso en runtime: lectura y escritura
Sintaxis
Object.UnitColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
Color
Opcional. Valor o constante que determina el color de texto de la unidad de medida.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Define el texto para la unidad de medida del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UnitText[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
STRING
Opcional. Valor o constante que determina el texto de la unidad de medida.
Observaciones
Introduzca un texto para visualizar la unidad física del valor representado, por ejemplo. La
opción predeterminada no contiene ningún texto.
Descripción
Determina la distancia de la unidad de medida respecto del borde superior del objeto indicado.
El texto solo puede posicionarse a lo largo del diámetro vertical del cuadrante. El valor de la
propiedad hace referencia a la altura del objeto indicado y se mide desde el borde superior
del objeto indicado hasta el borde inferior del texto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UnitTop[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
DOUBLE
Opcional. Un valor o una constante que determina la distancia de la unidad de medida respecto
del borde superior del objeto indicado.
Rango de valores de 0 a 1
0: el borde inferior del texto se encuentra sobre la delimitación superior del objeto indicado.
El texto ya no se ve, dado que se encuentra fuera del objeto indicado.
1: el borde inferior del texto se encuentra sobre la delimitación inferior del objeto indicado.
Descripción
Determina el valor límite superior para valores de entrada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UpperLimit[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● IOField
DOUBLE
Opcional. Un valor o una constante que determina el valor límite superior para valores de
entrada.
Descripción
Devuelve el tamaño de la memoria ocupada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Used[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● DiscSpaceView
DOUBLE
Opcional. Un valor o una constante que devuelve el tamaño de la memoria ocupada.
Descripción
Determina si los colores definidos en el Esquema cromático global del diseño actual se
utilizarán para este objeto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UseDesignColorSchema[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
● Button
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Clock
● ComboBox
● Ellipse
● EllipseSegment
● EllipticalArc
● Gauge
● GraphicView
● IOField
● Line
● ListBox
● MultiLineEdit
● OptionGroup
● Polygon
● Polyline
● Rectangle
● RoundButton
● Slider
● SymbolicIOField
● TextField
● TubeArcObject
● TubeDoubleTeeObject
● TubeTeeObject
● Tubepolyline
● WindowsSlider
Con la siguiente apariencia no se tiene acceso en runtime:
● AlarmView
● DateTimeField
● RecipeView
● StatusForce
● Switch
● SysDiagControl
● TrendView
● UserView
BOOLEAN
Opcional. TRUE si el objeto se representa con los colores del Esquema cromático global
definido para este tipo de objeto.
FALSE si el objeto se representa con los colores correspondientes a la configuración del
objeto.
Descripción
Determina si el objeto se representa con el sombreado fijado en el diseño activo.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UseDesignShadowSettings[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Circle
● CircleSegment
● CircularArc
● Ellipse
● EllipseSegment
● EllipticalArc
● GraphicView
● Line
● Polygon
● Polyline
● Rectangle
● TextField
● TubeArcObject
● TubeDoubleTeeObject
● Tubepolyline
● TubeTeeObject
● Bar
● Button
● CheckBox
● Clock
● ComboBox
● Gauge
● GraphicIOField
● IOField
● ListBox
● MultiLineEdit
● OptionGroup
● RoundButton
● Slider
● SymbolicIOField
● WindowsSlider
BOOLEAN
TRUE: el objeto se representa con el sombreado global establecido para este tipo de objeto.
FALSE: el objeto se representa sin sombra.
Descripción
Determina el porcentaje de los valores medidos de la memoria ocupada. Los valores pueden
consultarse en runtime. Los valores no pueden predefinirse.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UsedPercent[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● DiscSpaceView
Int32
Opcional. Un valor o una constante que devuelve en porcentaje los valores medidos de la
memoria ocupada.
Descripción
Determina si los números se representan con exponentes (p. ej., "1,00e+000").
Acceso en runtime: lectura y escritura
Sintaxis
Object.UseExponentialFormat[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional. TRUE si los números se representan con exponentes (p. ej., "1,00e+000").
Descripción
Determina si el color del objeto de mapa de bits de una imagen intermitente se establece en
"transparent".
Acceso en runtime: lectura y escritura
Sintaxis
Object.UseFlashTransparentColor[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "GraphicIOField".
BOOLEAN
Opcional. TRUE si el color del objeto de mapa de bits de una imagen intermitente se establece
en "transparent".
Consulte también
GraphicIOField (Página 1408)
Descripción
Determina si deben mostrarse los colores acordados para las categorías.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UseMessageColor [=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
BOOLEAN
TRUE: se mostrarán los colores.
FALSE: serán efectivos en la ficha "Representación" los ajustes de color que se hayan
indicado para el contenido de la tabla.
Descripción
Determina si se utilizará un color de selección para los títulos de tablas de celdas
seleccionadas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UseSelectedTitleColor[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: se utilizará un color de selección. Los ajustes de "Fondo" y "Fuente" serán efectivos
en runtime.
Descripción
Determina si se utilizará un segundo color de filas en la representación de la tabla.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UseTableColor2[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: los ajustes de "Color de fila 2" se utilizarán alternando con "Color de fila 1".
FALSE: los ajustes de "Color de fila 1" se utilizarán para todas las filas.
Descripción
Determina que se utilicen los colores.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UseTagLimitColors[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● IOField
BOOLEAN
Opcional. TRUE si se utilizan los colores.
Descripción
Determina si el color determinado con la propiedad "TransparentColor" para el objeto indicado
debe verse transparente.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UseTransparentColor[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● GraphicView
● GraphicIOField
BOOLEAN
Opcional. TRUE si el color definido debe mostrarse transparente.
Descripción
Determina si el color transparente determinado con la propiedad
"TransparentColorDeactivatedPicture" se utiliza para el estado "Desactivado".
Acceso en runtime: lectura y escritura
Sintaxis
Object.UseTransparentColorDeactivatedPicture[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● RoundButton
BOOLEAN
Opcional. TRUE si el color transparente determinado con la propiedad
"TransparentColorDeactivatedPicture" se utiliza para el estado "Desactivado".
Descripción
Determina si el color transparente determinado con la propiedad "TransparentColorPictureOff"
se utiliza para el estado "Off".
Acceso en runtime: lectura y escritura
Sintaxis
Object.UseTransparentColorPictureOff[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Button
● RoundButton
BOOLEAN
Opcional. TRUE si el color transparente determinado con la propiedad
"TransparentColorPictureOff" se utiliza para el estado "Off".
Descripción
Determina si el color transparente determinado con la propiedad "TransparentColorPictureOn"
se utiliza para el estado "On".
Acceso en runtime: lectura y escritura
Sintaxis
Object.UseTransparentColorPictureOn[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Button
● RoundButton
BOOLEAN
Opcional. TRUE si el color transparente determinado con la propiedad
"TransparentColorPictureOn" se utiliza para el estado "On".
Descripción
Determina si las propiedades "Nombre" o "Rotulación" se utilizarán como nombre de la curva
en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UseTrendNameAsLabel[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
● OnlineTrendControl
BOOLEAN
TRUE: se utilizará el nombre configurado en "Propiedades > Propiedades > Curvas > Nombre".
FALSE: se utilizará el nombre configurado en "Propiedades > Propiedades > Curvas >
Rotulación".
Descripción
Devuelve el nombre del usuario que habilitó el objeto Alarm.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Ningún acceso en runtime.
Descripción
Define o devuelve un valor según el objeto utilizado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Value[=VARIANT]
Object
Obligatorio. Un objeto del tipo "Tag", "DataItem" o "ScreenItem" con la apariencia "Gauge".
VARIANT
Opcional. El valor que se define según el objeto utilizado:
● Tag.Value: devuelve el valor de variable del último acceso de lectura o define el futuro
valor de variable. Para leer el valor de variable de la propiedad "Value" se utiliza el método
"Read". El método "Write" asigna un nuevo valor de variable a la propiedad "Value".
● Dataset.Value: define un valor o devuelve una copia del valor o de la referencia de objeto.
Al devolver referencias de objetos, asegúrese de que las referencias sean aptas para
multithread.
● ScreenItem("Gauge_1").Value: define el valor que indica el puntero del indicador gauge.
Rango de valores dentro de los valores ajustados mediante las propiedades "ValueMin" y
"ValueMax".
Ejemplos
El siguiente ejemplo escribe un nuevo valor en la variable "Tag1":
'VBS94
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
objTag.Value = 50
objTag.Write
El ejemplo muestra la forma de incluir un valor en un listado de variables y emitirlo como Trace.
A continuación el valor es modificado, nuevamente emitido y luego eliminado. Esto tiene lugar
en diferentes acciones:
'VBS198
HMIRuntime.DataSet.Add "motor1", 23
HMIRuntime.Trace "motor1: " & HMIRuntime.DataSet("motor1").Value & vbNewLine
HMIRuntime.DataSet("motor1").Value = 55
HMIRuntime.Trace "motor1: " & HMIRuntime.DataSet("motor1").Value & vbNewLine
HMIRuntime.DataSet.Remove("motor1")
Consulte también
DataItem (Página 1308)
Tag (Página 1332)
Descripción
Establece si el rango de valores del eje Y se determina automáticamente o mediante los
valores "ValueAxisBegin(i)" y "ValueAxisEnd(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ValueAxisAutoRange(i)[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTrendControl
BOOLEAN
Opcional. TRUE si el rango de valores del eje Y se determina automáticamente o mediante
los valores "ValueAxisBegin(i)" y "ValueAxisEnd(i)".
Descripción
Define la designación del eje de valores. El dato se evaluará o no dependiendo de la propiedad
"ConfigureTimeAxis(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ValueAxisLabel(i)[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTrendControl
STRING
Opcional. Valor o constante que define la designación del eje de valores.
Descripción
Determina el tipo de escala de los ejes.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ValueAxisScalingType(i)[=AxisScalingType]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTrendControl
AxisScalingType
hmiBarScalingLinear (0): escala lineal del eje
hmiBarScalingLogarithmic (1): escala logarítmica del eje
hmiBarScalingNegativeLogarithmic (2): escala logarítmica negativa del eje
Observaciones
El parámetro i indica el número de la curva.
Descripción
Define la alineación de los valores de variable de este par de columnas. El parámetro i indica
el número del par de columnas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ValueColumnAlignment(i)[=HorizontalAlignment]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● OnlineTableControl
HorizontalAlignment
hmiAlignmentLeft (0): el texto se alinea a la izquierda.
hmiAlignmentCentered (1): el texto se centra.
hmiAlignmentRight (2): el texto se alinea a la derecha.
Descripción
Determina la alineación vertical del texto en el objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.VerticalAlignment[=VerticalAlignment]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Button
● DateTimeField
● IOField
● OptionGroup
● RoundButton
● Switch
● SymbolicIOField
● TextField
Con la siguiente apariencia no se tiene acceso en runtime:
● CheckBox
VerticalAlignment
Opcional. Valor que determina la alineación vertical.
hmiAlignmentTop (0): el texto se representa en el borde superior.
hmiAlignmentMiddle (1): el texto se representa en el centro.
Descripción
Determina si se deben visualizar líneas verticales.
Acceso en runtime: lectura y escritura
Sintaxis
Object.VerticalGridLines[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● OnlineTableControl
● TrendRulerControl
● UserArchiveControl
BOOLEAN
TRUE: se muestran líneas de separación verticales.
FALSE: no se muestran líneas de separación verticales.
Descripción
Define el desplazamiento vertical de la barra de desplazamiento de la imagen en una ventana
de imagen con barras de desplazamiento o retorna el valor.
La imagen se representa en la ventana de imagen con el desplazamiento horizontal o vertical
de las barras de desplazamiento. Si desea representar la imagen recortada en la que las
barras de desplazamiento de la imagen están ubicadas en el borde izquierdo y en el borde
superior de la imagen, utilice las propiedades "OffsetLeft" y "OffsetTop" para el origen de esta
área.
Acceso en runtime: lectura y escritura
Sintaxis
Object.VerticalScrollBarPosition[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Screenwindow
Int32
Opcional. Valor o constante que determina el desplazamiento de la barra de desplazamiento
vertical.
Descripción
Determina si el visor Sm@rtClient debe utilizarse para la monitorización o el mantenimiento
a distancia.
Mantenimiento a distancia significa que los ajustes del dispositivo vigilado pueden modificarse.
Monitorización a distancia significa que los ajustes del dispositivo vigilado no pueden
modificarse.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ViewOnly[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● SmartClientView
BOOLEAN
Opcional. TRUE si el visor Sm@rtClient sólo debe utilizarse para la monitorización a distancia.
Descripción
Determina si el objeto indicado es visible.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Visible[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● AlarmView
● ApplicationWindow
● Bar
● BatteryView
● Button
● ChannelDiagnose
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Clock
● ComboBox
● DateTimeField
● DiscSpaceView
● Ellipse
● EllipseSegment
● EllipticalArc
● FunctionTrendControl
● Gauge
● GraphicIOField
● HTML-Browser
● IOField
● Line
● ListBox
● MediaPlayer
● MultiLineEdit
● OnlineTableControl
● OnlineTrendControl
● OptionGroup
● PLCCodeViewer
● Polygon
● Polyline
● ProtectedAreaNameView
● RangeLabelView
● RangeQualityView
● RecipeView
● Rectangle
● RoundButton
● Screenwindow
● Slider
● SmartClientView
● StatusForce
● Switch
● SymbolLibrary
● SymbolicIOField
● SysDiagControl
● TextField
● TrendRulerControl
● TrendView
● TubeArcObject
● TubeDoubleTeeObject
● TubeTeeObject
● Tubepolyline
● UserArchiveControl
● UserView
● WLanQualityView
● WindowsSlider
● ZoneLabelView
● ZoneQualityView
Con la siguiente apariencia no se tiene acceso en runtime:
● S7GraphOverview
BOOLEAN
Opcional. TRUE si el objeto es visible.
Descripción
Define a partir de qué porcentaje de memoria ocupada se emite una advertencia.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Warning[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● DiskSpaceView
Int32
Opcional. Valor o constante que indica el valor porcentual de memoria ocupada a partir del
cual se emite una advertencia.
Descripción
Determina el color en el que se representa la barra del visor de memoria en cuanto se alcanza
el rango de advertencia.
Acceso en runtime: lectura y escritura
Sintaxis
Object.WarningColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● DiskSpaceView
Color
Opcional. Un valor o una constante que determina el color en el que se representa la barra
del visor de memoria en cuanto se alcanza el rango de advertencia.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Establece el valor límite inferior "WarningLowerLimit".
La propiedad "WarningLowerLimitEnable" debe tener el valor "TRUE" para que se vigile el
valor límite.
Acceso en runtime: lectura y escritura
Sintaxis
Object.WarningLowerLimit[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
DOUBLE
Opcional. Un valor o una constante que determina el valor límite inferior "WarningLowerLimit".
Observaciones
Los siguientes valores se determinan por medio de las propiedades "WarningLowerLimitColor"
y "WarningLowerLimitRelative":
● Representación al alcanzarse el valor límite
● Tipo de evaluación
Descripción
Determina el color para el valor límite inferior "WarningLowerLimit".
La propiedad "WarningLowerLimitEnable" debe tener el valor "TRUE" cuando deba
modificarse el color de barra al alcanzar el valor límite.
Acceso en runtime: lectura y escritura
Sintaxis
Object.WarningLowerLimitColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
Color
Opcional. Valor o constante que establece el color del valor límite inferior "WarningLowerLimit".
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Los siguientes valores se determinan por medio de las propiedades "WarningUpperLimit",
"WarningUpperLimitColor" y "WarningUpperLimitRelative":
● Valor límite
● Representación al alcanzarse el valor límite
● Tipo de evaluación
Descripción
Determina si se vigila el valor límite "WarningLowerLimit".
Acceso en runtime: lectura y escritura
Sintaxis
Object.WarningLowerLimitEnabled[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional. TRUE, cuando se vigila el valor límite "WarningLowerLimit".
Observaciones
Los siguientes valores se determinan por medio de las propiedades "WarningLowerLimit",
"WarningLowerLimitColor" y "WarningLowerLimitRelative":
● Valor límite
● Representación al alcanzarse el valor límite
● Tipo de evaluación
Descripción
Determina si el valor límite inferior "WarningLowerLimit" se evalúa en porcentaje o de forma
absoluta.
Acceso en runtime: lectura y escritura
Sintaxis
Object.WarningLowerLimitRelative[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional.
TRUE: el valor límite inferior "WarningLowerLimit" se evalúa en porcentaje.
FALSE: el valor límite inferior "WarningLowerLimit" se evalúa de forma absoluta.
Descripción
Define el color del rango de advertencia en la escala del objeto "Gauge".
La propiedad "WarningRangeVisible" debe tener el valor TRUE para que se visualice el rango
de peligro.
Acceso en runtime: lectura y escritura
Sintaxis
Object.WarningRangeColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
Color
Opcional. Valor o constante que determina el color del rango de peligro.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Introduzca para cada uno de los valores RGB el valor decimal
correspondiente (puede estar comprendido entre 0 y 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina a partir de qué valor de la escala comienza el rango de advertencia del objeto
"Gauge".
La propiedad "WarningRangeVisible" debe tener el valor TRUE para que se visualice el rango
de advertencia.
Acceso en runtime: lectura y escritura
Sintaxis
Object.WarningRangeStart[=SINGLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
SINGLE
Opcional. Valor o constante que determina el valor de la escala para el comienzo del rango
de advertencia.
Observaciones
El rango va desde el valor "Warning" hasta el valor "Danger". Si no hay ningún rango activado
para Danger", el rango para "Warning" llega hasta el final de la escala.
Descripción
Determina si debe mostrarse el rango de advertencia en la escala del objeto "Gauge".
Acceso en runtime: lectura y escritura
Sintaxis
Object.WarningRangeVisible[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Gauge
BOOLEAN
Opcional. TRUE si debe mostrarse el rango de advertencia en la escala.
Observaciones
El color del rango de advertencia se define con la propiedad "WarningRangeColor".
El comienzo del rango de advertencia se define con la propiedad "WarningRangeStart".
Descripción
Determina el límite de advertencia superior.
La propiedad "WarningUpperLimitEnabled"" debe tener el valor TRUE para que se vigile el
valor límite.
Acceso en runtime: lectura y escritura
Sintaxis
Object.WarningUpperLimit[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
DOUBLE
Opcional. Valor o constante que determina el valor límite superior.
Observaciones
"WarningUpperLimitColor" determina la representación al alcanzarse el valor límite.
"WarningUpperLimitRelative" define el tipo de evaluación.
Descripción
Define el color del límite de advertencia inferior.
La propiedad "WarningUpperLimitEnabled" debe tener el valor TRUE si el color de la barra
debe cambiar al alcanzarse el valor límite.
Acceso en runtime: lectura y escritura
Sintaxis
Object.WarningUpperLimitColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
Color
Opcional. Valor o constante que define el color para el valor límite superior.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina si se vigila el valor límite superior.
Acceso en runtime: lectura y escritura
Sintaxis
Object.WarningUpperLimitEnabled[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional. TRUE si se vigila el valor límite superior.
Descripción
Determina si el valor límite inferior "WarningUpperLimit" se evalúa en porcentaje o de forma
absoluta.
Acceso en runtime: lectura y escritura
Sintaxis
Object.WarningUpperLimitRelative[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional. TRUE cuando se evalúa el valor límite inferior "WarningUpperLimit" en porcentaje.
Descripción
Determina el ancho del objeto en píxeles.
Acceso en runtime: lectura y escritura.
Sintaxis
Object.Width[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● AlarmControl
● AlarmView
● ApplicationWindow
● Bar
● BatteryView
● Button
● ChannelDiagnose
● CheckBox
● Circle
● CircleSegment
● CircularArc
● Clock
● ComboBox
● DateTimeField
● DiscSpaceView
● Ellipse
● EllipseSegment
● EllipticalArc
● FunctionTrendControl
● Gauge
● GraphicIOField
● GraphicView
● HTML-Browser
● IOField
● Line
● ListBox
● MediaPlayer
● MultiLineEdit
● OnlineTableControl
● OnlineTrendControl
● OptionGroup
● PLCCodeViewer
● Polygon
● Polyline
● ProtectedAreaNameView
● RangeLabelView
● RangeQualityView
● RecipeView
● Rectangle
● RoundButton
● Screenwindow
● Slider
● SmartClientView
● StatusForce
● Switch
● SymbolLibrary
● SymbolicIOField
● SysDiagControl
● TextField
● TrendRulerControl
● TrendView
● TubeArcObject
● TubeDoubleTeeObject
● TubeTeeObject
● Tubepolyline
● UserArchiveControl
● UserView
● WLanQualityView
● WindowsSlider
● ZoneLabelView
● ZoneQualityView
Con la siguiente apariencia no se tiene acceso en runtime:
● S7GraphOverview
Int32
Opcional. Valor o constante que determina el ancho del objeto en píxeles.
Descripción
Indica si puede cerrarse una ventana en runtime.
Acceso en runtime: lectura
Sintaxis
Object.WindowCloseEnabled[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● ApplicationWindow
● ScreenWindow
BOOLEAN
Opcional. TRUE cuando la ventana puede cerrarse en runtime.
Descripción
Devuelve si el objeto se puede maximizar en runtime.
Acceso en runtime: lectura
Sintaxis
Object.WindowMaximizeEnabled[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● ApplicationWindow
● Screenwindow
BOOLEAN
TRUE: el objeto se puede maximizar en runtime.
FALSE: el objeto no se puede maximizar en runtime.
Descripción
Devuelve si el objeto se puede desplazar en runtime.
Acceso en runtime: lectura
Sintaxis
Object.WindowMovingEnabled[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● ApplicationWindow
● Screenwindow
BOOLEAN
TRUE: el objeto se puede desplazar en runtime.
FALSE: el objeto no se puede desplazar en runtime.
Descripción
Devuelve si el objeto permanece siempre en primer plano en runtime.
Acceso en runtime: lectura
Sintaxis
Object.WindowOnTop[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● ApplicationWindow
● Screenwindow
BOOLEAN
TRUE: el objeto permanece siempre en primer plano en runtime.
FALSE: el objeto no permanece siempre en primer plano en runtime.
Descripción
Devuelve el contenido de la ventana de aplicación. Sólo acceso de lectura.
Consulte también
ScriptDiagnostics (Página 1479)
Descripción
Indica si puede modificarse el tamaño del objeto señalado en runtime.
Acceso en runtime: lectura
Sintaxis
Object.WindowSizingEnabled[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● ApplicationWindow
● ScreenWindow
BOOLEAN
Opcional. TRUE, si puede modificarse el tamaño del objeto señalado en runtime.
Descripción
Determina si el objeto se representa en el estilo general de Windows.
Acceso en runtime: lectura y escritura
Sintaxis
Object.WindowsStyle[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Button
● WindowSlider
Con la siguiente apariencia no se tiene acceso en runtime:
● Switch
BOOLEAN
Opcional. TRUE cuando el objeto se representa en el estilo general de Windows.
Descripción
Crea un nuevo eje X.
Sintaxis
Object.XAxisAdd[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia:
● FunctionTrendControl
STRING
Opcional. Valor o constante que ???
Descripción
Determina cómo se alineará el eje seleccionado.
Sintaxis
Object.XAxisAlignment[=AxisAlignment]
Object
Necesario. Objeto del tipo "ScreenItem" con la especificación "FunctionTrendControl".
AxisAlignment
Descripción
Determina si la cantidad de dígitos de coma se debe determinar automáticamente.
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisAutoPrecisions[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
BOOLEAN
TRUE: el número de decimales se determinará automáticamente.
FALSE: el valor configurado en "Propiedades > Eje X > Formato > Decimales" en la ventana
de inspección tiene efecto.
Descripción
Establece si el rango de valores del eje X se determina automáticamente o mediante los
atributos "XAxisBegin(i)" y "XAxisEnd(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisAutoRange(i)[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
BOOLEAN
Opcional. TRUE si el rango de valores del eje X se determina automáticamente o mediante
los atributos "XAxisBegin(i)" y "XAxisEnd(i)".
Descripción
Define el extremo inferior del rango de valores del eje X seleccionado.
Para configurar el valor, desactive la opción "Automático" en "Rango de valores".
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisBeginValue[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
DOUBLE
Opcional. Valor o constante que define el límite inferior del rango de valores del eje X
seleccionado.
Descripción
Con este atributo se define el color utilizado para el eje X común.
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
Color
Valor o constante que establece el color utilizado del eje X común.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina el número de ejes X.
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisCount[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
Int32
Opcional. Valor o constante que determina el número de ejes X.
Descripción
Define el extremo superior del rango de valores del eje X seleccionado.
Para configurar el valor, desactive la opción "Automático" en "Rango de valores".
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisEndValue[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
DOUBLE
Opcional. Valor o constante que define el límite superior del rango de valores del eje X
seleccionado.
Descripción
Determina si los valores del eje seleccionado se mostrarán en notación exponencial.
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisExponentialFormat[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
BOOLEAN
TRUE: los valores se muestran en representación exponencial.
FALSE: los valores no se muestran en representación exponencial.
Descripción
Hace referencia a un eje X configurado. Esta propiedad permite asignar los valores de otras
propiedades a un determinado eje X.
Los valores válidos para "XAxisIndex" se encuentran entre 0 y "XAxisCount" menos 1. La
propiedad "ToolbarButtonCount" indica el número de ejes X configurados.
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisIndex[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
Int32
Opcional. Valor o constante que establece el número del eje X seleccionado.
Descripción
Determina si se debe mostrar el eje seleccionado en la ventana de curvas. Si se muestran
varias curvas en la ventana de curvas, se utilizará el color de la primera curva. La secuencia
de las curvas se define en las propiedades de "Curvas".
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisInTrendColor[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
BOOLEAN
TRUE: el eje seleccionado se mostrará en el color de la curva. La configuración del campo
"Color" no tendrá efecto.
FALSE: el eje seleccionado se mostrará en el color configurado en el campo "Color".
Descripción
Determina, en función del valor de "XAxisMode(i)", la denominación del eje X de una curva
referenciada por medio de "CurrentCurveIndex".
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisLabel(i)[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
STRING
Opcional. Valor o constante que determina la denominación del eje X de una curva
referenciada por medio de "CurrentCurveIndex".
Descripción
Especifica el nombre del eje seleccionado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisName[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
STRING
Opcional. Valor o constante que define el nombre del eje seleccionado.
Descripción
Determina con cuántos decimales se mostrarán los valores del eje X seleccionado.
Para introducir el valor, desactive la opción "Automático" en "Formato".
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisPrecisions[=Int16]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
Int16
Opcional. Valor o constante que determina el número de decimales.
Descripción
Elimina el eje seleccionado de la lista.
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisRemove[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
STRING
Opcional. Valor o constante que determina el eje que ha de eliminarse de la lista.
Descripción
Define la secuencia de los ejes. La secuencia en la lista determina en runtime la posición del
eje en el visor de curvas. Si la orientación es la misma y el eje se encuentra en la parte superior
de la lista, se mostrará en una posición alejada de la curva.
Sintaxis
Object.XAxisRepos[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
Int32
Opcional. Valor o constante que determina la secuencia de los ejes ???
Descripción
Establece el tipo de escala para el eje X. La indicación se evaluará o no en función del valor
del atributo "XAxisMode(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisScalingType(i)[=AxisScalingType]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
AxisScalingType
hmiBarScalingLinear (0): escala lineal del eje.
hmiBarScalingLogarithmic (1): escala logarítmica del eje
hmiBarScalingNegativeLogarithmic (2): escala logarítmica negativa del eje
Observaciones
El parámetro i indica el número de la curva.
Descripción
Determina en qué ventana de curvas se utilizará el eje seleccionado. Las ventanas de curvas
disponibles se definen en las propiedades de "Curvas".
Sintaxis
Object.XAxisTrendWindow[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
STRING
Opcional. Valor o constante que indica el nombre de la ventana de curvas.
Descripción
En esta lista se mostrarán los ejes que haya creado.
Active en la lista los ejes que quiera mostrar en los visores de curvas.
Haga clic sobre un eje de la lista para ajustar las propiedades y asignar el eje a un visor de
curvas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisVisible[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
BOOLEAN
Opcional. Determina si se muestra el eje X.
Descripción
Crea un nuevo eje Y.
Sintaxis
Object.YAxisAdd[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
STRING
Opcional. Valor o constante que determina ???.
Descripción
Determina cómo se alineará el eje seleccionado.
Sintaxis
Object.YAxisAlignment[=AxisAlignment]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la especificación "FunctionTrendControl".
AxisAlignment
Descripción
Determina si la cantidad de dígitos de coma se debe determinar automáticamente.
Acceso en runtime: lectura y escritura
Sintaxis
Object.YAxisAutoPrecisions[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
BOOLEAN
TRUE: el número de decimales se determinará automáticamente.
FALSE: el valor configurado en "Propiedades > Eje Y > Formato > Decimales" en la ventana
de inspección tiene efecto.
Descripción
Determina si el rango de valores del eje Y seleccionado se determinará automáticamente.
Acceso en runtime: lectura y escritura
Sintaxis
Object.YAxisAutoRange[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
BOOLEAN
Valor Explicación
TRUE El rango de valores se determina automáticamente.
FALSE El rango de valores se determina mediante los valores configurados en los campos "desde"
y "hasta".
Descripción
Define el extremo inferior del rango de valores del eje Y seleccionado.
Para configurar el valor, desactive la opción "Automático" en "Rango de valores".
Acceso en runtime: lectura y escritura
Sintaxis
Object.YAxisBeginValue[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
DOUBLE
Opcional. Valor o constante que define el límite inferior del rango de valores del eje Y
seleccionado.
Descripción
Define el color del eje seleccionado. Mediante el botón abra el cuadro de diálogo "Selección
de color" para seleccionar el color. El ajuste solo será efectivo si está desactivado el campo
"Del color de la curva".
Acceso en runtime: lectura y escritura
Sintaxis
Object.YAxisColor[=Color]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
Color
Opcional. Valor o constante que define el color del eje seleccionado.
Observaciones
La función "RGB" se puede utilizar para determinar el color en formato RGB ("red, green,
blue", o sea, rojo, verde, azul). Para ello, indique para cada uno de los tres valores RGB el
correspondiente valor decimal (rango de valores de 0 a 255). Por ejemplo, el color rojo se
representa de la manera siguiente: RGB(255, 0, 0). Además, también es posible utilizar las
constantes de color VBS, tales como vbRed o vbGreen.
Descripción
Determina el número de ejes Y configurados.
Acceso en runtime: lectura y escritura
Sintaxis
Object.YAxisCount[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
Int32
Opcional. Valor o constante que determina el número de ejes Y configurados.
Descripción
Define el extremo superior del rango de valores del eje Y seleccionado.
Para configurar el valor, desactive la opción "Automático" en "Rango de valores".
Acceso en runtime: lectura y escritura
Sintaxis
Object.YAxisEndValue[=DOUBLE]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
DOUBLE
Opcional. Valor o constante que define el límite superior del rango de valores del eje Y
seleccionado.
Descripción
Determina si los valores del eje seleccionado se mostrarán en representación exponencial.
Acceso en runtime: lectura y escritura
Sintaxis
Object.YAxisExponentialFormat[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
BOOLEAN
TRUE: los valores se muestran en representación exponencial.
FALSE: los valores no se muestran en notación exponencial.
Descripción
Hace referencia a un eje Y configurado. Esta propiedad permite asignar los valores de otras
propiedades a un determinado eje Y.
Los valores válidos para "YAxisIndex" se encuentran entre 0 y "YAxisCount" menos 1. La
propiedad "ToolbarButtonCount" indica el número de ejes Y configurados.
Acceso en runtime: lectura y escritura
Sintaxis
Object.YAxisIndex[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
Int32
Opcional. Valor o constante que establece el número del eje Y seleccionado.
Descripción
Determina si se debe mostrar el eje seleccionado en la ventana de curvas. Si se muestran
varias curvas en la ventana de curvas, se utilizará el color de la primera curva. La secuencia
de las curvas se define en las propiedades de "Curvas".
Acceso en runtime: lectura y escritura
Sintaxis
Object.YAxisInTrendColor[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
BOOLEAN
TRUE: el eje seleccionado se mostrará en el color de la curva. La configuración del campo
"Color" no tendrá efecto.
FALSE: el eje seleccionado se mostrará en el color configurado en el campo "Color".
Descripción
define el texto con el cual se titulará el eje seleccionado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.YAxisLabel[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
STRING
Opcional. Valor o constante que establece el texto de la rotulación del eje Y seleccionado.
Descripción
Especifica el nombre del eje seleccionado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.YAxisName[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
STRING
Opcional. Valor o constante que establece el nombre del eje seleccionado.
Descripción
Determina con cuántos decimales se mostrarán los valores del eje Y seleccionado.
Para introducir el valor, desactive la opción "Automático" en "Formato".
Acceso en runtime: lectura y escritura
Sintaxis
Object.YAxisPrecisions[=Int16]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
Int16
Opcional. Valor o constante que determina el número de decimales.
Descripción
Elimina el eje seleccionado de la lista.
Acceso en runtime: lectura y escritura
Sintaxis
Object.YAxisRemove[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
STRING
Opcional. Valor o constante que establece el nombre del eje seleccionado.
Descripción
Modifica el nombre del eje Y que será referenciado mediante la propiedad "YAxisIndex".
Acceso en runtime: lectura y escritura
Sintaxis
Object.YAxisRename[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
STRING
Opcional. Valor o constante que establece el nombre nuevo del eje Y seleccionado.
Descripción
Modifica la secuencia de los ejes. "Arriba" y "Abajo" desplazan el eje seleccionado en la lista.
La secuencia en la lista determina en runtime la posición del eje en el visor de curvas. Si la
orientación es la misma y el eje se encuentra en la parte superior de la lista, se mostrará en
una posición alejada de la curva.
Acceso en runtime: lectura y escritura
Sintaxis
Object.YAxisRepos[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
Int32
Opcional. #####################################################.
Descripción
Determina cómo se escalará el eje Y.
Acceso en runtime: lectura y escritura
Sintaxis
Object.YAxisScalingType[=AxisScalingType]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
AxisScalingType
Los siguientes ajustes están a disposición:
Valor Descripción
0 Lineal
1 Logarítmico
2 Logarítmico negativo
Descripción
Determina en qué ventana de curvas se utilizará el eje seleccionado. Las ventanas de curvas
disponibles se definen en las propiedades de "Curvas".
Acceso en runtime: lectura y escritura
Sintaxis
Object.YAxisTrendWindow[=STRING]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
STRING
Opcional. Valor o constante que indica el nombre de la ventana de curvas.
Descripción
En esta lista se mostrarán los ejes que haya creado.
Active en la lista los ejes que quiera mostrar en los visores de curvas.
Haga clic sobre un eje de la lista para ajustar las propiedades y asignar el eje a un visor de
curvas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.YAxisVisible[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● FunctionTrendControl
BOOLEAN
Opcional. Determina si se muestra el eje Y seleccionado.
Descripción
Determina la posición del punto cero en porcentaje respecto de la altura de la barra. El valor
cero también puede estar fuera del área representada.
La propiedad "ScalingType" debe estar puesta en "Auto".
La propiedad "ShowScale" debe estar puesta en "TRUE".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ZeroPoint[=Int32]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
Int32
Opcional. Un valor o una constante que determina la posición del punto cero en porcentaje
respecto de la altura de la barra.
Descripción
Establece el factor de zoom de una imagen o ventana de imagen o lo lee.
Si el factor de zoom indicado es más pequeño que el valor mínimo, entonces el factor de zoom
automáticamente es ajustado al valor mínimo. Si el factor de zoom indicado es más grande
que el valor máximo, entonces el factor de zoom automáticamente es ajustado al valor
máximo.
El valor mínimo del factor de zoom es del 2 por ciento y el valor máximo del 800 por ciento.
Con el objeto Screen el factor de zoom se indica como un valor numérico y con el objeto
ventana de imagen como un porcentaje.
Zoom: factor de zoom de la imagen
Ejemplo
El siguiente ejemplo duplica el factor de zoom de la imagen actual:
'VBS97
HMIRuntime.ActiveScreen.Zoom = HMIRuntime.ActiveScreen.Zoom * 2
Consulte también
ScreenWindow (Página 1477)
Descripción
Define el valor límite inferior en el que se activa la alarma, o lo retorna.
El tipo de evaluación (porcentual o absoluta) se define con la propiedad "TypeAlarmLow".
Acceso en runtime: lectura y escritura
Sintaxis
Object.AlarmLow[=REAL]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "Bar".
REAL
Valor para el límite inferior
Consulte también
Bar (Página 1353)
Descripción
Define la alineación vertical del texto, o la devuelve. Rango de valores de 0 a 2.
Sintaxis
Object.AlignmentTopt[=VerticalAlignment]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "TextField", "IOField",
"SymbolicIOField", "Button", "RoundButton", "CheckBox", "OptionGroup".
VerticalAlignment
0: alineación izquierda
1: alineación centrada
2: alineación derecha
Descripción
Devuelve el contenido de la ventana de aplicación. Sólo acceso de lectura.
Consulte también
ScriptDiagnostics (Página 1479)
Descripción
Define si después de salir del campo de entrada (p. ej. con la tecla <TAB> o haciendo clic con
el ratón) se aplicará el texto introducido.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AssumeOnExit
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "IOField", "SymbolicIOField".
Consulte también
IOField (Página 1418)
SymbolicIOField (Página 1491)
Descripción
Define si se sale automáticamente del campo de entrada una vez finalizada la introducción
de datos (es decir, cuando se ha introducido la cantidad predeterminada de caracteres) y se
aplican los datos introducidos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AssumeOnFull[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "IOField", "SymbolicIOField".
BOOLEAN
TRUE: se aplican.
FALSE: no se aplican.
Consulte también
IOField (Página 1418)
SymbolicIOField (Página 1491)
Descripción
Define el ancho del borde 3D en píxeles, o lo retorna. El valor del ancho depende del tamaño
del objeto.
Descripción
Define el color del fondo de la barra, o lo retorna. Acceso de escritura y lectura LONG.
Descripción
Define el color del fondo del objeto para el estado de intermitencia "Off", o lo retorna. Acceso
de escritura y lectura LONG.
Descripción
Define el color del fondo del objeto para el estado de intermitencia "On", o lo retorna. Acceso
de escritura y lectura LONG.
Descripción
Define el color de línea del objeto para el estado de intermitencia "Off", o lo retorna. Acceso
de escritura y lectura LONG.
Descripción
Define el color de línea del objeto para el estado de intermitencia "On", o lo retorna. Acceso
de escritura y lectura LONG
Descripción
Indica el número de índice del punto conector inferior, o lo define.
Acceso de escritura y lectura Long
Descripción
Indica el nombre de objeto del objeto que está acoplado en el punto conector inferior, o lo
define.
Acceso de escritura y lectura Long
Descripción
TRUE si los campos están dispuestos a la derecha. Acceso de escritura y lectura BOOLEAN.
Descripción
Define la cantidad de campos, o los retorna. Margen de valores de 0 hasta 31.
Descripción
Define el tipo de campo, o lo retorna. Margen de valores de 0 hasta 2:
● 0: Impresión
● 1: Entrada
● 2: Campo de E/S
Descripción
Define el ancho del botón 1 en píxeles, o lo retorna.
Cuando la propiedad SameSize está activada en TRUE, todos los botones tendrán el mismo
ancho.
Descripción
Define el ancho del botón 2 en píxeles, o lo retorna.
Cuando la propiedad SameSize está activada en TRUE, todos los botones tendrán el mismo
ancho.
Descripción
Define el ancho del botón 3 en píxeles, o lo retorna.
Cuando la propiedad SameSize está activada en TRUE, todos los botones tendrán el mismo
ancho.
Descripción
Define el ancho del botón 4 en píxeles, o lo retorna.
Cuando la propiedad SameSize está activada en TRUE, todos los botones tendrán el mismo
ancho.
Descripción
Define el color del control deslizante, o lo retorna. Acceso de escritura y lectura LONG.
Descripción
Define la visualización en el visor de avisos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ButtonCommand[=Long]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
Long
Opcional. Valor o constante que determina la visualización en el visor de avisos.
0x00000001; 1; Lista de avisos ·
0x00000002; 2; Lista de ficheros de corto plazo·
0x00000004; 4; Lista de ficheros de largo plazo·
0x00200000; 2097152; Lista de inhibiciones·
0x00000008; 8; Acuse de avisador central·
0x00000010; 16; Acuse individual·
0x00000020; 32; Acuse de grupo·
0x00000040; 64; Autoscroll·
0x00000080; 128; Diálogo de selección·
0x00000100; 256; Diálogo de bloqueos·
0x00000200; 512; Imprimir informe de avisos·
0x00000800; 2048; Acuse de emergencia·
0x00001000; 4096; Primer aviso·
0x00002000; 8192; Último aviso·
0x00004000; 16384; Aviso siguiente·
0x00008000; 32768; Aviso anterior·
0x00010000; 65536; Diálogo de texto informativo·
0x00020000; 131072; Diálogo de comentario·
0x00040000; 262144; Loop en Alarma·
0x00100000; 1048576; Imprimir vista actual·
0x00400000; 4194304; Bloquear/desbloquear aviso·
0x00800000; 8388608; Diálogo de ordenación·
0x01000000; 16777216; Diálogo de base de tiempo·
0x02000000; 33554432; Lista de aciertos
Consulte también
AlarmControl (Página 1338)
Descripción
TRUE si el valor límite "AlarmHigh" será supervisado. Acceso de escritura y lectura BOOLEAN.
El valor límite, la representación al llegar al valor límite y el tipo de evaluación se definen por
medio de las propiedades "AlarmHigh", "ColorAlarmHigh" y "TypeAlarmHigh".
Descripción
TRUE si el valor límite "AlarmLow" será supervisado. Acceso de escritura y lectura BOOLEAN.
El valor límite, la representación al llegar al valor límite y el tipo de evaluación se definen por
medio de las propiedades "AlarmLow", "ColorAlarmLow" y "TypeAlarmLow".
Descripción
TRUE si el valor límite superior "Reserve 4" debe ser supervisado. Acceso de escritura y
lectura BOOLEAN.
El valor límite, la representación al llegar al valor límite y el tipo de evaluación se definen por
medio de las propiedades "LimitHigh4", "ColorLimitHigh4" y "TypeLimitHigh4".
Descripción
TRUE si el valor límite superior "Reserve 5" debe ser supervisado. Acceso de escritura y
lectura BOOLEAN.
El valor límite, la representación al llegar al valor límite y el tipo de evaluación se definen por
medio de las propiedades "LimitHigh5", "ColorLimitHigh5" y "TypeLimitHigh5".
Descripción
TRUE si el valor límite inferior "Reserve 4" debe ser supervisado. Acceso de escritura y lectura
BOOLEAN.
El valor límite, la representación al llegar al valor límite y el tipo de evaluación se definen por
medio de las propiedades "LimitLow4", "ColorLimitLow4" y "TypeLimitLow4".
Descripción
TRUE si el valor límite inferior "Reserve 5" debe ser supervisado. Acceso de escritura y lectura
BOOLEAN.
El valor límite, la representación al llegar al valor límite y el tipo de evaluación se definen por
medio de las propiedades "LimitLow5", "ColorLimitLow5" y "TypeLimitLow5".
Descripción
TRUE si el valor límite "ToleranceHigh" será supervisado. Acceso de escritura y lectura
BOOLEAN.
El valor límite, la representación al llegar al valor límite y el tipo de evaluación se definen por
medio de las propiedades "ToleranceHigh", "ColorToleranceHigh" y "TypeToleranceHigh" .
Descripción
TRUE si el valor límite "ToleranceLow" será supervisado. Acceso de escritura y lectura
BOOLEAN.
El valor límite, la representación al llegar al valor límite y el tipo de evaluación se definen por
medio de las propiedades "ToleranceLow", "ColorToleranceLow" y "TypeToleranceLow" .
Descripción
TRUE si el valor límite "WarningHigh" será supervisado. Acceso de escritura y lectura
BOOLEAN.
El valor límite, la representación al llegar al valor límite y el tipo de evaluación se definen por
medio de las propiedades "WarningHigh", "ColorWarningHigh" y "TypeWarningHigh".
Descripción
TRUE si el valor límite "WarningLow" será supervisado. Acceso de escritura y lectura
BOOLEAN.
El valor límite, la representación al llegar al valor límite y el tipo de evaluación se definen por
medio de las propiedades "WarningLow", "ColorWarningLow" y "TypeWarningLow".
Descripción
TRUE si la entrada del campo se borra en cuanto el campo E/S recibe el foco. Acceso de
escritura y lectura BOOLEAN.
Descripción
Define el color de barra para el valor límite "AlarmHigh", o lo retorna. Acceso de lectura y
escritura LONG.
La propiedad "CheckAlarmHigh" debe tener el valor TRUE si el color de barra debe modificarse
al alcanzarse el valor límite.
Descripción
Define el color de barra para el valor límite "AlarmLow", o lo retorna. Acceso de lectura y
escritura LONG.
La propiedad "CheckAlarmLow" debe tener el valor TRUE si el color de barra debe modificarse
al alcanzarse el valor límite.
Descripción
Define el color para el valor límite superior "Reserve 4", o lo retorna. Acceso de lectura y
escritura LONG.
La propiedad "CheckLimitHigh4" debe tener el valor TRUE si el color de barra debe
modificarse al alcanzarse el valor límite.
Descripción
Define el color para el valor límite superior "Reserve 5", o lo retorna. Acceso de lectura y
escritura LONG.
La propiedad "CheckLimitHigh5" debe tener el valor TRUE si el color de barra debe
modificarse al alcanzarse el valor límite.
Descripción
Define el color para el valor límite inferior "Reserve 4", o lo retorna. Acceso de lectura y
escritura LONG.
La propiedad "CheckLimitLow4" debe tener el valor TRUE si el color de barra debe modificarse
al alcanzarse el valor límite.
Descripción
Define el color para el valor límite inferior "Reserve 5", o lo retorna. Acceso de lectura y
escritura LONG.
La propiedad "CheckLimitLow5" debe tener el valor TRUE si el color de barra debe modificarse
al alcanzarse el valor límite.
Descripción
Define el color para el valor límite superior "ToleranceHigh", o lo retorna. Acceso de lectura y
escritura LONG.
La propiedad "CheckToleranceHigh" debe tener el valor TRUE si el color de barra debe
modificarse al alcanzarse el valor límite.
Descripción
Define el color para el valor límite inferior "ToleranceLow", o lo retorna. Acceso de lectura y
escritura LONG.
La propiedad "CheckToleranceLow" debe tener el valor TRUE si el color de barra debe
modificarse al alcanzarse el valor límite.
Descripción
Define el color para el valor límite superior "WarningHigh", o lo retorna. Acceso de lectura y
escritura LONG.
La propiedad "CheckWarningHigh" debe tener el valor TRUE si el color de barra debe
modificarse al alcanzarse el valor límite.
Descripción
Define el color para el valor límite inferior "WarningLow", o lo retorna. Acceso de lectura y
escritura LONG.
La propiedad "CheckWarningLow" debe tener el valor TRUE si el color de barra debe
modificarse al alcanzarse el valor límite.
Descripción
Devuelve el número de curvas o pares de columnas configurados (visibles o invisibles) de la
ventana.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CountValueColumns[=Int]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTableControl".
Int
Opcional. Valor o constante que devuelve el número de curvas o pares de columnas
configurados (visibles o invisibles) de la ventana.
Consulte también
OnlineTableControl (Página 1434)
Descripción
Establece los ajustes que pueden asignarse a un determinado par de columnas. La propiedad
es evaluada por otras propiedades. Los valores válidos para el índice están comprendidos
entre 0 y -1. La propiedad "CountValueColumns" contiene el número de pares de columnas
que deben mostrarse.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CurrentColumnIndex[=Int]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTableControl".
Int
Opcional. Valor o constante que establece los ajustes que pueden asignarse a un determinado
par de columnas.
Observaciones
La propiedad "NumItems" contiene el número de curvas/pares de columnas que deben
mostrarse.
Consulte también
OnlineTableControl (Página 1434)
Descripción
Determina si puede borrarse el visor de recetas en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.DeleteEnable[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "UserArchiveControl".
BOOLEAN
Opcional. TRUE si puede borrarse el visor de recetas en runtime.
Descripción
Determina si la línea de borde del objeto indicado se traza a partir de un grosor de línea
superior a 1 dentro del borde o de forma simétrica respecto al borde.
Acceso en runtime: lectura y escritura
Sintaxis
Object.DrawAlwaysInsideFrame[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Rectangle".
BOOLEAN
Opción. TRUE si la línea de borde del objeto indicado se traza a partir de un grosor de línea
superior a 1 dentro del borde.
Consulte también
Rectangle (Página 1471)
Descripción
Determina si el botón se representa en el estilo general de Windows.
Acceso en runtime: lectura y escritura
Sintaxis
Object.DrawStylishButton[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Button".
BOOLEAN
Opcional. TRUE si el botón se representa en el estilo general de Windows.
Consulte también
Button (Página 1360)
Descripción
TRUE si al saltar el campo con la tecla <Tab> se puede ejecutar la entrada inmediata y sin
ninguna otra acción.Acceso de escritura y lectura BOOLEAN.
Descripción
TRUE si la representación de números se debe hacer con exponentes (p. ej."1,00e+000").
Acceso de escritura y lectura BOOLEAN.
Descripción
Define el color del tipo de relleno para el objeto, o lo devuelve.
Sintaxis
Object.FillColor[=LONG]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con las apariencias "Line", "Polyline", "Ellipse",
"Circle", "EllipseSegment", "CircleSegment", "EllipticalArc", "CircularArc", "Rectangle",
"Polygon", "TextField", "IOField", "SymbolicIOField", "DateTimeField", "Button",
"Roundbutton", "Switch", "Bar", "StatusForce", "Clock", "Gauge", "Slider", "Checkbox".
Ejemplo
El siguiente ejemplo define de color azul el color de relleno de la imagen "ScreenWindow1":
'VBS73
Dim objScreen
Set objScreen = HMIRuntime.Screens("ScreenWindow1")
objScreen.FillStyle = 131075
objScreen.FillColor = RGB(0, 0, 255)
Descripción
TRUE si el objeto se puede rellenar con una línea de borde cerrada (es decir, p. ej. representa
el nivel de llenado de un tanque). Acceso de escritura y lectura BOOLEAN.
Ud. puede definir el nivel de llenado del objeto con la propiedad "FillingIndex".
Descripción
Define el valor % (referido a la altura del objeto) con el que se rellenará el objeto con línea de
borde cerrada.
El nivel de llenado se representará con el color de fondo actual. El fondo no rellenado es
transparente.
Descripción
Define el tipo de relleno de la barra, o lo retorna.
Descripción
TRUE si está activada la intermitencia del objeto. Acceso de escritura y lectura BOOLEAN.
Descripción
TRUE si está activada la intermitencia de la línea del objeto. Acceso de escritura y lectura
BOOLEAN.
Descripción
Define la frecuencia de intermitencia, o la retorna. Margen de valores de 0 hasta 2.
0 = Lento
1 = Medio
2 = Rápido
Descripción
Define la frecuencia de intermitencia para el fondo del objeto, o la retorna. Margen de valores
de 0 hasta 2.
0 = Lento
1 = Medio
2 = Rápido
Descripción
Determina el tipo de datos del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.FormatType[=IOFieldDataFormat]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "IOField".
IOFieldDataFormat
hmiOutputFormatString ( 2): string
hmiOutputFormatDecimal ( 1): decimal
hmiOutputFormatHexadecimal ( 3): hexadecimal
hmiOutputFormatBinary ( 0): binario
hmiOutputFormatDate ( 4): fecha
hmiOutputFormatTime ( 5): hora
hmiOutputFormatDateTime ( 6): fecha y hora
Consulte también
IOField (Página 1418)
Descripción
Establece el color de fondo para el visor de recetas en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.GridBackColor[=Color]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "UserArchiveControl".
Color
Opcional. Valor o constante que establece el color de fondo para el visor de recetas en runtime.
Descripción
Establece el color de fuente para el visor de recetas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.GridForeColor[=Color]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "UserArchiveControl".
Color
Opcional. Valor o constante que establece el color de fuente para el visor de recetas.
Descripción
TRUE si la visualización se debe realizar con histéresis. Acceso de escritura y lectura
BOOLEAN.
Descripción
Define o devuelve la histéresis en tanto por ciento del valor de muestra.
La propiedad Hysteresis debe tener el valor TRUE, para que se pueda calcular la histéresis.
Descripción
Determina si pueden introducirse valores en el visor de recetas en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.InsertEnable[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "UserArchiveControl".
BOOLEAN
Opcional. TRUE si pueden introducirse valores en el visor de recetas en runtime.
Descripción
Define el color de fondo de las líneas de separación en la lista de selección del objeto Lista
de texto, o lo retorna. Acceso de escritura y lectura LONG. El color de fondo se puede ver
únicamente cuando se ha definido la propiedad ItemBorderStyle > 0.
Descripción
Define el color de las líneas de separación en la lista de selección del objeto Lista de texto, o
lo retorna. Acceso de escritura y lectura LONG.
Descripción
Define en píxeles el grosor de las líneas de separación de la lista de selección del objeto Lista
de texto, o lo retorna.
Descripción
Define la cantidad de dígitos a la izquierda de la coma (0 hasta 20), o los retorna.
Descripción
Define el valor límite superior para "Reserve 4", o lo retorna.
La propiedad CheckLimitHigh4 debe estar activada en TRUE para que el valor límite "Reserve
4" pueda ser vigilado.
El tipo de evaluación (porcentual o absoluta) lo define Ud. con la propiedad TypeLimitHigh4.
Descripción
Define el valor límite superior para "Reserve 5", o lo retorna.
La propiedad CheckLimitHigh5 debe estar activada en TRUE para que el valor límite "Reserve
5" pueda ser vigilado.
El tipo de evaluación (porcentual o absoluta) lo define Ud. con la propiedad TypeLimitHigh5.
Descripción
Define el valor límite inferior para "Reserve 4", o lo retorna.
La propiedad CheckLimitLow4 debe estar activada en TRUE para que el valor límite "Reserve
4" pueda ser vigilado.
El tipo de evaluación (porcentual o absoluta) lo define Ud. con la propiedad TypeLimitLow4.
Descripción
Define el valor límite inferior para "Reserve 5", o lo retorna.
La propiedad CheckLimitLow5 debe estar activada en TRUE para que el valor límite "Reserve
5" pueda ser vigilado.
El tipo de evaluación (porcentual o absoluta) lo define Ud. con la propiedad TypeLimitLow5.
Descripción
Define el valor límite superior como valor absoluto dependiendo del formato de datos, o lo
retorna.
Si el valor que se ha de visualizar sobrepasa el valor límite superior, él será marcado con una
secuencia de *** como si no fuera representable.
Descripción
Define el valor límite inferior como valor absoluto dependiendo del formato de datos, o lo
retorna.
Si el valor que se ha de visualizar sobrepasa el valor límite superior, él será marcado con una
secuencia de *** como si no fuera representable.
Descripción
TRUE si se debe visualizar una posición de medición bloqueada. Acceso de escritura y lectura
BOOLEAN.
Descripción
Define la rotulación de los botones de comando para una posición de medición bloqueada.
La propiedad LockStatus debe tener el valor TRUE para que se pueda visualizar la rotulación.
Descripción
Define el color de la rotulación del botón de comando para una posición bloqueada de
medición, o lo retorna. Acceso de escritura y lectura LONG.
La propiedad LockStatus debe tener el valor TRUE para que se pueda visualizar el color de
fondo.
Descripción
TRUE si en la representación de la escala se deben visualizar en negrita las graduaciones
largas. Acceso de escritura y lectura BOOLEAN.
Descripción
TRUE si en la representación de la escala se deben visualizar únicamente las graduaciones
largas. Acceso de escritura y lectura BOOLEAN.
Descripción
Determina si han de representarse solo las marcas grandes de la escala.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowLargeTicksOnly[=BOOLEAN]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Bar
BOOLEAN
Opcional. TRUE si se representan solo las marcas grandes de la escala.
Descripción
Retorna el valor que define las graduaciones que deberán ser rotuladas en la visualización
de la escala (1 = cada graduación, 2 = cada segunda graduación, etc.). Sólo acceso de lectura.
Descripción
Establece el color que marca los valores de variable de la curva indicada situados por debajo
del valor de "LowerLimitValue(i)". El dato se evaluará o no dependiendo de la propiedad
"LowerLimitEnabled(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.LowerLimitColor(i)[=Color]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl",
"FunctionTrendControl" u "OnlineTableControl".
Color
Opcional. Valor o constante que establece el color que marca los valores de variable de la
curva indicada situados por debajo del valor de "LowerLimitValue(i)".
Observaciones
El parámetro i indica el número de la curva.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
OnlineTableControl (Página 1434)
Descripción
Determina si se utiliza el dato de "LowerLimitColor(i)" para marcar los valores de variable
situados por debajo del valor de "LowerLimitValue(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.LowerLimitEnabled(i)[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl",
"FunctionTrendControl" u "OnlineTableControl".
BOOLEAN
Opcional. TRUE si se utiliza el dato de "LowerLimitColor(i)" para marcar los valores de variable
situados por debajo del valor de "LowerLimitValue(i)".
Observaciones
El parámetro i indica el número de la curva.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
OnlineTableControl (Página 1434)
Descripción
???Determina si los valores de variable situados por debajo del valor de "LowerLimitValue(i)"
se marcan con el color definido en "LowerLimitColor(i)". El dato se evaluará o no dependiendo
del valor del atributo "LowerLimitEnabled(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.LowerLimitValue(i)[=Double]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl" o
"FunctionTrendControl".
Double
Opcional. Valor o constante que determina si los valores de variable situados por debajo del
valor de "LowerLimitValue(i)" se marcan con el color definido en "LowerLimitColor(i)".
Observaciones
El parámetro i indica el número de la curva.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
TRUE si se deben visualizar los valores límite como valor de escala. Acceso de escritura y
lectura BOOLEAN.
Descripción
TRUE si el objeto en Runtime se puede maximizar. Sólo acceso de lectura.
Descripción
Define el color del fondo para el estado de intermitencia "Off" para el estado "Desaparecido
no acusado", o lo retorna. Acceso de escritura y lectura LONG.
Descripción
Define el color del fondo para el estado de intermitencia "On" para el estado "Desaparecido
no acusado", o lo retorna. Acceso de escritura y lectura LONG.
Descripción
TRUE si el fondo debe ser intermitente cuando un aviso desaparece sin acuse. Acceso de
escritura y lectura BOOLEAN.
Descripción
Define el color del texto para el estado de parpadeo "Off" en el estado "Desaparecido no
acusado", o lo devuelve. Acceso de escritura y lectura LONG.
Descripción
Define el color de fondo del texto para el estado de parpadeo "On" en el estado "Desaparecido
no acusado", o lo devuelve. Acceso de escritura y lectura LONG.
Descripción
TRUE si la fuente debe ser intermitente cuando un aviso desaparece sin acuse. Acceso de
escritura y lectura BOOLEAN.
Descripción
Define el color del fondo para el estado de intermitencia "Off" para el estado "Aparecido", o lo
retorna. Acceso de escritura y lectura LONG.
Descripción
Define el color del fondo para el estado de intermitencia "On" para el estado "Aparecido", o lo
retorna. Acceso de escritura y lectura LONG.
Descripción
TRUE si el fondo debe ser intermitente cuando aparece un aviso. Acceso de escritura y lectura
BOOLEAN.
Descripción
Define el color del texto para el estado de parpadeo "Off" en el estado "Aparecido", o lo
devuelve. Acceso de escritura y lectura LONG.
Descripción
Define el color de fondo del texto para el estado de parpadeo "On" en el estado "Aparecido",
o lo devuelve. Acceso de escritura y lectura LONG.
Descripción
TRUE si la fuente debe ser intermitente cuando aparece un aviso. Acceso de escritura y lectura
BOOLEAN.
Descripción
Define el color del fondo para el estado de intermitencia "Off" para el estado "Desaparecido
acusado", o lo retorna. Acceso de escritura y lectura LONG.
Descripción
Define el color del fondo para el estado de intermitencia "On" para el estado "Desaparecido
acusado", o lo retorna. Acceso de escritura y lectura LONG.
Descripción
TRUE si el fondo debe ser intermitente cuando un aviso desaparece con acuse. Acceso de
escritura y lectura BOOLEAN.
Descripción
Define el color del texto para el estado de parpadeo "Off" en el estado "Desaparecido
acusado", o lo devuelve. Acceso de escritura y lectura LONG.
Descripción
Define el color de fondo del texto para el estado de parpadeo "On" en el estado "Desaparecido
acusado", o lo devuelve. Acceso de escritura y lectura LONG.
Descripción
TRUE si la fuente debe ser intermitente cuando un aviso desaparece con acuse. Acceso de
escritura y lectura BOOLEAN.
Descripción
Define la rotulación para cada clase de aviso, o la retorna.
Descripción
Define cada violación del límite (alarma High, alarma Low, advertencia High, advertencia
Low, ...) para la que se deben configurar los ajustes "Texto de visualización", "Aparecido -",
"Aparecido acusado -" y "Desaparecido no acusado -".
Descripción
Define la cantidad de líneas que debe tener la lista de selección para el objeto Lista de texto,
o retorna el valor. Si la cantidad del texto proyectado es mayor a este valor, entonces la lista
de selección tendrá una barra de desplazamiento vertical.
Descripción
Retorna el nombre del objeto indicado.
Acceso en runtime: lectura
Sintaxis
Object.ObjectName
Object
Obligatorio. Objeto del tipo "ScreenItem". Ésta es una propiedad estándar del objeto
ScreenItem, por lo que está disponible en todas las apariencias.
Consulte también
Line (Página 1422)
Polyline (Página 1459)
Ellipse (Página 1385)
Circle (Página 1369)
EllipseSegment (Página 1388)
CircleSegment (Página 1372)
EllipticalArc (Página 1390)
CircularArc (Página 1374)
Rectangle (Página 1471)
Descripción
TRUE si el objeto en Runtime permanece siempre en el primer plano. Sólo acceso de lectura.
Descripción
TRUE si en un manejo exitoso se debe editar un aviso. Acceso de escritura y lectura
BOOLEAN.
El manejo se envía entonces al sistema de avisos y se archiva. Por medio del sistema de
aviso se puede emitir un aviso, por ejemplo, en una línea de avisos.
Descripción
TRUE también si se debe protocolizar la razón de un manejo. Acceso de escritura y lectura
BOOLEAN.
En Runtime, durante la manipulación de un objeto, aparece un cuadro de diálogo, en el cual
el usuario puede introducir el motivo de la manipulación en forma de texto.El manejo es
enviado al sistema de aviso y será archivado.
Descripción
Establece la dirección del texto del objeto indicado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Orientation[=TextOrientation]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "TextField", "IOField",
"SymbolicIOField", "Button", "Switch", "Bar", "OnlineTrendControl", "FunctionTrendControl",
"Checkbox", "OptionGroup" o "WindowSlider".
TextOrientation
hmiTextHorizontal ( 0): el texto se muestra horizontalmente.
hmiTextRotated90Degree (-1): el texto se muestra verticalmente y alineado a la izquierda.
hmiTextRotated270Degree ( 1): el texto se muestra verticalmente y alineado a la derecha.
Consulte también
TextField (Página 1505)
IOField (Página 1418)
SymbolicIOField (Página 1491)
Button (Página 1360)
Switch (Página 1488)
Bar (Página 1353)
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
CheckBox (Página 1366)
OptionGroup (Página 1453)
WindowSlider (Página 1538)
Descripción
Retorna el valor para la representación del valor de salida. La representación depende del
formato de datos. Sólo acceso de lectura.
Descripción
Define el valor predeterminado para el valor que se va a visualizar, o lo retorna.
Este valor se utiliza en Runtime cuando al iniciarse la imagen no está anexada o actualizada
la variable perteneciente.
Descripción
Establece el permiso de operación necesario para poder modificar el ajuste de la persistencia
en runtime. El valor que debe introducirse corresponde al número que posee el permiso
deseado en la administración de usuarios. El dato se evaluará o no dependiendo del valor de
la propiedad "AllowPersistance". Esto no se aplica al visor de avisos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.PersistentRTAuthorization[=RtAuthorization]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "AlarmControl",
"OnlineTrendControl", "FunctionTrendControl" o "OnlineTableControl".
RtAuthorization
Opcional. Valor o constante que establece el permiso de operación para poder modificar el
ajuste de la persistencia.
Consulte también
AlarmControl (Página 1338)
Descripción
Determina si los ajustes modificados de la ventana también se conservan tras un cambio de
imagen.
Acceso en runtime: lectura y escritura
Sintaxis
Object.PersistentRuntime[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl",
"FunctionTrendControl" u "OnlineTableControl".
BOOLEAN
Opcional. TRUE si los ajustes modificados de la ventana también se conservan tras un cambio
de imagen.
Observaciones
La propiedad "AllowPersistance" determina si el dato se evalúa.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
OnlineTableControl (Página 1434)
Descripción
Establece el permiso de acceso para modificar el ajuste de la persistencia en runtime. El valor
que debe introducirse corresponde al número que posee el permiso deseado en la
administración de usuarios.
Acceso en runtime: lectura y escritura
Sintaxis
Object.PersistentRuntimeAuthorization[=HmiRTAuthorization]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl",
"FunctionTrendControl" u "OnlineTableControl".
HmiRTAuthorization
Opcional. Valor o constante que establece el permiso de acceso para modificar el ajuste de
la persistencia en runtime.
Observaciones
La propiedad "AllowPersistance" determina si el dato se evalúa. Esto no se aplica al visor de
avisos.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
OnlineTableControl (Página 1434)
Descripción
TRUE si se guarda la imagen asignada para el estado "Desactivado" en el objeto
RoundButton. De no ser así se guardará únicamente la referencia del objeto perteneciente.
Sólo acceso de lectura.
Descripción
Define cuál color del objeto Bitmap (.bmp, .dib) asignado para el estado "Desactivado" deberá
ser ajustado en "transparent", o retorna el color. Acceso de lectura y escritura LONG.
Para ese color sólo se activará "Transparente", si la propiedad "PicDeactUseTransColor" tiene
el valor TRUE.
Descripción
TRUE si se debe utilizar para el estado "Desactivado" el color transparente definido con la
propiedad "PicDeactTransparent". Acceso de escritura y lectura BOOLEAN.
Descripción
Define cuál color del objeto Bitmap (.bmp, .dib) asignado para el estado "On" deberá ser
ajustado en "transparent", o retorna el color. Acceso de lectura y escritura LONG.
Para ese color sólo se activará "Transparente", si la propiedad "PicDownUseTransColor" tiene
el valor TRUE.
Descripción
TRUE si se debe utilizar para el estado "On" el color transparente definido con la propiedad
"PicDownTransparent". Acceso de escritura y lectura BOOLEAN.
Descripción
Define cuál color del objeto Bitmap asignado (.bmp, .dib) deberá ser definido en "transparent"
o retorna el color. Acceso de lectura y escritura LONG.
Para ese color sólo se activará "Transparente", si la propiedad "PicUseTransColor" tiene el
valor TRUE.
Descripción
Establece la ruta y nombre de fichero de la imagen de fondo o los devuelve. Acceso de
escritura y lectura LONG.
Descripción
Define la imagen que se visualiza en el estado "Off", o retorna el nombre de la imagen.
La imagen (*.BMP o *.DIB) debe estar en la carpeta "GraCS" del proyecto actual, para que
pueda ser insertada.
Descripción
Define cuál color del objeto Bitmap (.bmp, .dib) asignado para el estado "Off" deberá ser
ajustado en "transparent", o retorna el color. Acceso de lectura y escritura LONG.
Para ese color sólo se activará "Transparente", si la propiedad "PicUpUseTransColor" tiene
el valor TRUE.
Descripción
TRUE si se debe utilizar para el estado "Off" el color transparente definido con la propiedad
"PicUpTransparent". Acceso de escritura y lectura BOOLEAN.
Descripción
TRUE si se debe utilizar para el estado "Desactivado" el color transparente definido con la
propiedad "PicDeactTransparent". Acceso de escritura y lectura BOOLEAN.
Descripción
Determina si la visualización de la ventana de imagen en Runtime depende de la imagen de
proceso en la que se proyectó dicha ventana.
Descripción
Define la cantidad de puntos de esquina, o los retorna. Cada punto de esquina tiene
coordenadas de posición y será identificado por medio de un índice.
Descripción
Define el trabajo de impresión que activa la función de impresión botón "Imprimir" de la barra
de herramientas. El trabajo de impresión recomendado para Control esta preconfigurado.
Mediante el botón de selección se abre el cuadro de diálogo "Seleccionar trabajo de impresión"
para la selección de un trabajo de impresión.
Sintaxis
Object.PrintJobName]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "AlarmControl",
"FunctionTrendControl", "OnlineTableControl", "OnlineTrendControl", "TrendRulerControl",
"UserArchiveControl".
Consulte también
AlarmControl (Página 1338)
Descripción
Determina si solo aparecen las columnas actualmente visibles en la impresión rápida.
Acceso en runtime: lectura y escritura
Sintaxis
Object.PrintVisibleColumnsOnly[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "UserArchiveControl".
BOOLEAN
Opcional. TRUE si solo aparecen las columnas actualmente visibles en la impresión rápida.
Descripción
Define el valor predeterminado para el valor que se va a visualizar, o lo retorna.
Este valor se utiliza en Runtime cuando al iniciarse la imagen no está anexada o actualizada
la variable perteneciente.
Descripción
Determina si el Control tiene acceso de lectura y escritura en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ReadOnly[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "UserArchiveControl".
BOOLEAN
Opcional. TRUE si el Control tiene acceso de lectura y escritura en runtime.
Descripción
Define la coordenada x del punto de referencia alrededor de la cual se debe girar el objeto en
Runtime, o la retorna.
El valor de la coordenada x es relativo al ancho del objeto. Indique en porcentaje el valor
partiendo del canto izquierdo del rectángulo que circunda al objeto.
Descripción
Define la coordenada y del punto de referencia alrededor de la cual se debe girar el objeto en
Runtime, o la retorna.
El valor de la coordenada y es relativo a la altura del objeto. Indique en porcentaje el valor
partiendo del canto superior del rectángulo que circunda al objeto.
Descripción
TRUE si se considera el objeto para la formación del indicador de grupo. Acceso de escritura
y lectura BOOLEAN.
Descripción
Define la cantidad de dígitos a la derecha de la coma (0 hasta 20), o los retorna.
Descripción
Muestra la autorización para la configuración online. A través del botón de selección puede
modificar el permiso. Los permisos se configuran en la administración de usuarios.
Sintaxis
Object.RTPersistencePasswordLevel
Object
Necesario. Objeto del tipo "ScreenItem" con las especificaciones "AlarmControl",
"OnlineTrendControl", "TrendRulerControl", "UserArchiveControl" u "OnlineTableControl"
(Runtime Professional) o bien "HMITrendView" (Runtime Advanced).
Consulte también
AlarmControl (Página 1338)
UserArchiveControl (Página 1528)
Descripción
TRUE si los cuatro botones en el objeto GroupDisplay tienen el mismo tamaño. Acceso de
escritura y lectura BOOLEAN.
Descripción
Define la cantidad de segmentos en los que se subdividirá la barra por medio de las
graduaciones grandes de la escala:
0-100: El objeto se puede subdividir en máximo 100 segmentos
= 0: Se definirá automáticamente la cantidad óptima de segmentos
Descripción
TRUE si el objeto en Runtime tiene barras de desplazamiento. Sólo acceso de lectura.
Descripción
Define el desplazamiento horizontal de la barra de desplazamiento de la imagen en una
ventana de imagen con barras de desplazamiento o retorna el valor.
La imagen se representa en la ventana de imagen con el desplazamiento horizontal o vertical
de las barras de desplazamiento de la imagen. Si desea representar la imagen recortada en
la que las barras de desplazamiento de la imagen están ubicadas en el borde izquierdo y en
el borde superior de la imagen, utilice las propiedades "OffsetLeft" y "OffsetTop" para el origen
de esta área.
Descripción
Define el desplazamiento vertical de la barra de desplazamiento de la imagen en una ventana
de imagen con barras de desplazamiento o retorna el valor.
La imagen se representa en la ventana de imagen con el desplazamiento horizontal o vertical
de las barras de desplazamiento de la imagen. Si desea representar la imagen recortada en
la que las barras de desplazamiento de la imagen están ubicadas en el borde izquierdo y en
el borde superior de la imagen, utilice las propiedades "OffsetLeft" y "OffsetTop" para el origen
de esta área.
Descripción
Define el color de fondo para la entrada seleccionada en el objeto Lista de texto, o lo retorna.
Acceso de escritura y lectura LONG.
Descripción
Define si se puede seleccionar y cómo se puede seleccionar una línea de avisos.
.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SelectionMode[=Mode]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "MessageView".
Mode
0 - NoSelection: Evita la selección de un aviso. Un acuse repercute siempre en el aviso
pendiente más antiguo.
1 - Cell: Permite la selección de campos en una línea de avisos. Un acuse repercute siempre
en el aviso seleccionado.
2 - Line: Permite la selección de una línea de avisos. Un acuse repercute siempre en el aviso
seleccionado.
Descripción
Determina si se puede seleccionar y cómo se puede seleccionar una línea de avisos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SelectionMode[=AlarmViewAdvancedSelectionMode]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
AlarmViewAdvancedSelectionMode
hmiAlarmViewAdvancedSelectionModeNone ( 0): evita la selección de un aviso. Un acuse
repercute siempre en el aviso pendiente más antiguo.
hmiAlarmViewAdvancedSelectionModeCell ( 1): permite la selección de campos en la línea
de avisos. Un acuse repercute siempre en el aviso seleccionado.
hmiAlarmViewAdvancedSelectionModeLine ( 2): permite la selección de una línea de avisos.
Un acuse repercute siempre en el aviso seleccionado.
Consulte también
AlarmControl (Página 1338)
Descripción
Define el color de texto de la entrada seleccionada del objeto Lista de texto, o lo retorna.
Acceso de escritura y lectura LONG.
Descripción
Determina si los contenidos de los campos de una línea de avisos se acortan cuando el ancho
de columna es demasiado pequeño.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShortenCellText[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
BOOLEAN
Opcional. TRUE si los contenidos de los campos de una línea de avisos se acortan cuando
el ancho de columna es demasiado pequeño.
Consulte también
AlarmControl (Página 1338)
Descripción
Determina si los contenidos de los campos de una barra de título deben acortarse cuando el
ancho de columna es demasiado pequeño.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShortenColumnHeaderText[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
BOOLEAN
Opcional. TRUE si los contenidos de los campos de una barra de título deben acortarse
cuando el ancho de columna es demasiado pequeño.
Consulte también
AlarmControl (Página 1338)
Descripción
Determina si las columnas del visor de avisos quedan separadas por líneas verticales.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowVerticalGridlines[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
BOOLEAN
Opcional. TRUE si las columnas del visor de avisos quedan separadas por líneas verticales.
Consulte también
AlarmControl (Página 1338)
Descripción
Determina si un valor de la coordenada X se muestra en notación exponencial. El dato se
evaluará o no dependiendo del valor de la propiedad "XAxisMode(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowXValuesExponential(i)[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendControl".
BOOLEAN
Opcional. TRUE si un valor de la coordenada X se muestra en notación exponencial.
Observaciones
El parámetro i indica el número de la curva.
Se utiliza la función "Muestra el valor en este punto" para mostrar la coordenada X de la
medida.
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Determina si un valor de la coordenada Y se muestra en notación exponencial. El dato se
evaluará o no dependiendo del valor de la propiedad "XAxisMode(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowYValuesExponential(i)[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendControl".
BOOLEAN
Opcional. TRUE si un valor de la coordenada Y se muestra en notación exponencial.
Observaciones
El parámetro i indica el número de la curva.
Se utiliza la función "Muestra el valor en este punto" para mostrar la coordenada Y de la
medida.
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Se necesita en Runtime para la representación de la clase de aviso activa con la prioridad
más alta.
El valor de la propiedad SignificantMask representa un valor de salida interno del sistema y
no requiere ninguna configuración específica por el usuario. La actualización se realiza en
Runtime haciendo clic en el objeto.
Descripción
Determina si puede modificarse el sentido de clasificación en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SortByTimeEnable[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
BOOLEAN
Opcional. TRUE si puede modificarse el sentido de clasificación en runtime.
Consulte también
AlarmView (Página 1350)
Descripción
Determina si los bloques de aviso pueden clasificarse por el título de las columnas de los
bloques de aviso.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SortOnColumnHeaderClick[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
BOOLEAN
Opcional. TRUE, si los bloques de aviso pueden clasificarse por el título de las columnas de
los bloques de aviso.
Consulte también
AlarmControl (Página 1338)
Descripción
Determina si el último aviso que se ha recibido se debe visualizar en el lado superior del objeto
"MessageView" (orden ascendente).
Acceso en runtime: lectura y escritura
Sintaxis
Object.SortTimeAscending [= BOOLEAN]
Object
Obligatorio. Objeto del tipo "MessageView".
BOOLEAN
Opcional. TRUE si se debe visualizar el último aviso que se ha recibido.
Descripción
Determina si el orden de los avisos se puede modificar según la hora en el objeto
"MessageView".
Acceso en runtime: lectura y escritura
Sintaxis
Object.SortTimeEnable [= BOOLEAN]
Object
Obligatorio. Objeto del tipo "MessageView".
BOOLEAN
Opcional. TRUE si el operador puede cambiar el orden en el equipo.
Descripción
Determina la distancia horizontal desde el borde izquierdo de la imagen en píxeles.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StartPointLeft[=Int]
Object
Obligatorio. Un objeto del tipo ""ScreenItem" con la especificación "Line"".
Int
Opcional. Un valor que determina la distancia horizontal del punto inicial desde el borde
izquierdo de la imagen en píxeles.
Consulte también
EllipseSegment (Página 1388)
CircleSegment (Página 1372)
EllipticalArc (Página 1390)
CircularArc (Página 1374)
Descripción
La propiedad "Index" hace referencia a una curva. "TagName"define la variable que está
vinculada a esta curva. La indicación se realiza en la forma "Nombre de fichero/de variable"
para la representación de variables de un fichero de valores del proceso, o "Nombre de
variable" para la representación de una variable interna o externa que no se va a guardar en
un fichero.
Descripción
Determina si la ventana de curvas se representa con líneas de retícula paralelas al eje x.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeAxisShowGridLines(i)[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "OnlineTrend".
BOOLEAN
Opcional. TRUE si la ventana de curvas se representa con líneas de retícula paralelas al eje
x.
Observaciones
La distancia entre dos líneas de retícula puede modificarse por medio de la propiedad
"TimeAxisGridLineInterval(i)"..
Consulte también
OnlineTrendControl (Página 1443)
Descripción
Define el formato de las columnas de tiempos para el par de columnas especificado. El
parámetro i indica el número del par de columnas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeColumnFormat(i)[=TimeFormat]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTableControl".
TimeFormat
( 0): los datos tienen el formato hh:mm
( 1): los datos tienen el formato hh:mm:ss
( 2): los datos tienen el formato hh:mm:ss.ms
( 3): los datos tienen el formato hh:mm (horas enteras)
( 4): los datos tienen el formato hh:mm:ss (minutos enteros)
( 5): los datos tienen el formato hh:mm:ss.ms (segundos enteros)
( 6): los datos tienen el formato dd_mm_yy_hh_mm
( 7): los datos tienen el formato dd_mm_yy_hh_mm (hora entera)
Consulte también
OnlineTableControl (Página 1434)
Descripción
Indica el color de fondo del título de la tabla para el estado seleccionado. Con el botón se abre
el cuadro de diálogo para la selección de color.
Descripción
TRUE si el control posee una barra de título y se puede desplazar en Runtime. Acceso de
escritura y lectura BOOLEAN.
Descripción
Define el valor límite para "Toleranz high", o lo retorna.
El tipo de evaluación (porcentual o absoluta) lo define Ud. con la propiedad
TypeToleranceHigh.
La supervisión del valor límite será efectiva únicamente cuando la propiedad
CheckToleranceHigh está activada en "True".
Descripción
Define el valor límite para "Toleranz low", o lo retorna.
El tipo de evaluación (porcentual o absoluta) lo define Ud. con la propiedad TypeToleranceLow.
La supervisión del valor límite será efectiva únicamente cuando la propiedad
CheckToleranceLow está activada en "True".
Descripción
Indica el número de índice del punto conector superior o lo establece.
Acceso de escritura y lectura Long
Descripción
Indica el nombre de objeto del objeto que está acoplado en el punto conector superior, o lo
define.
Acceso de escritura y lectura Long
Descripción
TRUE si la tendencia (ascendente o descendente) del valor de medición a ser supervisado
debe ser visualizado con una pequeña flecha. Acceso de escritura y lectura BOOLEAN.
Descripción
Determina qué variable está vinculada a la curva indicada.
Los valores se indican en la forma "Nombre de fichero\Nombre de variable" para la
representación de variables de un fichero de valores del proceso, o bien en la forma "Nombre
de variable" para la representación de una variable interna o externa que no está guardada
en un fichero.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TrendTag[=HmiTag]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "OnlineTrend".
HmiTag
Opcional. Un valor o una constante que determina la variable que está vinculada a la curva
indicada.
Observaciones
El parámetro i indica el número de la curva.
Consulte también
OnlineTrendControl (Página 1443)
Descripción
TRUE si el valor límite superior en el que se activa la alarma se evalúa porcentualmente.
FALSE si la evaluación se debe realizar de manera absoluta. Acceso de escritura y lectura
BOOLEAN.
Descripción
TRUE si el valor límite inferior en el que se activa la alarma se evalúa porcentualmente. FALSE
si la evaluación se debe realizar de manera absoluta. Acceso de escritura y lectura BOOLEAN.
Descripción
TRUE si el valor límite superior "Reserve 4" se evalúa porcentualmente. FALSE si la
evaluación se debe realizar de manera absoluta. Acceso de escritura y lectura BOOLEAN.
Descripción
TRUE si el valor límite superior "Reserve 5" se evalúa porcentualmente. FALSE si la
evaluación se debe realizar de manera absoluta. Acceso de escritura y lectura BOOLEAN.
Descripción
TRUE si el valor límite inferior "Reserve 4" se evalúa porcentualmente. FALSE si la evaluación
se debe realizar de manera absoluta. Acceso de escritura y lectura BOOLEAN.
Descripción
TRUE si el valor límite inferior "Reserve 5" se evalúa porcentualmente. FALSE si la evaluación
se debe realizar de manera absoluta. Acceso de escritura y lectura BOOLEAN.
Descripción
TRUE si el valor límite inferior "Toleranz high" se evalúa porcentualmente. FALSE si la
evaluación se debe realizar de manera absoluta. Acceso de escritura y lectura BOOLEAN.
Descripción
TRUE si el valor límite inferior "Toleranz low" se evalúa porcentualmente. FALSE si la
evaluación se debe realizar de manera absoluta. Acceso de escritura y lectura BOOLEAN.
Descripción
TRUE si el valor límite inferior "Warning high" se evalúa porcentualmente. FALSE si la
evaluación se debe realizar de manera absoluta. Acceso de escritura y lectura BOOLEAN.
Descripción
TRUE si el valor límite inferior "Warning low" se evalúa porcentualmente. FALSE si la
evaluación se debe realizar de manera absoluta. Acceso de escritura y lectura BOOLEAN.
Descripción
Define el color para la identificación de valores con estado incierto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UncertainStateColor(i)[=Color]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl" o
"FunctionTrendControl".
Color
Opcional. Valor o constante que define el color para la identificación de valores con estado
incierto.
Observaciones
El parámetro i indica el número de la curva.
Si se desconoce el valor inicial de un valor después de activar runtime o si se utiliza un valor
sustitutivo, el valor tiene un estado incierto.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Determina si los valores con estado incierto se identifican con el color definido en
"ReplacementColor(i)".
Los valores con valor inicial desconocido después de activar runtime o para los que se utiliza
un valor sustitutivo tienen un estado incierto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UncertainStateEnabled(i)[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl" o
"FunctionTrendControl".
BOOLEAN
Opcional. TRUE si los valores con estado incierto se identifican con el color definido en
""ReplacementColor(i)".
Observaciones
El parámetro i indica el número de la curva.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Determina si puede modificarse el visor de recetas en runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UpdateEnable[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "UserArchiveControl".
BOOLEAN
Opcional. TRUE si puede modificarse el visor de recetas en runtime.
Descripción
Establece el color que marca los valores de variable que se encuentran por encima del valor
""UpperLimitValue(i)". El dato se evaluará o no dependiendo del valor de la propiedad
"UpperLimitEnabled(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.UpperLimitColor(i)[=Color]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl",
"FunctionTrendControl" u "OnlineTableControl".
Color
Opcional. Un valor o una constante que identifica los valores de variables situados por encima
del valor de "UpperLimitValue(i)".
Observaciones
El parámetro i indica el número de la curva.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
OnlineTableControl (Página 1434)
Descripción
Determina si se utiliza el dato de "UpperLimitColor(i)" para marcar los valores de variables
situados por encima del valor de "UpperLimitValue(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.UpperLimitEnabled(i)[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl",
"FunctionTrendControl" u "OnlineTableControl".
BOOLEAN
Opcional. TRUE si se utiliza el dato de "UpperLimitColor(i)" para marcar los valores de variable
situados por encima del valor de "UpperLimitValue(i)".
Observaciones
El parámetro i indica el número de la curva.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
OnlineTableControl (Página 1434)
Descripción
Determina si los valores de variable situados por encima del valor de "UpperLimitValue(i)" se
marcan con el color definido en "UpperLimitColor(i)". El dato se evaluará o no dependiendo
del valor de la propiedad "UpperLimit(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.UpperLimitValue(i)[=Double]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl" o
"FunctionTrendControl"..
Double
Opcional. Valor o constante que determina si los valores de variable situados por encima del
valor de "UpperLimitValue(i)" se marcan con el color definido en "UpperLimitColor(i)".
Observaciones
El parámetro i indica el número de la curva.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Determina si los datos que deben representarse en la ventana de avisos son solicitados por
todos los servidores incluidos en un sistema distribuido. En los servidores participantes debe
estar activado el Alarm Logging.
Acceso en runtime: sólo lectura
Sintaxis
Object.UseAllServers[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "AlarmView".
BOOLEAN
Opcional. TRUE, si los datos que deben representarse en la ventana de avisos son solicitados
por todos los servidores incluidos en un sistema distribuido.
Consulte también
AlarmControl (Página 1338)
Descripción
Define un valor cualquiera, o lo retorna.
Ud. puede hacer que p. ej. un guión evalúe el valor. En Runtime no se evalúa ni se visualiza
este valor.
Descripción
Define un valor cualquiera, o lo retorna.
Ud. puede hacer que p. ej. un guión evalúe el valor. En Runtime no se evalúa ni se visualiza
este valor.
Descripción
Define un valor cualquiera, o lo retorna.
Ud. puede hacer que p. ej. un guión evalúe el valor. En Runtime no se evalúa ni se visualiza
este valor.
Descripción
Define un valor cualquiera, o lo retorna.
Ud. puede hacer que p. ej. un guión evalúe el valor. En Runtime no se evalúa ni se visualiza
este valor.
Descripción
Define el número de decimales del rango de valores de la curva especificada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ValueAxisDecimalPrecision(i)[=Int]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrend" o
"FunctionTrendView"..
Int
Opcional. Valor o constante que establece el número de decimales del rango de valores de
la curva especificada.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Determina si la ventana de curvas se representa con líneas de cuadrícula paralelas al eje Y.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ValueAxisShowGridLines(i)[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl" o
"FunctionTrendControl".
BOOLEAN
Opcional. TRUE si la ventana de curvas se representa con líneas de cuadrícula paralelas al
eje Y.
Observaciones
La distancia entre dos líneas de cuadrícula puede modificarse mediante la propiedad
"ValueAxisGridLineInterval(i)".
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Define el número de decimales que se muestran en esta columna de valores. El parámetro i
indica el número del par de columnas. Se pueden mostrar hasta 16 decimales.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ValueColumnPrecision(i)[=Int]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTableControl".
Int
Opcional. Valor o constante que define el número de decimales que se muestran en esta
columna de valores.
Consulte también
OnlineTableControl (Página 1434)
Descripción
Define el valor límite superior "Warning High", o lo retorna.
La propiedad "CheckWarningHigh" debe estar activada en TRUE para que se supervise el
valor límite.
La representación al llegar al valor límite y el tipo de evaluación se definen por medio de las
propiedades "ColorWarningHigh" y "TypeWarningHigh".
Descripción
Define el valor límite inferior "Warning Low", o lo retorna.
La propiedad "CheckWarningLow" debe estar activada en TRUE para que se supervise el
valor límite.
La representación al llegar al valor límite y el tipo de evaluación se definen por medio de las
propiedades "ColorWarningLow" y "TypeWarningLow".
Descripción
Determina el estilo con el que se representa el objeto.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StyleSettings[=WinCCStyle]
Object
Obligatorio. Objeto del tipo "ScreenItem" con la apariencia siguiente:
● Button
● RoundButton
● WindowsSlider
WinCCStyle
Opcional. Valor o constante que determina el estilo con el que se representa el objeto.
Descripción
TRUE si la ventana en Runtime se visualiza con borde. Sólo acceso de lectura.
Descripción
Establece el límite inferior del eje X de una curva referenciada con la propiedad
"CurrentCurveIndex". La indicación se evaluará o no en función de las propiedades
"XAxisAutorange(i)" y "ShareXAxis".
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisBegin(i)[=String]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "FunctionTrendView".
String
Opcional. Un valor o una constante que establece el límite inferior del eje X de una curva
referenciada con la propiedad "CurrentCurveIndex".
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Establece el límite superior del eje X de una curva referenciada con "CurrentCurveIndex". La
indicación se evaluará o no en función de las propiedades "XAxisAutorange(i)" y "ShareXAxis".
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisEnd(i)[=String]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "FunctionTrendView".
String
Opcional. Un valor o una constante que establece el límite superior del eje X de una curva
referenciada con "CurrentCurveIndex".
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Determina si la ventana de curvas se representa con líneas de retícula paralelas al eje X. La
distancia entre dos líneas de retícula puede modificarse por medio de la propiedad
"XAxisGridLineInterval(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisShowGridLines(i)[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "FunctionTrendView".
BOOLEAN
Opcional. TRUE cuando la ventana de curvas se representa con líneas de retícula paralelas
al eje X.
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Define si los datos que se van a representar se solicitarán del servidor de avisos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Activate[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
BOOLEAN
Opcional. TRUE si los datos que se van a representar se solicitan del servidor de avisos.
Consulte también
AlarmControl (Página 1338)
Descripción
Determina si el ancho del borde 3D se representa en el estilo general de Windows.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AdjustBorder3DWithStyle[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Button".
BOOLEAN
Opcional. TRUE si el ancho del borde 3D se representa en el estilo general de Windows.
Consulte también
Button (Página 1360)
Descripción
Define un SQL-Statement para la selección de los avisos mostrados en la ventana de avisos.
Alarmlist and hitlist filtering and sorting settings
Acceso en runtime: lectura y escritura
Sintaxis
Object.AlarmFilter[=String]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
String
Opcional. Valor o constante que define un SQL-Statement para la selección de los avisos
mostrados en la ventana de avisos.
Consulte también
AlarmControl (Página 1338)
Descripción
Define el ángulo de profundidad a para el efecto 3D del objeto "3DBarGraph", o lo retorna.
Rango de valores en grados de 0 hasta 90.
Descripción
Define el ángulo de profundidad b para el efecto 3D del objeto "3DBarGraph", o lo retorna.
Rango de valores en grados de 0 hasta 90.
Descripción
Define la posición de la barra 3D en el sistema de coordenadas, o retorna el valor. Margen
de valores de 0 hasta 2.
0: La barra 3D se representa en el eje X.
1: La barra 3D se representa en el eje Y.
2: La barra 3D se representa en el eje Z.
Descripción
Define la distancia entre dos secciones extensas del eje, o la retorna. La introducción de la
distancia se realiza en unidades de escala y depende de los valores máximos y mínimos
proyectados.
Descripción
TRUE si el fondo en un objeto 3DBarGraph debe ser visibe. Acceso de escritura y lectura
BOOLEAN.
Descripción
Define la profundidad de barra en píxeles, o la retorna.
Descripción
Define la altura de barra en píxeles, o la retorna.
Descripción
Define la distancia horizontal en píxeles desde el borde de barra derecho hasta el borde
izquierdo del campo de objeto, o la retorna.
Descripción
Define la distancia vertical desde el borde de barra inferior hasta el borde superior, o la retorna.
Descripción
TRUE si la ventana tiene un botón de comando "Cerrar". Sólo acceso de lectura.
Descripción
Determina si puede modificarse el ancho de las columnas de la ventana de avisos. El ancho
de las columnas solo puede modificarse si no está activada la propiedad "AutoScroll".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ColumnSizingEnable[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
BOOLEAN
Opcional. TRUE si puede modificarse el ancho de las columnas de la ventana de avisos.
Consulte también
AlarmControl (Página 1338)
Descripción
Define el color del texto para el estado de parpadeo "Off", o lo devuelve. Acceso de escritura
y lectura LONG.
Descripción
Define el color del texto para el estado de parpadeo "On", o lo devuelve. Acceso de escritura
y lectura LONG.
Descripción
Establece los datos que se insertan para la curva activa.
Acceso en runtime: lectura y escritura
Sintaxis
Object.InsertData(i)[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendControi".
BOOLEAN
Opcional. TRUE si "DataIndex(i)" se ignora y los datos se añaden detrás en el búfer de datos.
FALSE si los datos se insertan en la posición DataIndex(i)" del búfer de datos.
Observaciones
El visor de curvas vuelve a trazarse con cada operación con "InsertData(i)".
Consulte también
FunctionTrendControl (Página 1397)
Descripción
TRUE si se debe supervisar el límite 0. Acceso de escritura y lectura BOOLEAN.
El valor límite y la representación se definen con las propiedades Layer00Value y
Layer00Color.
Descripción
Define el color para el límite 0, o lo retorna. Acceso de lectura y escritura LONG.
Cuando está activada la vigilancia del valor límite (propiedad Layer00Checked), la barra recibe
el color de este atributo cuando se llega al valor límite.
Descripción
Define o devuelve el valor para "Límite 0".
La vigilancia tendrá efecto únicamente cuando la propiedad Layer00Checked tiene el valor
TRUE.
Descripción
TRUE si se debe supervisar el límite 1. Acceso de escritura y lectura BOOLEAN.
El valor límite y la representación se definen con las propiedades Layer01Value y
Layer01Color.
Descripción
Define el color para el límite 1, o lo retorna. Acceso de lectura y escritura LONG.
Cuando está activada la vigilancia del valor límite (propiedad Layer01Checked), la barra recibe
el color de este atributo cuando se llega al valor límite.
Descripción
Define o devuelve el valor para "Límite 1".
La vigilancia tendrá efecto únicamente cuando la propiedad Layer01Checked tiene el valor
TRUE.
Descripción
TRUE si se debe supervisar el límite 2. Acceso de escritura y lectura BOOLEAN.
El valor límite y la representación se definen con las propiedades Layer02Value y
Layer02Color.
Descripción
Define el color para el límite 2, o lo retorna. Acceso de lectura y escritura LONG.
Cuando está activada la vigilancia del valor límite (propiedad Layer02Checked), la barra recibe
el color de este atributo cuando se llega al valor límite.
Descripción
Define o devuelve el valor para "Límite 2".
La vigilancia tendrá efecto únicamente cuando la propiedad Layer02Checked tiene el valor
TRUE.
Descripción
TRUE si se debe supervisar el límite 3. Acceso de escritura y lectura BOOLEAN.
El valor límite y la representación se definen con las propiedades Layer03Value y
Layer03Color.
Descripción
Define el color para el límite 3, o lo retorna. Acceso de lectura y escritura LONG.
Cuando está activada la vigilancia del valor límite (propiedad Layer03Checked), la barra recibe
el color de este atributo cuando se llega al valor límite.
Descripción
Define o devuelve el valor para "Límite 3".
La vigilancia tendrá efecto únicamente cuando la propiedad Layer03Checked tiene el valor
TRUE.
Descripción
TRUE si se debe supervisar el límite 4. Acceso de escritura y lectura BOOLEAN.
El valor límite y la representación se definen con las propiedades Layer04Value y
Layer04Color.
Descripción
Define el color para el límite 4, o lo retorna. Acceso de lectura y escritura LONG.
Cuando está activada la vigilancia del valor límite (propiedad Layer04Checked), la barra recibe
el color de este atributo cuando se llega al valor límite.
Descripción
Define o devuelve el valor para "Límite 4".
La vigilancia tendrá efecto únicamente cuando la propiedad Layer04Checked tiene el valor
TRUE.
Descripción
TRUE si se debe supervisar el límite 5. Acceso de escritura y lectura BOOLEAN.
El valor límite y la representación se definen con las propiedades Layer05Value y
Layer05Color.
Descripción
Define el color para el límite 5, o lo retorna. Acceso de lectura y escritura LONG.
Cuando está activada la vigilancia del valor límite (propiedad Layer05Checked), la barra recibe
el color de este atributo cuando se llega al valor límite.
Descripción
Define o devuelve el valor para "Límite 5".
La vigilancia tendrá efecto únicamente cuando la propiedad Layer05Checked tiene el valor
TRUE.
Descripción
TRUE si se debe supervisar el límite 6. Acceso de escritura y lectura BOOLEAN.
El valor límite y la representación se definen con las propiedades Layer06Value y
Layer06Color.
Descripción
Define el color para el límite 6, o lo retorna. Acceso de lectura y escritura LONG.
Cuando está activada la vigilancia del valor límite (propiedad Layer06Checked), la barra recibe
el color de este atributo cuando se llega al valor límite.
Descripción
Define o devuelve el valor para "Límite 6".
La vigilancia tendrá efecto únicamente cuando la propiedad Layer06Checked tiene el valor
TRUE.
Descripción
TRUE si se debe supervisar el límite 7. Acceso de escritura y lectura BOOLEAN.
El valor límite y la representación se definen con las propiedades Layer07Value y
Layer07Color.
Descripción
Define el color para el límite 7, o lo retorna. Acceso de lectura y escritura LONG.
Cuando está activada la vigilancia del valor límite (propiedad Layer07Checked), la barra recibe
el color de este atributo cuando se llega al valor límite.
Descripción
Define o devuelve el valor para "Límite 7".
La vigilancia tendrá efecto únicamente cuando la propiedad Layer07Checked tiene el valor
TRUE.
Descripción
TRUE si se debe supervisar el límite 8. Acceso de escritura y lectura BOOLEAN.
El valor límite y la representación se definen con las propiedades Layer08Value y
Layer08Color.
Descripción
Define el color para el límite 8, o lo retorna. Acceso de lectura y escritura LONG.
Cuando está activada la vigilancia del valor límite (propiedad Layer08Checked), la barra recibe
el color de este atributo cuando se llega al valor límite.
Descripción
Define o devuelve el valor para "Límite 8".
La vigilancia tendrá efecto únicamente cuando la propiedad Layer08Checked tiene el valor
TRUE.
Descripción
TRUE si se debe supervisar el límite 9. Acceso de escritura y lectura BOOLEAN.
El valor límite y la representación se definen con las propiedades Layer09Value y
Layer09Color.
Descripción
Define el color para el límite 9, o lo retorna. Acceso de lectura y escritura LONG.
Cuando está activada la vigilancia del valor límite (propiedad Layer09Checked), la barra recibe
el color de este atributo cuando se llega al valor límite.
Descripción
Define o devuelve el valor para "Límite 9".
La vigilancia tendrá efecto únicamente cuando la propiedad Layer09Checked tiene el valor
TRUE.
Descripción
TRUE si se debe supervisar el límite 10. Acceso de escritura y lectura BOOLEAN.
El valor límite y la representación se definen con las propiedades Layer10Value y
Layer10Color.
Descripción
Define el color para el límite 10, o lo retorna. Acceso de lectura y escritura LONG.
Cuando está activada la vigilancia del valor límite (propiedad Layer10Checked), la barra recibe
el color de este atributo cuando se llega al valor límite.
Descripción
Define o devuelve el valor para "Límite 10".
La vigilancia tendrá efecto únicamente cuando la propiedad Layer10Checked tiene el valor
TRUE.
Descripción
TRUE si el efecto luminoso está conectado. Acceso de escritura y lectura BOOLEAN.
Descripción
En el objeto Lista de texto retorna el tipo de objeto representado. Sólo acceso de lectura.
Margen de valores de 0 hasta 2.
0 = Decimal
1 = Binario
2 = Bit
Descripción
Determina si puede asignarse y formatearse una fuente para cada idioma de runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Localizable[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl",
"FunctionTrendControl", "OnlineTableControl", "AlarmControl" o "UserArchiveControl".
BOOLEAN
Opcional. TRUE si puede asignarse y formatearse una fuente para cada idioma de runtime.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
OnlineTableControl (Página 1434)
AlarmControl (Página 1338)
Descripción
Define el valor absoluto con visualización completa de valores, o lo retorna. Si la visualización
de la escala está activa, entonces se visualizará este valor.
Descripción
Establece el permiso de operación para poder modificar el ajuste de la persistencia en runtime
y ES. El valor que debe introducirse corresponde al número que posee el permiso deseado
en la administración de usuarios. El dato se evaluará o no dependiendo del valor de la
propiedad "AllowPersistance". Esto no se aplica al visor de avisos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.PersistentRTCSAuthorization[=RtAuthorization]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "AlarmControl",
"OnlineTrendControl", "FunctionTrendControl" o "OnlineTableControl".
RtAuthorization
Opcional. Valor o constante que establece el permiso de operación para poder modificar el
ajuste de la persistencia.
Consulte también
AlarmControl (Página 1338)
Descripción
Determina si los ajustes se conservan hasta la nueva descarga de ES.
Acceso en runtime: lectura y escritura
Sintaxis
Object.PersistentToDownload[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl",
"FunctionTrendControl" u "OnlineTableControl".
BOOLEAN
Opcional. TRUE si los ajustes se conservan hasta la nueva descarga de ES.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
OnlineTableControl (Página 1434)
Descripción
Establece el permiso de acceso para poder modificar los ajustes hasta la próxima descarga
de ES.
Acceso en runtime: lectura y escritura
Sintaxis
Object.PersistentToDownloadAuthorization[=HmiRTAuthorization]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl",
"FunctionTrendControl" u "OnlineTableControl".
HmiRTAuthorization
Opcional. Valor o constante que establece el permiso de acceso para poder modificar los
ajustes hasta la próxima descarga de ES.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
OnlineTableControl (Página 1434)
Descripción
TRUE si se guarda la imagen asignada para el estado "On". De no ser así se guardará
únicamente la referencia del objeto perteneciente. Sólo acceso de lectura.
Descripción
TRUE si se hace una referencia de la imagen asignada y no se guarda en el objeto. Sólo
acceso de lectura.
Descripción
Define el valor predeterminado para la posición del control deslizante.
Este valor se utiliza como valor inicial en Runtime.
Para el manejo del valor del proceso enlazado a este atributo es necesario enlazar el valor
del proceso también al evento "Posición". Puede encontrar el evento "Position" en la ficha
"Evento", en la ramificación SliderCtrl\Temas de propiedad\Propiedades de control\Valor.
Descripción
Define la representación de profundidad en un objeto 3DBarGraph, o la retorna. Margen de
valores de 0 hasta 3.
0 = Caballero
1 = Isométrico
2 = Axionométrico
3 = Definido libremente
Descripción
Establece el protocolo para la impresión.
Acceso en runtime: lectura y escritura
Sintaxis
Object.PrintConfiguration[=HMIPrintConfiguration]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTrendControl",
"FunctionTrendControl", "OnlineTableControl", "AlarmControl" o "UserArchiveControl".
HMIPrintConfiguration
Opcional. Valor o constante que establece el protocolo para la impresión.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
OnlineTableControl (Página 1434)
AlarmControl (Página 1338)
Descripción
Contiene la ruta y el nombre del proyecto correspondiente.
Acceso en runtime: solo lectura
Sintaxis
Object.ProjectPath[=String]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
String
Opcional. Valor o constante que contiene la ruta y el nombre del proyecto correspondiente.
Consulte también
AlarmControl (Página 1338)
Descripción
Determina si puede modificarse la altura de la fila.
La propiedad "RowSizingEnable" solo está desactivada si las propiedades "RowSizingEnable"
y "AdaptFontSizeToLineHeight" tienen el valor FALSE.
Acceso en runtime: lectura y escritura
Sintaxis
Object.RowSizingEnable[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
BOOLEAN
Opcional. TRUE si puede modificarse la altura de la fila.
Consulte también
AlarmControl (Página 1338)
Descripción
Determina si la visualización de imágenes DXF soporta en el modo runtime las funciones
Scroll.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Scrollable[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "DXFView".
BOOLEAN
Opcional. TRUE si la visualización de imágenes DXF soporta en el modo runtime las funciones
Scroll.
Descripción
Determina a partir de qué fecha se deben visualizar los avisos.
Nota
Esta función no filtra los avisos, sino que posiciona el área de visualización de la lista de avisos
a partir de la fecha indicada.
Sintaxis
Object.ShowMessagesAtDate [= DATE]
Object
Obligatorio. Objeto del tipo "MessageView".
Observación
Para asignar SmartTags a la propiedad "ShowMessagesAtDate", formule la asignación como
se indica a continuación:
'Ejemplo 1
HmiRuntime.Screens("Screen_1").ScreenItems("Alarm
view_1").ShowMessagesAtDate = SmartTags("intern_1").Value
'Ejemplo 2
HmiRuntime.Screens("Screen_1").ScreenItems("Alarm
view_1").ShowMessagesAtDate = CDate(SmartTags("intern_1"))
El SmartTag "intern_1" debe ser del tipo "DateTime".
Consulte también
AlarmView (Página 1350)
Descripción
Establece criterios de clasificación en sintaxis SQL para la base de datos.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Sort[=String]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "UserArchiveControl".
String
Opcional. Valor o constante que establece los criterios de clasificación en sintaxis SQL para
la base de datos.
Descripción
Determina si al hacer clic en un Button de un script en runtime se activa la tabla del Controls.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TableFocusOnButtonCommand[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "AlarmView".
BOOLEAN
Opcional. TRUE si al hacer clic en un Button de un script en runtime se activa la tabla del
Controls.
Consulte también
AlarmControl (Página 1338)
Descripción
Define la unidad para determinar los intervalos de tiempo de la curva especificada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeRangeBase(i)[=TagLoggingTimeUnit]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl",
"FunctionTrendControl" u "OnlineTableControl".
TagLoggingTimeUnit
( 1): se definen intervalos de tiempo de milisegundos.
hmiCurveTimeRangeBase500ms ( 500): se definen intervalos de tiempo de 500 ms.
hmiCurveTimeRangeBaseSecond ( 1000): se definen intervalos de tiempo de segundos.
hmiCurveTimeRangeBaseMinute ( 60000): se definen intervalos de tiempo de minutos.
hmiCurveTimeRangeBaseHour ( 3600000): se definen intervalos de tiempo de horas.
hmiCurveTimeRangeBaseDay ( 86400000): se definen intervalos de tiempo de días.
Observaciones
El intervalo de tiempo que se debe representar para la curva i resulta de la multiplicación de
los valores "TimeRangeBase(i)"" y "TimeRangeFactor(i)", interpretándose el valor de
"TimeRangeBase(i)" en milisegundos. Las propiedades "TimeRangeBase(i)" y
"TimeRangeFactor(i)" se evalúan solo si la propiedad "TimeRange" tiene el valor "-1".
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
OnlineTableControl (Página 1434)
Descripción
Determina el factor para la determinación de los intervalos de tiempo de la curva indicada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeRangeFactor(i)[=Int]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con las especificaciones "OnlineTrend",
"FunctionTrendView" o "TableView".
Int
Opcional. Un valor o una constante que determina el factor para la determinación de los
intervalos de tiempo de la curva indicada.
Observaciones
El rango de tiempo que debe representarse para la curva i resulta de la multiplicación de los
valores "TimeRangeBase(i)" y "TimeRangeFactor(i)", interpretándose el valor de
"TimeRangeBase(i)" en milisegundos. Las propiedades "TimeRangeBase(i)" y
"TimeRangeFactor(i)" sólo se evalúan cuando la propiedad "TimeRange" tiene el valor "-1".
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
OnlineTableControl (Página 1434)
Descripción
Determina cómo está definido el rango de tiempo que debe representarse para la curva
indicada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UseTimeRange(i)[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con las especificaciones
"OnlineTrend","FunctionTrendView" o "TableView".
BOOLEAN
Opcional. TRUE si el rango de tiempo que debe representarse está determinado por un
instante de inicio ("TimeAxisBeginTime(i)") y un instante final ("TimeAxisEndTime").
FALSE, si el rango de tiempo que debe representarse está determinado por un instante de
inicio ("TimeAxisBeginTime(i)") y un rango de tiempo "TimeRangeBase(i)" y
"TimeRangeFactor(i)".
Observaciones
El parámetro i indica el número de la curva.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
OnlineTableControl (Página 1434)
Descripción
Determina que se comprueben determinados caracteres del campo "Formato de
representación".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ValidateFormatPattern[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "IOField".
BOOLEAN
Opcional. TRUE si se comprueban determinados caracteres del campo "Formato de
representación".
Consulte también
IOField (Página 1418)
Descripción
Define el límite inferior del rango de valores que se va a representar de la curva especificada.
El dato se evaluará o no dependiendo de las propiedades "Autorange" y "ShareValueAxis".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ValueAxisBegin(i)[=Double]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl" o
"FunctionTrendControl".
Double
Opcional. Valor o constante que define el límite inferior del rango de valores que se va a
representar de la curva especificada.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Define el límite superior del rango de valores que se va a representar de la curva especificada.
El dato se evaluará o no dependiendo de las propiedades "Autorange" y "ShareValueAxis".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ValueAxisEnd(i)[=Double]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl" o
"FunctionTrendControl".
Double
Opcional. Valor o constante que define el límite superior del rango de valores que se va a
representar de la curva especificada.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Define el valor del punto cero de la visualización de la escala.
Define el valor absoluto para el punto cero, o lo retorna.
Descripción
Determina si la visualización de imágenes DXF soporta las funciones de zoom en el modo
runtime.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Zoomable[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "DXFView".
BOOLEAN
Opcional. TRUE si la visualización de imágenes DXF soporta las funciones de zoom en el
modo runtime.
Descripción
Define si los datos que se van a representar se solicitarán del servidor de ficheros.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Active[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl" o
"OnlineTableControl".
BOOLEAN
Opcional. TRUE si los datos que se van a representar se solicitan del servidor de ficheros.
Observaciones
Si no se activa este atributo, se reducen los tiempos de apertura de las imágenes. Modifique
el valor dinámicamente si es necesario.
Para distinguir la propiedad "Activate" del método "Activate", se accede a la propiedad a través
de "Object".
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
Descripción
Define si se adaptará el tamaño de fuente a la altura de la línea.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AdaptFontSizeToLineHeight[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "AlarmControl".
BOOLEAN
Opcional. TRUE si el tamaño de fuente se adapta a la altura de la línea.
Consulte también
AlarmControl (Página 1338)
Descripción
Agrega una entrada.
Descripción
Define si la ventana de regla se adapta al visor de curvas cada vez que se muestra.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AdjustRulerWindow[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTrendControl".
BOOLEAN
Opcional. TRUE si la ventana de regla se adapta al visor de curvas cada vez que se muestra.
Observaciones
TRUE si se desplaza la ventana de regla y a continuación se oculta y se muestra de nuevo,
volverá a representarse en la posición original con el tamaño original.
Consulte también
OnlineTrendControl (Página 1443)
Descripción
Define el valor límite superior en el que se activa la alarma, o lo retorna.
El tipo de evaluación (porcentual o absoluta) se define con la propiedad "TypeAlarmHigh".
Acceso en runtime: lectura y escritura
Sintaxis
Object.AlarmHigh[=REAL]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "Bar".
REAL
Valor para el límite superior
Consulte también
Bar (Página 1353)
Descripción
Define la representación de la escala (izquierda/derecha o arriba/abajo) en función de la
posición del objeto Bar, o la devuelve.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Alignment[=ScalePosition]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "Bar".
ScalePosition
1: derecha o abajo.
0: izquierda o arriba.
Consulte también
Bar (Página 1353)
Descripción
Define la alineación horizontal del texto, o la devuelve. Rango de valores de 0 a 2.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AlignmentLeft[=HorizontalAlignment]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "TextField", "IOField",
"SymbolicIOField", "Button", "RoundButton", "CheckBox", "OptionGroup", "MultilineEdit",
"ComboBox", "ListBox".
HorizontalAlignment
0: alineación izquierda
1: alineación centrada
2: alineación derecha
Descripción
Define si la persistencia es ajustable.
Acceso en runtime: lectura y escritura
Sintaxis
Object.AllowPersistence[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl",
"FunctionTrendControl" u "OnlineTableControl".
BOOLEAN
Opcional. TRUE si la persistencia es ajustable.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
OnlineTableControl (Página 1434)
Descripción
Define el color de barra para la visualización del valor actual, o lo retorna. Acceso de escritura
y lectura LONG.
Descripción
Determina que el campo "Estilo de relleno del fondo" sólo puede leerse.
Acceso en runtime: lectura y escritura
Sintaxis
Object.BackFillStyleReadOnlySpecial[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "IOField".
BOOLEAN
Opcional. TRUE si el campo "Estilo de relleno del fondo" sólo puede leerse.
Consulte también
IOField (Página 1418)
Descripción
Determina el valor del punto cero de la escala.
Acceso en runtime: lectura y escritura
Sintaxis
Object.BarStartValue[=Double]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Bar".
Double
Opcional. Un valor o una constante que determina el valor del punto cero de la escala.
Consulte también
Bar (Página 1353)
Descripción
Define el ancho de barra en píxeles, o lo retorna.
Descripción
Determina el instante de inicio del intervalo de tiempo que se va a mostrar en el visor de
curvas. La propiedad "TagProviderType(i)" debe tener el valor -1.
Acceso en runtime: lectura y escritura
Sintaxis
Object.BeginTime(i)[=Time]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "FunctionTrendControl" o
"OnlineTableControl".
Time
Opcional. Valor o constante que determina el instante de inicio del intervalo de tiempo que se
va a mostrar en el visor de curvas.
Observaciones
El parámetro i indica el número de la curva.
Si se modifica "BeginTime(i)", pueden producirse combinaciones inadmisibles con otros
atributos para la conexión de datos. Por esta razón, antes de modificar "BeginTime(i)", debe
evitarse la aplicación inmediata de la modificación con "FreezeProviderConnections".
Consulte también
FunctionTrendControl (Página 1397)
OnlineTableControl (Página 1434)
Descripción
Define el color de borde para la parte inferior/derecha del objeto, o lo retorna. Acceso de
escritura y lectura LONG.
Descripción
Define el color de borde para la parte superior/izquierda del objeto, o lo retorna. Acceso de
escritura y lectura LONG.
Descripción
Determina la posición del punto central.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CentrePoint[=Point]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con las especificaciones "EllipseSegment",
"CircleSegment", "EllipticalArc" o "CircularArc".
Point
Opcional. Un valor que determina la posición del punto central.
Consulte también
EllipseSegment (Página 1388)
CircleSegment (Página 1372)
EllipticalArc (Página 1390)
CircularArc (Página 1374)
Descripción
Determina la distancia horizontal del punto central desde el borde izquierdo de la imagen en
píxeles.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CentrePointLeft[=Int]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con las especificaciones "EllipseSegment",
"CircleSegment", "EllipticalArc" o "CircularArc".
Int
Opcional. Un valor que determina la distancia horizontal del punto central desde el borde
izquierdo de la imagen en píxeles.
Consulte también
EllipseSegment (Página 1388)
CircleSegment (Página 1372)
EllipticalArc (Página 1390)
CircularArc (Página 1374)
Descripción
Determina la distancia vertical del punto central desde el borde superior de la imagen en
píxeles.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CentrePointTop[=Int]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con las especificaciones "EllipseSegment",
"CircleSegment", "EllipticalArc" o "CircularArc".
Int
Opcional. Un valor que determina la distancia vertical del punto central desde el borde superior
de la imagen en píxeles.
Consulte también
EllipseSegment (Página 1388)
CircleSegment (Página 1372)
EllipticalArc (Página 1390)
CircularArc (Página 1374)
Descripción
Define el color del tope inferior/derecho del objeto Slider, o lo retorna. Acceso de escritura y
lectura LONG.
Descripción
TRUE si en una modificación de color (p. ej. al llegar al valor límite) se debe realizar el cambio
de color segmento por segmento. En el caso de FALSE el cambio de color tiene efecto en
toda la barra. Acceso de escritura y lectura BOOLEAN.
Descripción
Define el color para el tope superior/izquierdo del objeto Slider, o lo retorna. Acceso de
escritura y lectura LONG.
Descripción
Establece el color del par de columnas i. El parámetro i indica el número del par de columnas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ColumnColor(i)[=Color]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTableControl".
Color
Opcional. Valor o constante que establece el color del par de columnas i.
Consulte también
OnlineTableControl (Página 1434)
Descripción
Establece el nombre para el par de columnas indicado. El parámetro i indica el número del
par de columnas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ColumnDisplayName(i)[=String]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTableControl".
String
Opcional. Valor o constante que establece el nombre para el par de columnas indicado.
Consulte también
OnlineTableControl (Página 1434)
Descripción
Determina si la representación del par de columnas indicado es estática o dinámica.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ColumnUpdateEnabled(i)[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTableControl".
BOOLEAN
Opcional. TRUE si la representación del par de columnas es estática.
Observaciones
La propiedad "CurrentColumnIndex" hace referencia al par de columnas activo en ese
momento.
Consulte también
OnlineTableControl (Página 1434)
Descripción
Determina si se fuerza la actualización de los valores mostrados en el control.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Command[=String]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl" o
"OnlineTableControl".
String
Opcional. Valor o constante que determina si se fuerza la actualización de los valores
mostrados en el control.
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
Descripción
Lee o fija el comentario del objeto Alarm.
Descripción
Establece el color del eje X común.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CommonTimeAxisColor[=Color]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTrendControl".
Color
Opcional. Valor o constante que establece el color del eje X común.
Consulte también
OnlineTrendControl (Página 1443)
Descripción
Determina si se utiliza un eje de tiempo común para todas las curvas en el visor de curvas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ConfigureTimeAxis(i)[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTrendControl".
BOOLEAN
Opcional. TRUE si se utiliza un eje de tiempo común para todas las curvas en el visor de
curvas.
Consulte también
OnlineTrendControl (Página 1443)
Descripción
Establece el índice de la curva activa.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CurrentCurveIndex[=Int]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "FunctionTrendControl" o
"OnlineTrendControl".
Int
Opcional. Valor o constante que establece el índice de la curva activa en ese momento.
Observaciones
La propiedad "CurrentCurveIndex" es evaluada por otras propiedades para poder asignar sus
ajustes a una curva determinada. Los valores válidos para el índice oscilan entre 0 y -1. La
propiedad "CurvesCount" contiene el número de curvas que deben mostrarse.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Establece el color de la curva indicada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CurveColor(i)[=Color]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl" o
"FunctionTrendControl".
Color
Opcional. Valor o constante que establece el color de la curva indicada.
Observaciones
El parámetro i indica el número de la curva.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Establece el grosor de la línea de la curva indicada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CurveLineWidth(i)[=Int]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTrendControl".
Int
Opcional. Valor o constante que establece el grosor de la línea de la curva indicada. Rango
de valores de 0 a 10.
Observaciones
El parámetro i indica el número de la curva.
Consulte también
OnlineTrendControl (Página 1443)
Descripción
Devuelve el número de curvas o pares de columnas configurados (visibles o invisibles) de la
ventana.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CurvesCount[=Int]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl" o
"FunctionTrendControl".
Int
Opcional. Valor o constante que devuelve el número de curvas o pares de columnas
configurados (visibles o invisibles) de la ventana.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Determina si la representación de la curva indicada es estática o dinámica.
Acceso en runtime: lectura y escritura
Sintaxis
Object.CurveUpdateEnabled(i)[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTrendControl".
BOOLEAN
Opcional. TRUE si la representación de la curva es estática.
Observaciones
El parámetro i indica el número de la curva.
Consulte también
OnlineTrendControl (Página 1443)
Descripción
Devuelve el índice actual de los datos de la curva actual.
Acceso en runtime: lectura y escritura
Sintaxis
Object.DataIndex(i)[=Int]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendControl".
Int
Opcional. Valor o constante que devuelve el índice actual de los datos de la curva actual.
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Determina qué variable está vinculada con la curva indicada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.DataLogTag[=HmiLoggingTag]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl" o
"OnlineTableControl".
HmiLoggingTag
Opcional. Valor o constante que determina qué variable está vinculada con la curva indicada.
Observaciones
El parámetro i indica el número de la curva.
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
Descripción
Añade un único registro y debe fijarse antes de la llamada de "InsertData(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.DataX(i)[=object]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendControl".
object
Opcional. Valor o constante que añade un único registro.
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Añade varios registros como Array con pares de valores y debe fijarse antes de la llamada de
"InsertData(i)".
Los datos de Array se adoptan si "DataX(i)" es del tipo VT_EMPTY. En caso contrario, en el
atributo "InsertData(i)" se utiliza el único par de valores que se obtiene de "DataX(i)" y
"DataY(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.DataXY(i)[=object]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendView".
object
Opcional. Valor o constante que añade varios registros como Array con pares de valores.
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Añade un único registro y debe fijarse antes de la llamada de "InsertData(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.DataY(i)[=Double]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendControl".
Double
Opcional. Valor o constante que añade un único registro.
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Establece los datos que se borran del búfer de datos de la curva activa.
TRUE:
Acceso en runtime: lectura y escritura
Sintaxis
Object.DeleteData(i)[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendControl".
BOOLEAN
Opcional. TRUE si se borran todos los datos de la curva.
FALSE si se borra el par de valores en la posición "DataIndex(i)".
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Define la orientación de la barra o la posición del objeto Slider, o la retorna.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Direction [=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "Bar" o "Slider".
BOOLEAN
0 = Arriba
1 = Abajo
2 = Izquierda
3 = Derecha
Descripción
Establece el nombre para la curva indicada.
Acceso en runtime: lectura y escritura
Sintaxis
Object.DisplayName(i)[=String]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendControl".
String
Opcional. Valor o constante que establece el nombre para la curva indicada.
Observaciones
El parámetro i indica el número de la curva.
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Determina el estilo del HTML-Browsers.
Acceso en runtime: lectura y escritura
Sintaxis
Object.DrawEnhancedHTMLBrowser[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "HTMLBrowser".
BOOLEAN
Opcional. TRUE se muestra un HTML-Browser ampliado.
Consulte también
HTMLBrowser (Página 1416)
Descripción
Determina si un par de columnas puede editarse. El parámetro i indica el número del par de
columnas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.Editable(i)[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTableControl".
BOOLEAN
Opcional. TRUE si un par de columnas puede editarse. Se hace referencia al par de columnas
con el parámetro i.
Consulte también
OnlineTableControl (Página 1434)
Descripción
Determina si el modo de edición está activado para una celda cuando su propiedad
"Editable(i)" tiene el valor TRUE.
Acceso en runtime: lectura y escritura
Sintaxis
Object.EditEnabled[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTableControl".
BOOLEAN
Opcional. TRUE si el modo de edición está activado para una celda cuando su propiedad
"Editable(i)" tiene el valor TRUE.
Consulte también
OnlineTableControl (Página 1434)
Descripción
Determina la posición del punto final.
Acceso en runtime:
Sintaxis
Object.EndPoint[=Point]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con las especificaciones "EllipseSegment",
"CircleSegment", "EllipticalArc" o "CircularArc".
Point
Opcional. Un valor que determina la posición del punto final.
Consulte también
EllipseSegment (Página 1388)
CircleSegment (Página 1372)
EllipticalArc (Página 1390)
CircularArc (Página 1374)
Descripción
Determina la distancia horizontal del punto final desde el borde izquierdo de la imagen en
píxeles.
Acceso en runtime: lectura y escritura
Sintaxis
Object.EndPointLeft[=Int]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con las especificaciones "EllipseSegment",
"CircleSegment", "EllipticalArc" o "CircularArc".
Int
Opcional. Un valor que determina la distancia horizontal del punto final desde el borde
izquierdo de la imagen en píxeles.
Consulte también
EllipseSegment (Página 1388)
CircleSegment (Página 1372)
EllipticalArc (Página 1390)
CircularArc (Página 1374)
Descripción
Determina la distancia vertical del punto final desde el borde superior de la imagen en píxeles.
Acceso en runtime: lectura y escritura
Sintaxis
Object.EndPointTop[=Int]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con las especificaciones "EllipseSegment",
"CircleSegment", "EllipticalArc" o "CircularArc".
Int
Opcional. Un valor que determina la distancia vertical del punto final desde el borde superior
de la imagen en píxeles.
Consulte también
EllipseSegment (Página 1388)
CircleSegment (Página 1372)
EllipticalArc (Página 1390)
CircularArc (Página 1374)
Descripción
Establece el instante final del intervalo de tiempo que se muestra en el visor de curvas. La
propiedad "TagProviderType(i)" debe tener el valor -1.
Acceso en runtime: lectura y escritura
Sintaxis
Object.EndTime(i)[=Time]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "FunctionTrendControl" o
"OnlineTabelControl".
Time
Opcional. Valor o constante que establece el instante final del intervalo de tiempo que se
muestra en la ventana de curvas.
Observaciones
El parámetro i indica el número de la curva.
Si se modifica "EndTime(i)", pueden producirse combinaciones inadmisibles con otros
atributos para la conexión de datos. Por esta razón, antes de modificar "EndTime(i)", debe
evitarse la aplicación inmediata de la modificación con "FreezeProviderConnections".
Consulte también
FunctionTrendControl (Página 1397)
OnlineTableControl (Página 1434)
ExportXML
Sólo se utiliza internamente.
Descripción
TRUE si el control deslizante es colocado en el valor final perteneciente (valor mínimo/valor
máximo). Esto se realiza con un clic del ratón en el área fuera del ajuste actual del regulador.
Acceso de escritura y lectura BOOLEAN.
Descripción
Determina el espacio adicional para la rotulación.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ExtraSpaceForLabelDisplay[=Int]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Bar".
Int
Opcional. Un valor que determina el espacio adicional para la rotulación.
Consulte también
Bar (Página 1353)
Descripción
TRUE si está activada la intermitencia de la imagen intermitente. Acceso de escritura y lectura
BOOLEAN.
Descripción
TRUE si está activado el parpadeo del texto. Acceso de escritura y lectura BOOLEAN.
Descripción
TRUE si se debe guardar el gráfico intermitente asignado. De no ser así se guardará
únicamente la referencia del objeto perteneciente. Sólo acceso de lectura.
Descripción
Devuelve el gráfico intermitente. Acceso de sólo lectura.
El gráfico (*.BMP o *.DIB) debe estar en la carpeta "GraCS" del proyecto actual para poder
integrarlo.
La propiedad "FlashPicReferenced" define, en este contexto, si el gráfico intermitente se debe
guardar junto con el objeto o si se debe referenciar.
Descripción
Define la frecuencia de intermitencia para la línea del objeto, o la retorna. Margen de valores
de 0 hasta 2.
0 = Lento
1 = Medio
2 = Rápido
Descripción
Define la frecuencia de parpadeo para el gráfico intermitente, o la devuelve. Margen de valores
de 0 hasta 2.
0 = Lento
1 = Medio
2 = Rápido
Descripción
Define la frecuencia de intermitencia para la rotulación del objeto, o la retorna. Margen de
valores de 0 hasta 2.
0 = Lento
1 = Medio
2 = Rápido
Descripción
Determina que el campo "Formato de representación" sea de sólo lectura.
Acceso en runtime: lectura y escritura
Sintaxis
Object.FormatPatternReadOnlySpecial[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "IOField".
BOOLEAN
Opcional. TRUE si el campo "Formato de representación" es de sólo lectura.
Consulte también
IOField (Página 1418)
Descripción
Determina si pueden modificarse propiedades para la conexión de datos
("TagProviderType(i)", "Source.."...) sin que la modificación se haga efectiva de inmediato. Si
p. ej. se modifica "XDataLogTag(i)", pueden producirse combinaciones inadmisibles con
"YDataLogTag(i)".
Por esta razón, antes de modificar un atributo para la conexión de datos,
"FreezeProviderConnections" debe tener el valor TRUE. Después de modificar todas las
propiedades para la conexión de datos, "FreezeProviderConnection" se pone a FALSE y las
modificaciones se hacen efectivas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.FreezeProviderConnections[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendControl".
BOOLEAN
Opcional. TRUE si pueden modificarse propiedades para la conexión de datos
("TagProviderType(i)", "Source.."...) sin que la modificación se haga efectiva de inmediato.
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Devuelve el texto seleccionado del objeto "MultiLineEdit".
Descripción
Determina si los nombres de variables se muestran en el visor de curvas f(t).
Acceso en runtime: lectura y escritura
Sintaxis
Object.HideTagNames[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTrendControl".
BOOLEAN
Opcional. TRUE si se muestran los nombres de variables.
Consulte también
OnlineTrendControl (Página 1443)
Descripción
Retorna el valor que define dónde se guardan los textos de asignación dependientes del
idioma. Sólo acceso de lectura.
TRUE si los textos se administran en el editor de textos del proyecto. Las traducciones a otros
idiomas se efectúan en el editor de textos del proyecto.
FALSE si los textos se administran directamente en el objeto. Las traducciones a otros idiomas
pueden efectuarse mediante la función de exportación/importación.
Descripción
Determina si se deja libre un margen adicional para el borde.
Acceso en runtime: lectura y escritura
Sintaxis
Object.LeaveMarginForBorder[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Bar".
BOOLEAN
Opcional. TRUE si se deja libre un margen adicional para el borde.
Consulte también
Bar (Página 1353)
Descripción
Determina si se deja libre un margen adicional para marcadores.
Acceso en runtime: lectura y escritura
Sintaxis
Object.LeaveMarginForMarkers[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Bar".
BOOLEAN
Opcional. TRUE si se deja libre un margen adicional para marcadores.
Consulte también
Bar (Página 1353)
Descripción
Define el valor absoluto con la visualización más pequeña de valores, o lo retorna. Si la
visualización de la escala está activa, entonces se visualizará este valor.
Descripción
Establece el número de valores que se representan en la ventana de curvas. La propiedad
"TagProviderType(i)" debe tener el valor -1. El dato se evaluará o no dependiendo del valor
de la propiedad "UseMeasurePoints(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.NumberOfValues(i)[=Int]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendControl".
Int
Opcional. Valor o constante que establece el número de valores que se representan en la
ventana de curvas.
Observaciones
Number of value pairs for curve i (from tag provider)
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Retorna la imagen en la que está incrustado el objeto indicado.
Acceso en runtime: lectura
Sintaxis
Object.Parent
Object
Obligatorio. Objeto del tipo "ScreenItem". Ésta es una propiedad estándar del objeto
ScreenItem, por lo que está disponible en todas las apariencias.
Ejemplo de aplicación
El ejemplo siguiente escribe el nombre de la imagen raíz en la variable "BaseScreenName":
'VBS_Example_Parent
Dim objScrItem, BaseScreenName
Set objScrItem = HMIRuntime.Screens(1).ScreenItems(1)
BaseScreenName = "Name of BaseScreen: " & objScrItem.Parent.ObjectName
Consulte también
Line (Página 1422)
Polyline (Página 1459)
Ellipse (Página 1385)
Circle (Página 1369)
EllipseSegment (Página 1388)
CircleSegment (Página 1372)
EllipticalArc (Página 1390)
CircularArc (Página 1374)
Rectangle (Página 1471)
Polygon (Página 1456)
TextField (Página 1505)
IOField (Página 1418)
SymbolicIOField (Página 1491)
Button (Página 1360)
Switch (Página 1488)
GraphicView (Página 1411)
GraphicIOField (Página 1408)
Bar (Página 1353)
Clock (Página 1376)
Gauge (Página 1405)
Slider (Página 1481)
Descripción
TRUE si se guarda la imagen asignada para el estado "Off" en el objeto. De no ser así se
guardará únicamente la referencia del objeto perteneciente. Sólo acceso de lectura.
Descripción
Borra todas las entradas.
Descripción
Elimina una entrada.
Descripción
Indica el número de fila del objeto Row de un control de tabla.
Consulte también
AlarmControl (Página 1338)
Descripción
Establece el número de decimales con los que se muestra una medida de la curva indicada
si se calcula por medio de la función "Muestra el valor en este punto".
Acceso en runtime: lectura y escritura
Sintaxis
Object.RulerPrecision(i)[=Int]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTrendControl".
Int
Opcional. Valor o constante que establece el número de decimales con los que se muestra
una medida de la curva indicada si se calcula por medio de la función "Muestra el valor en
este punto".
Consulte también
OnlineTrendControl (Página 1443)
Descripción
Establece el número de decimales con los que se muestra una medida de la coordenada X.
El dato se evaluará o no dependiendo del valor del atributo "XAxisMode(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.RulerXPrecision(i)[=Int]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendControl".
Int
Opcional. Valor o constante que establece el número de decimales con los que se muestra
una medida de la coordenada X.
Observaciones
El parámetro i indica el número de la curva.
Se utiliza la función "Muestra el valor en este punto" para mostrar la coordenada X de la
medida.
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Establece el número de decimales con los que se muestra una medida de la coordenada Y.
El dato se evaluará o no dependiendo del valor del atributo "XAxisMode(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.RulerYPrecision(i)[=Int]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendControl".
Int
Opcional. Valor o constante que establece el número de decimales con los que se muestra
una medida de la coordenada Y.
Observaciones
El parámetro i indica el número de la curva.
Se utiliza la función "Muestra el valor en este punto" para mostrar la coordenada Y de la
medida.
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Establece todas las entradas.
Descripción
Establece la posición inicial a partir de la que se leen los valores de la curva de consigna de
la receta. El dato se evaluará o no dependiendo del valor de la propiedad
"ShowSetpointTrend(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.SetpointTrendArchiveStartId(i)[=Int]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendControl".
Int
Opcional. Valor o constante que establece la posición inicial a partir de la que se leen los
valores de la curva de consigna de la receta.
Observaciones
El parámetro i indica el número de la curva.
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Establece el color de una curva de consigna. El dato se evaluará o no dependiendo del valor
de la propiedad "ShowSetpointTrend(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.SetpointTrendColor(i)[=Color]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendControl".
Color
Opcional. Valor o constante que establece el color de una curva de consigna.
Observaciones
El parámetro i indica el número de la curva.
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Establece el número de pares de valores de una curva de consigna. El dato se evaluará o no
dependiendo del valor de la propiedad "ShowSetpointTrend(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.SetpointTrendNumberOfValues(i)[=Int]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendControl".
Int
Opcional. Valor o constante que establece el número de pares de valores de una curva de
consigna.
Observaciones
El parámetro i indica el número de la curva.
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Ajusta el valor de la propiedad.
Descripción
Establece una lista de las filas que están seleccionadas.
Descripción
Determina si las curvas de la ventana de curvas se representan con un eje X común.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShareTimeAxis[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTrendControl".
BOOLEAN
Opcional. TRUE si las curvas de la ventana de curvas se representan con un eje X común.
Consulte también
OnlineTrendControl (Página 1443)
Descripción
Determina si se utiliza una columna de tiempo común en la ventana de tabla.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShareTimeColumn[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTableControl".
BOOLEAN
Opcional. TRUE si se utiliza una columna de tiempo común en la ventana de tabla.
Consulte también
OnlineTableControl (Página 1434)
Descripción
Determina si las curvas de la ventana de curvas se representan con un eje Y común.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShareValueAxis[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTrendControl".
BOOLEAN
Opcional. TRUE si las curvas de la ventana de curvas se representan con un eje Y común.
Consulte también
OnlineTrendControl (Página 1443)
Descripción
Determina si las curvas de la ventana de curvas se representan con un eje X común.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShareXAxis[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendControl".
BOOLEAN
Opcional. TRUE si las curvas de la ventana de curvas se representan con un eje X común.
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Determina si las curvas de la ventana de curvas se representan con un eje Y común.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShareYAxis[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendControl".
BOOLEAN
Opcional. TRUE, si las curvas de la ventana de curvas se representan con un eje Y común.
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Determina si la ventana se muestra con borde.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowBorder[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "UserArchiveControl".
BOOLEAN
Opcional. TRUE si la ventana se muestra con borde.
Descripción
Determina si es visible el par de columnas referenciado con la propiedad
"CurrentColumnIndex".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowColumn(i)[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "OnlineTableControl".
BOOLEAN
Opcional. TRUE si es visible el par de columnas referenciado con la propiedad
"CurrentColumnIndex".
Consulte también
OnlineTableControl (Página 1434)
Descripción
Determina si es visible la curva referenciada con la propiedad "CurrentCurveIndex".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowCurve(i)[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl" o
"FunctionTrendControl".
BOOLEAN
Opcional. TRUE si es visible la curva referenciada con la propiedad "CurrentCurveIndex".
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Determina si hay campos adicionales para introducir la dirección y la contraseña.
Sintaxis
Object.ShowInputControls
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "SmartClientView".
Descripción
Determina si el objeto de barra completo se dota con un borde.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowMainFrame[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Bar".
BOOLEAN
Opción. TRUE si el objeto de barra completo se dota con un borde.
Consulte también
Bar (Página 1353)
Descripción
Determina si se muestra un visor de desbordamiento cuando el valor del proceso rebasa por
exceso o defecto los valores límite.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowOverflowIndicator[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Bar".
BOOLEAN
TRUE si se muestra un visor de desbordamiento cuando el valor del proceso rebasa por
exceso o defecto los valores límite.
Consulte también
Bar (Página 1353)
Descripción
Determina si se representa la curva de consigna correspondiente a la curva referenciada con
"CurrentCurveIndex".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ShowSetpointTrend(i)[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendControl".
BOOLEAN
Opcional. TRUE si se representa la curva de consigna correspondiente a la curva referenciada
con "CurrentCurveIndex".
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Define cuántos pasos se puede desplazar el regulador con un clic del ratón, o retorna este
valor.
Descripción
Define el principio del objeto o lo devuelve.
Descripción
Determina si el nombre del fichero se muestra en la barra de estado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarShowArchiveName[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "UserArchiveControl".
BOOLEAN
Opcional. TRUE si el nombre del fichero se muestra en la barra de estado.
Descripción
Determina si se muestra el número actual de columnas de registro seleccionadas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarShowColumn[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "UserArchiveControl".
BOOLEAN
Opcional. TRUE si se muestra el número actual de columnas de registro seleccionadas.
Descripción
Determina si las coordenadas de campo del registro seleccionado se muestran en la barra de
estado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarShowRecord[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "UserArchiveControl".
BOOLEAN
Opcional. TRUE si las coordenadas de campo del registro seleccionado se muestran en la
barra de estado.
Descripción
Determina si se muestra el número actual de filas de registro seleccionadas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarShowRow[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "UserArchiveControl".
BOOLEAN
Opcional. TRUE si se muestra el número actual de filas de registro seleccionadas.
Descripción
Determina si el estado actual de la base de datos se muestra en la barra de estado.
Acceso en runtime: lectura y escritura
Sintaxis
Object.StatusbarShowText[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "UserArchiveControl".
BOOLEAN
Opcional. TRUE si el estado actual de la base de datos se muestra en la barra de estado.
Descripción
Determina si los valores de altura y anchura de la barra se intercambian automáticamente al
modificar la orientación de la barra.
Acceso en runtime: lectura y escritura
Sintaxis
Object.SwapDimensionsWithOrientation[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Bar".
BOOLEAN
Opcional. TRUE si los valores de altura y anchura de la barra se intercambian
automáticamente al modificar la orientación de la barra.
Consulte también
Bar (Página 1353)
Descripción
Determina si el eje de tiempo se escala con marcas largas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeAxisShowLargeIncrements(i)[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "OnlineTrend".
BOOLEAN
Opcional. TRUE cuando el eje de tiempo se escala con marcas largas.
Observaciones
La distancia entre dos marcas largas puede modificarse por medio de la propiedad
"TimeAxisLargeIncrementSize(i)".
Consulte también
OnlineTrendControl (Página 1443)
Descripción
Determina si el eje de tiempo se escala con marcas cortas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeAxisShowSmallIncrements(i)[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "OnlineTrend".
BOOLEAN
Opcional. TRUE si el eje de tiempo se escala con marcas cortas.
Observaciones
La distancia entre dos marcas cortas puede modificarse por medio de la propiedad
"TimeAxisSmallIncrementSize(i)".
Consulte también
OnlineTrendControl (Página 1443)
Descripción
Determina el color que caracteriza los saltos de tiempo existentes en el fichero. La indicación
se evaluará o no en función de la propiedad "TimeJumpEnabled(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeJumpColor(i)[=Color]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con las especificaciones "OnlineTrend" o
""TableView".
Color
Opcional. Un valor o una constante que determina el color que caracteriza los saltos de tiempo
existentes en el fichero.
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
Descripción
Determina si los saltos de tiempo existentes en el fichero se caracterizan con el color
determinado en "TimeJumpColor(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeJumpEnabled(i)[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con las especificaciones "OnlineTrend" o
"TableView".
BOOLEAN
Opcional. TRUE si los saltos de tiempo existentes en el fichero se caracterizan con el color
determinado en "TimeJumpColor(i)".
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
Descripción
Determina el color que caracteriza las superposiciones de tiempo existentes en el fichero. La
indicación se evaluará o no en función del atributo "TimeOverlapEnabled(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeOverlapColor(i)[=Color]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con las especificaciones "OnlineTrend" o
"TableView".
Color
Opcional. Un valor o una constante que determina el color que caracteriza las superposiciones
de tiempo existentes en el fichero.
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
Descripción
Determina si las superposiciones de tiempo existentes en el fichero se caracterizan con el
color determinado en "TimeOverlapColor(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.TimeOverlapEnabled(i)[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con las especificaciones "OnlineTrend" o
"TableView".
BOOLEAN
Opcional. TRUE si las superposiciones de tiempo existentes en el fichero se caracterizan con
el color determinado en "TimeOverlapColor(i)".
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
Descripción
Devuelve el tipo del objeto indicado como STRING. Estructura del nombre: Hmi<nombre del
objeto>, p. ej. HmiCircle para el objeto de imagen "círculo".
Acceso en runtime: lectura
Sintaxis
Object.Type
Object
Obligatorio. Objeto del tipo "ScreenItem".
Descripción
Define en el objeto Lista de texto el color de fondo de la lista de selección en entradas no
seleccionadas, o lo retorna. Acceso de escritura y lectura LONG.
Descripción
Define en el objeto Lista de texto el color del texto en la lista de selección en entradas no
seleccionadas, o lo retorna. Acceso de escritura y lectura LONG.
Descripción
Retorna el tipo y la frecuencia para la actualización de la ventana de imagen en Runtime. Sólo
acceso de lectura.
Descripción
Determina si el borde de la barra está limitado a determinados valores.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UseBarBorderConstraints[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Bar".
BOOLEAN
Opcional. TRUE si el borde de la barra está limitado a determinados valores.
Consulte también
Bar (Página 1353)
Descripción
Determina si se utiliza un valor de proceso actual formado por valor máximo, valor mínimo,
media de los 15 últimos valores e histéresis.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UseEffectiveProcessValue[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Bar".
BOOLEAN
Opcional. TRUE si se utiliza un valor de proceso actual formado por valor máximo, valor
mínimo, media de los 15 últimos valores e histéresis.
Consulte también
Bar (Página 1353)
Descripción
Determina si la elipse se traza por medio de GDI o GDI+.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UseGDI[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Ellipse".
BOOLEAN
Opcional. TRUE si la elipse se traza por medio de GDI.
Consulte también
Ellipse (Página 1385)
Descripción
Determina si los puntos de medida o el instante final establecen el intervalo de tiempo de la
curva especificada. El dato se evaluará o no dependiendo de las propiedades
"TimeAxisEndTime" y "TimeAxisBeginTime(i)".
Define el intervalo de tiempo de la curva i mediante puntos de medida (TRUE) o instante final
(FALSE) (para Tag Provider de tiempo)
Acceso en runtime: lectura y escritura
Sintaxis
Object.UseMeasurePoints(i)[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl"o
"FunctionTrendControl".
BOOLEAN
Opcional. TRUE si el intervalo de tiempo de la curva especificada se determina mediante
puntos de medida.
Observaciones
El parámetro i indica el número de la curva.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Determina si se representan una o varias parejas de valores límite como selección o línea.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UseMultipleLimits[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Bar".
BOOLEAN
Opcional. TRUE si se representan una o varias parejas de valores límite como selección o
línea.
Consulte también
Bar (Página 1353)
Descripción
Determina si la distancia entre dos marcas grandes de la escala se calcula a partir del valor
mínimo y máximo.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UseScaleConstraints[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Bar".
BOOLEAN
Opcional. TRUE si la distancia entre dos marcas grandes de la escala se calcula a partir del
valor mínimo y máximo.
Consulte también
Bar (Página 1353)
Descripción
Determina si el rectángulo que rodea al objeto se representa en función de la escala o si está
predefinido.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UseScaledBarBorder[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Bar".
BOOLEAN
Opcional. TRUE si el rectángulo que rodea al objeto se representa en función de la escala.
Consulte también
Bar (Página 1353)
Descripción
Determina si las curvas se representan escalonadas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UseSeparateDiagrams[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con las especificaciones "OnlineTrend" o
"FunctionTrendView".
BOOLEAN
Opcional. TRUE si las curvas se representan escalonadas
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Determina cómo se calcula la longitud de campo para la rotulación de la escala.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UseSimplePresicionOffset[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "Bar".
BOOLEAN
Opcional. TRUE si se calcula la longitud de campo para la rotulación de la escala.
Consulte también
Bar (Página 1353)
Descripción
Determina el número de valores que se cargan de la receta. La propiedad
"TagProviderType(i)" debe tener el valor -2.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UserArchiveNumberOfValues(i)[=Int]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "FunctionTrendView".
Int
Opcional. Un valor o una constante que determina el número de valores que se cargan de la
receta.
Observaciones
El parámetro i indica el número de la curva.
Con la modificación de "UserArchiveNumberOfValues(i)" pueden generarse combinaciones
no permitidas con otros atributos para la conexión de datos. Por tanto, antes de modificar
"UserArchiveNumberOfValues(i)" debe impedirse la aplicación inmediata del cambio con
"FreezeProviderConnections".
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Define el registro a partir del cual se cargan los valores de la receta para la curva especificada.
La propiedad "TagProviderType(i)" debe tener el valor -2.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UserArchiveStartId(i)[=Int]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendControl".
Int
Opcional. Valor o constante que establece el registro a partir del cual se cargan los valores
de la receta para la curva especificada.
Observaciones
El parámetro i indica el número de la curva.
Si se modifica "UserArchiveStartId(i)", pueden producirse combinaciones inadmisibles con
otros atributos para la conexión de datos. Por esta razón, antes de modificar
"UserArchiveStartId(i)", debe evitarse la aplicación inmediata de la modificación con
"FreezeProviderConnections".
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Define el valor que se transfiere al script VB al ejecutar un icono u opción de menú definidos
por el usuario.
Utilice en el editor "Menús y barras de herramientas" el campo "Datos" para transferir un
parámetro al procedimiento.
Acceso en runtime: lectura y escritura
Sintaxis
Object.UserData[=String]
Object
Se necesita. Un objeto del tipo "Item".
String
Opcional. Un valor o una constante que se transfiere al script VB al ejecutar un icono u opción
de menú definidos por el usuario.
Descripción
Especifica la distancia entre dos líneas de cuadrícula. El dato se evaluará o no dependiendo
de las propiedades "ValueAxisShowGridLines(i)" y "TimeAxisShowGridLines(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ValueAxisGridLineInterval(i)[=Double]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl" o
"FunctionTrendControl".
Double
Opcional. Valor o constante que establece la distancia entre dos líneas de cuadrícula.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Define la distancia entre dos marcas largas de la escala. El dato se evaluará o no dependiendo
de las propiedades "ValueAxisShowLargeIncrements(i)" y
"TimeAxisShowLargeIncrements(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.ValueAxisLargeIncrementSize(i)[=Double]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl" o
"FunctionTrendControl".
Double
Opcional. Valor o constante que define la distancia entre dos marcas largas de la escala.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Determina si el eje de valores se escala con marcas largas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ValueAxisShowLargeIncrements(i)[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl" o
"FunctionTrendControl".
BOOLEAN
Opcional. TRUE si el eje de valores se escala con marcas largas.
Observaciones
La distancia entre dos marcas largas puede modificarse mediante la propiedad
"ValueAxisLargeIncrementSize(i)".
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Determina si el eje de valores se escala con marcas cortas.
Acceso en runtime: lectura y escritura
Sintaxis
Object.ValueAxisShowSmallIncrements(i)[=BOOLEAN]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl" o
"FunctionTrendControl".
BOOLEAN
Opcional. TRUE si el eje de valores se escala con marcas cortas.
Observaciones
La distancia entre dos marcas cortas puede modificarse mediante la propiedad
"ValueAxisSmallIncrementSize(i)".
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Define la distancia entre dos marcas cortas de la escala. El dato se evaluará o no dependiendo
de las propiedades "ValueAxisShowSmallIncrements(i)" y
"TimeAxisShowSmallIncrements(i)".
Sintaxis
Object.ValueAxisSmallIncrementSize(i)[=Double]
Object
Se necesita. Objeto del tipo "ScreenItem" con las apariencias "OnlineTrendControl" o
"FunctionTrendControl".
Double
Opcional. Valor o constante que define la distancia entre dos marcas cortas de la escala.
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Define el número de decimales con los que se indican los valores de la escala para el eje X.
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisDecimalPrecision(i)[=Int]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "FunctionTrendView".
Int
Opcional. Un valor o una constante que define el número de decimales con los que se indican
los valores de la escala para el eje X.
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Establece la distancia entre dos líneas de retícula del eje X. La indicación se evaluará o no
en función del valor de la propiedad "XAxisShowGridLines(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisGridLineInterval(i)[=Double]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "FunctionTrendView".
Double
Opcional. Un valor o una constante que determina la distancia entre dos líneas de retícula del
eje X.
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Establece la distancia entre dos marcas largas de la escala del eje X. La indicación se evaluará
o no en función del valor de la propiedad "XAxisShowLargeIncrements(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisLargeIncrementSize(i)[=Double]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "FunctionTrendView".
Double
Opcional. Un valor o una constante que determina la distancia entre dos marcas largas de la
escala del eje X.
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Determina si se utiliza un eje de tiempo común para todas las curvas en la ventana de curvas.
Especifica las unidades de tiempo que utilizan los controles de Tag Logging.
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisMode(i)[=TrendViewTimeAxisMode]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendContol".
TrendViewTimeAxisMode
( 1): el eje de tiempo se escala.
( 2): no se ha definido ningún intervalo de tiempo. Se muestran solo pruebas aleatorias.
( 3): el intervalo de tiempo se define mediante variables.
( 4): el intervalo de tiempo se define mediante valores constantes.
Observaciones
Determina si se utiliza un eje X común para todas las curvas en la ventana de curvas.
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Determina si el eje X se escala con marcas largas. La distancia entre dos marcas largas puede
modificarse por medio de la propiedad "XAxisLargeIncrementSize(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisShowLargeIncrements(i)[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "FunctionTrendView".
BOOLEAN
Opcional. TRUE cuando el eje X se escala con marcas largas.
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Determina si el eje X se escala con marcas cortas. La distancia entre dos marcas cortas puede
modificarse por medio de la propiedad "XAxisSmallIncrementSize(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisShowSmallIncrements(i)[=BOOLEAN]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "FunctionTrendView".
BOOLEAN
Opcional. TRUE cuando el eje X se escala con marcas cortas.
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Establece la distancia entre dos marcas cortas de la escala del eje X. La indicación se evaluará
o no en función del valor de la propiedad "XAxisShowSmallIncrements(i)".
Acceso en runtime: lectura y escritura
Sintaxis
Object.XAxisSmallIncrementSize(i)[=Double]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "FunctionTrendView".
Double
Opcional. Un valor o una constante que determina la distancia entre dos marcas cortas de la
escala del eje X.
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Define la variable que se representa en el eje X. La propiedad "TagProviderType(i)" debe tener
el valor -1.
Acceso en runtime: lectura y escritura
Sintaxis
Object.XDataLogTag(i)[=HmiLoggingTag]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendView".
HmiLoggingTag
Opcional. Valor o constante que define la variable que se representa en el eje X.
Observaciones
Si se modifica "XOnlineTag(i)", pueden producirse combinaciones inadmisibles con otros
atributos para la conexión de datos. Por esta razón, antes de modificar "XOnlineTag(i)", debe
evitarse la aplicación inmediata de la modificación con "FreezeProviderConnections".
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Determina la variable que se representa a lo largo del eje X. La propiedad "TagProviderType(i)"
debe tener el valor -1.
Acceso en runtime: lectura y escritura
Sintaxis
Object.XOnlineTag(i)[=HmiTag]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "FunctionTrendView".
HmiTag
Opcional. Un valor o una constante que determina la variable que se representa a lo largo del
eje X.
Observaciones
El parámetro i indica el número de la curva.
Con la modificación de "XOnlineTag(i)" pueden generarse combinaciones no permitidas con
otros atributos para la conexión de datos. Por tanto, antes de modificar "XOnlineTag(i)" debe
impedirse la aplicación inmediata del cambio con "FreezeProviderConnections".
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Define la variable que se representa en el eje Y. La propiedad "TagProviderType(i)" debe tener
el valor -1.
Acceso en runtime: lectura y escritura
Sintaxis
Object.YDataLogTag(i)[=HmiLoggingTag]
Object
Se necesita. Objeto del tipo "ScreenItem" con la apariencia "FunctionTrendView".
HmiLoggingTag
Opcional. Valor o constante que define la variable que se representa en el eje Y.
Observaciones
Si se modifica "YOnlineTag(i)", pueden producirse combinaciones inadmisibles con otros
atributos para la conexión de datos. Por esta razón, antes de modificar "YOnlineTag(i)", debe
evitarse la aplicación inmediata de la modificación con "FreezeProviderConnections".
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Determina la variable que se representa a lo largo del eje Y. La propiedad "TagProviderType(i)"
debe tener el valor -1.
Acceso en runtime: lectura y escritura
Sintaxis
Object.YOnlineTag(i)[=HmiTag]
Object
Obligatorio. Un objeto del tipo "ScreenItem" con la especificación "FunctionTrendView".
HmiTag
Opcional. Un valor o una constante que determina la variable que se representa a lo largo del
eje Y.
Observaciones
El parámetro i indica el número de la curva.
Con la modificación de "YOnlineTag(i)" pueden generarse combinaciones no permitidas con
otros atributos para la conexión de datos. Por tanto, antes de modificar "YOnlineTag(i)" debe
impedirse la aplicación inmediata del cambio con "FreezeProviderConnections".
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Activa la ventana permanente o bien la imagen raíz.
Sintaxis
Expression.Activate
Expression
Obligatorio. Expresión que devuelve un objeto del tipo "Screen" o "ScreenItem".
Parámetros
--
Consulte también
ScreenItem (Página 1323)
Screen (Página 1320)
ChannelDiagnose (Página 1364)
CheckBox (Página 1366)
Circle (Página 1369)
Descripción
Activa dinámicamente un disparador y el ciclo fijado para una propiedad durante el runtime.
Para ello se requiere un VB Script en la propiedad y un disparo definido como "Bajo demanda".
Con cada activación del disparador puede usarse otro ciclo de activación.
Sintaxis
Ausdruck.ActivateDynamic (ByVAl bstrPropertyName As String, ByVal
bstrCycleName As String)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
Parámetro Descripción
bstrPropertyName Nombre de la propiedad a la que se refiere el dis‐
parador.
bstrCycleName Nombre del ciclo de activación, p. ej., "CycleTi‐
me1s".
Consulte también
ChannelDiagnose (Página 1364)
CheckBox (Página 1366)
Circle (Página 1369)
CircleSegment (Página 1372)
CircularArc (Página 1374)
Clock (Página 1376)
Connector (Página 1379)
DiskSpaceView (Página 1383)
Ellipse (Página 1385)
EllipseSegment (Página 1388)
EllipticalArc (Página 1390)
Gauge (Página 1405)
GraphicIOField (Página 1408)
GraphicView (Página 1411)
HTMLBrowser (Página 1416)
IOField (Página 1418)
Rectangle (Página 1471)
ScriptDiagnostics (Página 1479)
SymbolicIOField (Página 1491)
SymbolLibrary (Página 1496)
TextField (Página 1505)
TubeArcObject (Página 1520)
TubeDoubleTeeObject (Página 1522)
TubePolyline (Página 1524)
TubeTeeObject (Página 1526)
UserView (Página 1536)
WindowSlider (Página 1538)
Slider (Página 1481)
ScreenWindow (Página 1477)
RoundButton (Página 1473)
Polyline (Página 1459)
Polygon (Página 1456)
OptionGroup (Página 1453)
MultiLineEdit (Página 1429)
Sintaxis
Expresión.Add [Tag]
Expresión
Se necesita. Una expresión que retorna un objeto de tipo "TagSet".
Parámetros
VARIANT
Parámetros Descripción
Variable;Tag Nombre de una variable WinCC o referencia de
un objeto Tag que deberá ser agregado al listado.
Ejemplo
En el siguiente ejemplo se genera un objeto TagSet y se agrega una variable.
'VBS170
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
group.Add "Motor1"
'VBS171
Dim Tag
Set Tag = HMIRuntime.Tags("Motor2")
Dim group2
Set group2 = HMIRuntime.Tags.CreateTagSet
group2.Add Tag
Nota
El objeto DataSet no soporta ninguna clase.
Objetos del tipo Screen, Screens, ScreenItem, ScreenItems, Tag y TagSet no pueden ser
incluidos en el listado DataSet.
En las referencias de objetos hay que estar seguro de que los objetos son aptos para
multithread.
Sintaxis
Expresión.Add [vtName], [vtUserData]
Expresión
Se necesita. Una expresión que retorna un objeto de tipo "DataSet".
Parámetros
VARIANT
Parámetros Descripción
vtName Nombre con el que se debe agregar el valor o la
variable al listado.
vtUserData Valor que debe ser agregado al listado.
Ejemplo
En este ejemplo se acepta un valor en el listado DataSet.
'VBS172
HMIRuntime.DataSet.Add "Motor1",23
Consulte también
DataSet (lista) (Página 1311)
OnlineTrendControl (Página 1443)
Descripción
Ejecuta la función de tecla "Conectar copia de seguridad" del control.
Sintaxis
Expresión.AttachDB()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetros
--
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
FunctionTrendControl (Página 1397)
AlarmControl (Página 1338)
Descripción
Ejecuta la función de tecla "Calcular estadística" del visor de curvas f(t) y del visor de tablas.
Sintaxis
Expresión.CalculateStatistic()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
Descripción
Ejecuta la función de tecla "Copiar filas" del control.
Sintaxis
Expresión.CopyRows()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
UserArchiveControl (Página 1528)
AlarmControl (Página 1338)
Descripción
Crea un nuevo objeto Alarm.
Sintaxis
Expresión.Create (VARIANT vtApplication)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "Alarm".
Parámetro
VARIANT
Parámetro Descripción
vtApplication Nombre del objeto Alarm (opcional)
Consulte también
OnlineTrendControl (Página 1443)
Descripción
Crea un nuevo objeto TagSet. Este objeto se puede usar para accesos Multi-Tag optimizados.
Sintaxis
Expresión.CreateTagSet()
Expresión
Obligatorio. Una expresión que retorna un objeto de tipo "TagSet".
Parámetro
VARIANT
Ejemplo
El siguiente ejemplo muestra cómo se crea un objeto TagSet.
'VBS168
'Build a Reference to the TagSet Object
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
Consulte también
OnlineTrendControl (Página 1443)
Descripción
Ejecuta la función de tecla "Cortar líneas" del visor de recetas.
Sintaxis
Expresión.CutRows()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
OnlineTrendControl (Página 1443)
UserArchiveControl (Página 1528)
Descripción
Desactiva en/durante el runtime el disparador usado del método "ActivateDynamic" para la
propiedad fijada.
Sintaxis
Expresión.DeactivateDynamic(ByVal bstrPropertyName As String)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
String
Parámetro Descripción
bstrPropertyName Nombre de la propiedad a la que se refiere el dis‐
parador.
Consulte también
ChannelDiagnose (Página 1364)
CheckBox (Página 1366)
Circle (Página 1369)
CircleSegment (Página 1372)
CircularArc (Página 1374)
Clock (Página 1376)
Connector (Página 1379)
DiskSpaceView (Página 1383)
Ellipse (Página 1385)
EllipseSegment (Página 1388)
EllipticalArc (Página 1390)
Gauge (Página 1405)
GraphicIOField (Página 1408)
GraphicView (Página 1411)
HTMLBrowser (Página 1416)
IOField (Página 1418)
Rectangle (Página 1471)
ScriptDiagnostics (Página 1479)
SymbolicIOField (Página 1491)
SymbolLibrary (Página 1496)
TextField (Página 1505)
TubeArcObject (Página 1520)
TubeDoubleTeeObject (Página 1522)
TubePolyline (Página 1524)
TubeTeeObject (Página 1526)
Descripción
Ejecuta la función de tecla "Borrar líneas" del visor de recetas.
Sintaxis
Expresión.DeleteRows()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
OnlineTrendControl (Página 1443)
UserArchiveControl (Página 1528)
Descripción
Ejecuta la función de tecla "Desconectar copia de seguridad" del control.
Sintaxis
Expresión.DetachDB()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetros
--
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
FunctionTrendControl (Página 1397)
AlarmControl (Página 1338)
Descripción
Ejecuta la función de tecla "Editar" del visor de tablas.
Sintaxis
Expresión.Edit()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
AlarmControl (Página 1338)
Descripción
Ejecuta la función de tecla "Exportar fichero" o "Exportar datos" del control.
Sintaxis
Expresión.Export()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
VARIANT
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
TrendRulerControl (Página 1508)
UserArchiveControl (Página 1528)
FunctionTrendControl (Página 1397)
AlarmControl (Página 1338)
Descripción
Devuelve el objeto de columna designado por nombre o índice del visor de recetas como tipo
"ICCAxUAColumn".
Sintaxis
Expresión.GetColumn(ByVal vIndex As Variant)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
VARIANT
Parámetro Descripción
vIndex Índice o nombre de la columna del visor de recetas.
Ejemplo
'VBS312
Dim ctrl
Dim objColumn
Set ctrl = ScreenItems("RecipeControl")
Set objColumn = ctrl.GetColumn("Field1")
objColumn.Length = 30
Set objColumn = ctrl.GetColumn(3)
objColumn.Align = 2
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "Column" debe escribirse, p. ej., "objColumn.Align" en lugar de
"objColumn.ColumnAlign".
Consulte también
OnlineTrendControl (Página 1443)
UserArchiveControl (Página 1528)
Descripción
Devuelve el listado de todos los objetos de columna del visor de recetas como tipo
"ICCAxCollection".
Sintaxis
Expresión.GetColumnCollection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Ejemplo
'VBS313
Dim ctrl
Dim coll
Dim field
Set ctrl = ScreenItems("RecipeControl")
Set coll = ctrl.GetColumnCollection
HMIRuntime.Trace "Number of fields:" & coll.Count & vbCrLf
For Each field In coll
HMIRuntime.Trace field.Name & vbCrLf
HMIRuntime.Trace field.Type & vbCrLf
HMIRuntime.Trace field.Length & vbCrLf
HMIRuntime.Trace field.Caption & vbCrLf
Next
Consulte también
OnlineTrendControl (Página 1443)
UserArchiveControl (Página 1528)
Descripción
Devuelve el listado de todos los objetos de columna de la lista de aciertos del visor de avisos
como tipo "ICCAxCollection".
Sintaxis
Expresión.GetHitlisteColumnCollection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Ejemplo
'VBS315
Dim ctrl
Dim coll
Dim hitlistcol
Set ctrl = ScreenItems("AlarmControl")
Set coll = ctrl.GetHitlistColumnCollection
HMIRuntime.Trace "Number of hitlist columns:" & coll.Count & vbCrLf
For Each hitlistcol In coll
HMIRuntime.Trace hitlistcol.Index & vbCrLf
HMIRuntime.Trace hitlistcol.Name & vbCrLf
HMIRuntime.Trace hitlistcol.Sort & vbCrLf
HMIRuntime.Trace hitlistcol.SortIndex & vbCrLf
Next
Consulte también
OnlineTrendControl (Página 1443)
AlarmControl (Página 1338)
Descripción
Devuelve el objeto de columna designado por nombre o índice de la lista de aciertos del visor
de avisos como tipo "ICCAxMessageColumn".
Sintaxis
Expresión.GetHitlistColumn(ByVal vIndex As Variant)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
VARIANT
Parámetro Descripción
vIndex Índice o nombre de la columna de la lista de acier‐
tos
Ejemplo
'VBS314
Dim ctrl
Dim objHitlistColumn
Set ctrl = ScreenItems("AlarmControl")
Set objHitlistColumn = ctrl.GetHitlistColumn("Date")
objHitlistColumn.Sort = 2
Set objHitlistColumn = ctrl.GetHitlistColumn("AverageComeGo")
objHitlistColumn.Visible = FALSE
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "HitlistColumn" debe escribirse, p. ej., "objHitlistColumn.Visible" en lugar de
"objHitlistColumn.HitlistColumnVisible".
Consulte también
OnlineTrendControl (Página 1443)
AlarmControl (Página 1338)
Descripción
Devuelve el objeto de bloque de aviso designado por nombre o índice del visor de avisos
como tipo "ICCAxMessageBlock".
Sintaxis
Expresión.GetMessageBlock(ByVal vIndex As Variant)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
VARIANT
Parámetro Descripción
vIndex Índice o nombre del bloque de mensajes.
Ejemplo
'VBS316
Dim ctrl
Dim objMsgBlock
Set ctrl = ScreenItems("AlarmControl")
Set objMsgBlock = ctrl.GetMessageBlock("Date")
objMsgBlock.Align = 2
Set objMsgBlock = ctrl.GetMessageBlock("Number")
objMsgBlock.LeadingZeros = 4
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "MessageBlock" debe escribirse, p. ej., "objMsgBlock.Align" en lugar de
"objMsgBlock.MessageBlockAlign".
Consulte también
OnlineTrendControl (Página 1443)
AlarmControl (Página 1338)
Descripción
Devuelve el listado de todos los objetos de bloque de aviso del visor de avisos como tipo
"ICCAxCollection".
Sintaxis
Expresión.GetMessageBlockCollection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Ejemplo
'VBS317
Dim ctrl
Dim coll
Dim msgblock
Set ctrl = ScreenItems("AlarmControl")
Set coll = ctrl.GetMessageBlockCollection
For Each msgblock In coll
msgblock.Align = 1
msgblock.Length = 12
msgblock.Selected = TRUE
Next
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "MessageBlock" debe escribirse, p. ej., "msgblock.Align" en lugar de
"msgblock.MessageBlockAlign".
Consulte también
OnlineTrendControl (Página 1443)
AlarmControl (Página 1338)
Descripción
Devuelve el objeto de columna designado por nombre o índice del visor de avisos como tipo
"ICCAxMessageColumn".
Sintaxis
Expresión.GetMessageColumn(ByVal vIndex As Variant)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
VARIANT
Parámetro Descripción
vIndex Índice o nombre de la columna en la lista de avisos.
Ejemplo
'VBS318
Dim ctrl
Dim objMessColumn
Set ctrl = ScreenItems("AlarmControl")
Set objMessColumn = ctrl.GetMessageColumn("Date")
objMessColumn.Visible = FALSE
Set objMessColumn = ctrl.GetMessageColumn("Number")
objMessColumn.Sort = 1
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "MessageColumn" debe escribirse, p. ej., "objMessColumn.Visible" en lugar de
"objMessColumn.MessageColumnVisible".
Consulte también
OnlineTrendControl (Página 1443)
AlarmControl (Página 1338)
Descripción
Devuelve el objeto de aviso de operador designado por nombre o índice del visor de avisos
como tipo "ICCAxOperatorMessage".
Sintaxis
Expresión.GetOperatorMessage(ByVal vIndex As Variant)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
VARIANT
Parámetro Descripción
vIndex Índice o nombre del aviso de operador.
Ejemplo
'VBS320
Dim ctrl
Dim objOpMess
Set ctrl = ScreenItems("AlarmControl")
Set objOpMess = ctrl.GetOperatorMessage(0)
objOpMess.Source1 = "Number"
objOpMess.SourceType1 = 1
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "OperatorMessage" debe escribirse, p. ej., "objOpMess.Source1" en lugar de
"objOpMess.OperatorMessageSource1".
Consulte también
OnlineTrendControl (Página 1443)
AlarmControl (Página 1338)
Descripción
Devuelve el listado de todos los objetos de columna del visor de avisos como tipo
"ICCAxCollection".
Sintaxis
Expresión.GetMessageColumnCollection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Ejemplo
'VBS319
Dim ctrl
Dim coll
Dim msgcol
Set ctrl = ScreenItems("AlarmControl")
Set coll = ctrl.GetMessageColumnCollection
HMIRuntime.Trace "Number of message columns:" & coll.Count & vbCrLf
For Each msgcol In coll
HMIRuntime.Trace msgcol.Index & vbCrLf
HMIRuntime.Trace msgcol.Name & vbCrLf
HMIRuntime.Trace msgcol.Sort & vbCrLf
HMIRuntime.Trace msgcol.SortIndex & vbCrLf
Next
Consulte también
OnlineTrendControl (Página 1443)
AlarmControl (Página 1338)
Descripción
Devuelve el listado de todos los objetos de aviso de operador del visor de avisos como tipo
"ICCAxCollection".
Sintaxis
Expresión.GetOperatorMessageCollection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Ejemplo
'VBS321
Dim ctrl
Dim coll
Dim opmsg
Set ctrl = ScreenItems("AlarmControl")
Set coll = ctrl.GetOperatorMessageCollection
For Each opmsg In coll
HMIRuntime.Trace opmsg.Index & vbCrLf
HMIRuntime.Trace opmsg.Name & vbCrLf
HMIRuntime.Trace opmsg.Number & vbCrLf
HMIRuntime.Trace opmsg.Selected & vbCrLf
Next
Consulte también
OnlineTrendControl (Página 1443)
AlarmControl (Página 1338)
Descripción
Devuelve el objeto de filas designado mediante el número de fila de los controles basados en
tablas como tipo "ICCAxDataRow".
Sintaxis
Expresión.GetRow(ByVal IRow As Long)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetros
Long
Parámetro Descripción
IRow Número de fila deseada del control.
Ejemplo
'VBS356
Dim coll
Dim ctrl
Dim lIndex
Dim lCellIndex
Set ctrl = ScreenItems("UAControl")
Set coll = ctrl.GetRowCollection
'enumerate and trace out row numbers
For lIndex = 1 To coll.Count
HMIRuntime.trace "Row: " & (ctrl.GetRow(lIndex).RowNumber) & " "
'enumerate and trace out column titles and cell texts
For lCellIndex = 1 To ctrl.GetRow(lIndex).CellCount
HMIRuntime.trace ctrl.GetRow(0).CellText(lCellIndex) & " "
HMIRuntime.trace ctrl.GetRow(lIndex).CellText(lCellIndex) & " "
Next
HMIRuntime.trace vbNewLine
Next
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "Row" debe escribirse, p. ej., "objRow.CellCount" en lugar de
"objRow.RowCellCount".
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
TrendRulerControl (Página 1508)
UserArchiveControl (Página 1528)
AlarmControl (Página 1338)
Descripción
Devuelve el listado de todos los objetos de filas de los controles basados en tablas como tipo
"ICCAxDataRowCollection".
Sintaxis
Expresión.GetRowCollection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Propiedades de ICCAxDataRowCollection
ICCAxDataRowCollection se refiere a datos runtime. Los datos solo se pueden leer. No es
posible añadir ni modificar los datos.
En ICCAxDataRowCollection encontrará las siguientes propiedades:
● Count, determina el número de filas de la Collection (colección)
● Item, acceso a una fila determinada de la Collection mediante el número de fila. La
numeración va de 1 a Count. Se devuelve un objeto Row.
Ejemplo
'VBS357
Dim ctrl
Dim coll
Dim lIndex
Dim lCellIndex
Set ctrl = ScreenItems("AlarmControl")
Set coll = ctrl.GetRowCollection
HMIRuntime.Trace "Number of message rows:" & coll.Count & vbCrLf
'enumerate and trace out row numbers
For lIndex = 1 To coll.Count
HMIRuntime.Trace "Row: " & (ctrl.GetRow(lIndex).RowNumber) & " "
'enumerate and trace out column titles and cell texts
For lCellIndex = 1 To ctrl.GetRow(lIndex).CellCount
HMIRuntime.Trace ctrl.GetMessageColumn(lCellIndex -1).Name & " "
HMIRuntime.Trace ctrl.GetRow(lIndex).CellText(lCellIndex) & " "
Next
HMIRuntime.Trace vbNewLine
Next
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
TrendRulerControl (Página 1508)
UserArchiveControl (Página 1528)
AlarmControl (Página 1338)
Descripción
Devuelve el objeto de bloque designado por nombre o índice de la tabla de evaluación como
tipo "ICCAxRulerBlock".
Sintaxis
Expresión.GetRulerBlock(ByVal vIndex As Variant)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
VARIANT
Parámetro Descripción
vIndex Índice o nombre del bloque de la tabla de evalua‐
ción
Ejemplo
'VBS322
Dim ctrl
Dim objRulerBlock
Set ctrl = ScreenItems("RulerControl")
Set objRulerBlock = ctrl.GetRulerBlock(0)
objRulerBlock.Caption = "RulerBlock1"
Set objRulerBlock = ctrl.GetRulerBlock("Name")
objRulerBlock.Length = 10
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "RulerBlock" debe escribirse, p. ej., "objRulerBlock.Caption" en lugar de
"objRulerBlock.BlockCaption".
Consulte también
OnlineTrendControl (Página 1443)
TrendRulerControl (Página 1508)
Descripción
Devuelve el listado de todos los objetos de bloque de la tabla de evaluación como tipo
"ICCAxCollection".
Sintaxis
Expresión.GetRulerBlockCollection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Ejemplo
'VBS323
Dim ctrl
Dim coll
Dim rulerblock
Set ctrl = ScreenItems("RulerControl")
Set coll = ctrl.GetRulerBlockCollection
For Each rulerblock In coll
rulerblock.Align = 1
rulerblock.Length = 12
Next
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "RulerBlock" debe escribirse, p. ej., "rulerblock.Align" en lugar de
"rulerblock.RulerBlockAlign".
Consulte también
OnlineTrendControl (Página 1443)
TrendRulerControl (Página 1508)
Descripción
Devuelve el objeto de columna designado por nombre o índice de la tabla de evaluación como
tipo "ICCAxRulerColumn".
Sintaxis
Expresión.GetRulerColumn(ByVal vIndex As Variant)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
VARIANT
Parámetro Descripción
vIndex Índice o nombre de la columna de la tabla de evalua‐
ción.
Ejemplo
'VBS324
Dim ctrl
Dim objRulercol
Set ctrl = ScreenItems("RulerControl")
Set objRulercol = ctrl.GetRulerColumn("Name")
objRulercol.Sort = 0
Set objRulercol = ctrl.GetRulerColumn("ValueY")
objRulercol.Visible = FALSE
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "RulerColumn" debe escribirse, p. ej., "objRulercol.Visible" en lugar de
"objRulercol.ColumnVisible".
Consulte también
OnlineTrendControl (Página 1443)
TrendRulerControl (Página 1508)
Descripción
Devuelve el listado de todos los objetos de columna de la tabla de evaluación como tipo
"ICCAxCollection".
Sintaxis
Expresión.GetRulerColumnCollection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Ejemplo
'VBS325
Dim ctrl
Dim coll
Dim rulercol
Set ctrl = ScreenItems("RulerControl")
Set coll = ctrl.GetRulerColumnCollection
HMIRuntime.Trace "Number of ruler columns:" & coll.Count & vbCrLf
For Each rulercol In coll
HMIRuntime.Trace rulercol.Index & vbCrLf
HMIRuntime.Trace rulercol.Name & vbCrLf
HMIRuntime.Trace rulercol.Sort & vbCrLf
HMIRuntime.Trace rulercol.SortIndex & vbCrLf
Next
Consulte también
OnlineTrendControl (Página 1443)
TrendRulerControl (Página 1508)
Descripción
Devuelve el valor de la curva solicitada en la posición de la regla.
Sintaxis
Expresión.GetRulerData(ByVal RulerIndex As Long, pvValue As Variant,
Optional pvTimeStamp As Variant, Optional pvFlags As Varian) Long
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "Trend".
Parámetro
Parámetros Descripción
RulerIndex 0 =Lineal
pvValue Valor del eje X
pvTimeStamp Instante y valor del eje Y
pvFlags Qualitycode
Ejemplo
'VBS326
Dim ctrl
Dim objTrend
Dim objIOField1
Dim objIOField2
Dim rulvalue
Dim rultime
Set ctrl = ScreenItems( "Control1" )
Set objTrend = ctrl.GetTrend( "Trend 1" )
Set objIOField1 = ScreenItems( "I/O Field1" )
Set objIOField2 = ScreenItems( "I/O Field2" )
objTrend.GetRulerData 0, rulvalue, rultime
objIOField1.OutputValue = rulvalue
objIOField2.OutputValue = rultime
Consulte también
OnlineTrendControl (Página 1443)
Descripción
Devuelve como tipo "ICCAxDataRow" el objeto de filas seleccionado de un control basado en
tablas.
Sintaxis
Expresión.GetSelectedRow()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Ejemplo
'VBS358
Dim ctrl
Dim lCellIndex
Dim lCellCount
Dim headingRow
Dim selectedRow
Set ctrl = ScreenItems("TableControl")
Set headingRow = ctrl.GetRow(0)
Set selectedRow = ctrl.GetSelectedRow
lCellCount = headingRow.CellCount
'enumerate and trace out column titles and cell texts
For lCellIndex = 1 To lCellCount
HMIRuntime.trace headingRow.CellText(lCellIndex) & ": "
HMIRuntime.trace selectedRow.CellText(lCellIndex)
HMIRuntime.trace vbNewLine
Next
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "Row" debe escribirse, p. ej., "objRow.CellCount" en lugar de
"objRow.RowCellCount".
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
TrendRulerControl (Página 1508)
UserArchiveControl (Página 1528)
AlarmControl (Página 1338)
Descripción
Con selección múltiple, devuelve como tipo "ICCAxDataRow" los objetos de filas
seleccionados de un control basado en tablas.
Sintaxis
Expresión.GetSelectedRows()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Ejemplo
'VBS359
Dim ctrl
Dim lCellIndex
Dim lCellCount
Dim lRowIndex
Dim lRowCount
Dim headingRow
Dim selectedRow
Dim selectedRows
Set ctrl = ScreenItems("TableControl")
Set headingRow = ctrl.GetRow(0)
Set selectedRows = ctrl.GetSelectedRows
lCellCount = headingRow.CellCount
lRowCount = selectedRows.Count
'enumerate selected rows
For lRowIndex = 1 To lRowCount
Set selectedRow = selectedRows(lRowIndex)
HMIRuntime.Trace "Row number: " & CStr(lRowIndex) & vbNewLine
'enumerate and trace out column titles and cell texts
For lCellIndex = 1 To lCellCount
HMIRuntime.trace headingRow.CellText(lCellIndex) & ": "
HMIRuntime.trace selectedRow.CellText(lCellIndex)
HMIRuntime.trace vbNewLine
Next
Next
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "Row" debe escribirse, p. ej., "objRow.CellCount" en lugar de
"objRow.RowCellCount".
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
TrendRulerControl (Página 1508)
UserArchiveControl (Página 1528)
AlarmControl (Página 1338)
Descripción
Devuelve el objeto de columna designado por nombre o índice de la ventana del área
estadística de la tabla de evaluación como tipo "ICCAxRulerColumn".
Sintaxis
Expresión.GetStatisticAreaColumn(ByVal vIndex As Variant)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
VARIANT
Parámetro Descripción
vIndex Índice o nombre de la columna de la ventana del
área estadística.
Ejemplo
'VBS327
Dim ctrl
Dim objStatAreaCol
Set ctrl = ScreenItems("RulerControl")
Set objStatAreaCol = ctrl.GetStatisticAreaColumn("DatasourceY")
objStatAreaCol.Visible = FALSE
Set objStatAreaCol = ctrl.GetStatisticAreaColumn("ValueY(LL)")
objStatAreaCol.Sort = 1
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "StatisticAreaColumn" debe escribirse, p. ej., "objStatAreaCol.Visible" en lugar
de "objStatAreaCol.ColumnVisible".
Consulte también
OnlineTrendControl (Página 1443)
TrendRulerControl (Página 1508)
Descripción
Devuelve el listado de todos los objetos de columna de la ventana del área estadística de la
tabla de evaluación como tipo "ICCAxCollection".
Sintaxis
Expresión.GetStatisticAreaColumnCollection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Ejemplo
'VBS328
Dim ctrl
Dim coll
Dim statcol
Set ctrl = ScreenItems("RulerControl")
Set coll = ctrl.GetStatisticAreaColumnCollection
HMIRuntime.Trace "Number of statistic Area columns:" & coll.Count & vbCrLf
For Each statcol In coll
HMIRuntime.Trace statcol.Index & vbCrLf
HMIRuntime.Trace statcol.Name & vbCrLf
HMIRuntime.Trace statcol.Sort & vbCrLf
HMIRuntime.Trace statcol.SortIndex & vbCrLf
Next
Consulte también
OnlineTrendControl (Página 1443)
TrendRulerControl (Página 1508)
Descripción
Devuelve el objeto de columna designado por nombre o índice de la ventana estadística de
la tabla de evaluación como tipo "ICCAxRulerColumn".
Sintaxis
Expresión.GetStatisticResultColumn(ByVal vIndex As Variant)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
VARIANT
Parámetro Descripción
vIndex Índice o nombre de la columna de la ventana es‐
tadística.
Ejemplo
'VBS329
Dim ctrl
Dim objStatResCol
Set ctrl = ScreenItems("RulerControl")
Set objStatResCol = ctrl.GetStatisticResultColumn("MaxValue")
objStatResCol.Visible = FALSE
Set objStatResCol = ctrl.GetStatisticResultColumn("Average")
objStatResCol.Sort = 2
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "StatisticResultColumn" debe escribirse, p. ej., "objStatResCol.Visible" en lugar
de "objStatResCol.ColumnVisible".
Consulte también
OnlineTrendControl (Página 1443)
TrendRulerControl (Página 1508)
Descripción
Devuelve el listado de todos los objetos de columna de la ventana estadística de la tabla de
evaluación como tipo "ICCAxCollection".
Sintaxis
Expresión.GetStatisticResultColumnCollection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Ejemplo
'VBS330
Dim ctrl
Dim coll
Dim statcol
Set ctrl = ScreenItems("RulerControl")
Set coll = ctrl.GetStatisticResultColumnCollection
HMIRuntime.Trace "Number of statistic result columns:" & coll.Count & vbCrLf
For Each statcol In coll
HMIRuntime.Trace statcol.Index & vbCrLf
HMIRuntime.Trace statcol.Name & vbCrLf
HMIRuntime.Trace statcol.Sort & vbCrLf
HMIRuntime.Trace statcol.SortIndex & vbCrLf
Next
Consulte también
OnlineTrendControl (Página 1443)
TrendRulerControl (Página 1508)
Descripción
Devuelve el elemento de la barra de estado designado por nombre o índice del control como
tipo "ICCAxStatusbarElement".
Sintaxis
Expresión.GetColumn(ByVal vIndex As Variant)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
VARIANT
Parámetro Descripción
vIndex Índice o nombre del elemento de la barra de esta‐
do.
Ejemplo
'VBS331
Dim ctrl
Dim objStatusBar
Set ctrl = ScreenItems( "Control1" )
Set objStatusBar = ctrl.GetStatusbarElement(1)
objStatusBar.Visible = FALSE
Set objStatusBar = ctrl.GetStatusbarElement(3)
objStatusBar.Width = 10
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "StatusbarElement" debe escribirse, p. ej., "objStatusBar.Visible" en lugar de
"objStatusBar.StatusbarElementVisible".
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
TrendRulerControl (Página 1508)
UserArchiveControl (Página 1528)
FunctionTrendControl (Página 1397)
AlarmControl (Página 1338)
Descripción
Devuelve el listado de todos los elementos de la barra de estado del control como tipo
"ICCAxCollection".
Sintaxis
Expresión.GetStatusbarElementCollection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Ejemplo
'VBS332
Dim ctrl
Dim coll
Dim statelement
Set ctrl = ScreenItems.Item("Control1")
Set coll = ctrl.GetStatusbarElementCollection
HMIRuntime.Trace "Number of statusbar elements:" & coll.Count & vbCrLf
For Each statelement In coll
HMIRuntime.Trace statelement.Name & vbCrLf
HMIRuntime.Trace statelement.Width & vbCrLf
HMIRuntime.Trace statelement.Text & vbCrLf
Next
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "StatusbarElement" debe escribirse, p. ej., "statelement.Name" en lugar de
"statelement.StatusbarElementName".
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
TrendRulerControl (Página 1508)
UserArchiveControl (Página 1528)
FunctionTrendControl (Página 1397)
AlarmControl (Página 1338)
Descripción
Devuelve el objeto de eje de tiempo, designado con un nombre o índice, del visor de curvas
f(t) como tipo "ICCAxTimeAxis".
Sintaxis
Expresión.GetTimeAxis(ByVal vIndex As Variant)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetros
VARIANT
Parámetros Descripción
vIndex Índice o nombre del eje temporal.
Ejemplo
'VBS333
Dim ctrl
Dim objTimeAxis
Set ctrl = ScreenItems("OnlineTrendControl")
Set objTimeAxis = ctrl.GetTimeAxis(1)
objTimeAxis.Visible = FALSE
Set objTimeAxis = ctrl.GetTimeAxis("axis 2")
objTimeAxis.Label = "Time axis 2"
objTimeAxis.DateFormat = "dd.MM.yy"
objTimeAxis.TimeFormat = "HH:mm:ss.ms"
objTimeAxis.RangeType = 2
'The format to be used for date and time entries depends on the
'regional settings and language options in the operating system.
objTimeAxis.BeginTime = "06.04.2010 9:33:18"
'objTimeAxis.BeginTime = "04/06/2010 9:33:18"
objTimeAxis.MeasurePoints = 100
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "TimeAxis" debe escribirse, p. ej., "objTimeAx.Visible" en lugar de
"objTimeAx.TimeAxisVisible".
Consulte también
OnlineTrendControl (Página 1443)
Descripción
Devuelve el listado de todos los objetos de eje de tiempo del visor de curvas f(t) como tipo
"ICCAxCollection".
Sintaxis
Expresión.GetTimeAxisCollection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetros
--
Ejemplo
'VBS334
Dim ctrl
Dim objTrendWnd
Dim objTimeAxis1
Dim objTimeAxis2
Dim objTrend
Set ctrl = ScreenItems("OnlineTrendControl")
Set objTrendWnd = ctrl.GetTrendWindowCollection.AddItem("myWindow")
Set objTimeAxis1 = ctrl.GetTimeAxisCollection.AddItem("TimeAxis2010")
Set objTimeAxis2 = ctrl.GetTimeAxisCollection.AddItem("TimeAxis2011")
objTimeAxis1.TrendWindow = objTrendWnd.Name
objTimeAxis1.Label = "2010"
objTimeAxis1.RangeType = 1
'The format to be used for date and time entries depends on the
'regional settings and language options in the operating system.
objTimeAxis1.BeginTime = "01.01.2010 0:00:00"
'objTimeAxis1.BeginTime = "01/01/2010 0:00:00"
objTimeAxis1.EndTime = "31.12.2010 11:59:59"
'objTimeAxis1.EndTime = "12/31/2010 11:59:59"
objTimeAxis2.TrendWindow = objTrendWnd.Name
objTimeAxis2.Label = "2011"
objTimeAxis2.RangeType = 1
objTimeAxis2.BeginTime = "01.01.2011 0:00:00"
'objTimeAxis2.BeginTime = "01/01/2011 0:00:00"
objTimeAxis2.EndTime = "31.12.2011 11:59:59"
'objTimeAxis2.EndTime = "12/31/2011 11:59:59"
Set objTrend = ctrl.GetTrendCollection.AddItem("myTrend1")
objTrend.TrendWindow = objTrendWnd.Name
objTrend.TimeAxis = objTimeAxis1.Name
Set objTrend = ctrl.GetTrendCollection.AddItem("myTrend2")
objTrend.TrendWindow = objTrendWnd.Name
objTrend.TimeAxis = objTimeAxis2.Name
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "TimeAxis" debe escribirse, p. ej., "objTimeAxis1.Label" en lugar de
"objTimeAxis1.TimeAxisLabel".
Consulte también
OnlineTrendControl (Página 1443)
Descripción
Devuelve el objeto de columna de tiempo designado por nombre o índice del visor de tablas
como tipo "ICCAxTimeColumn".
Sintaxis
Expresión.GetTimeColumn(ByVal vIndex As Variant)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
VARIANT
Parámetro Descripción
vIndex Índice o nombre de la columna de tiempo.
Ejemplo
'VBS335
Dim ctrl
Dim objTimeCol
Set ctrl = ScreenItems("TableControl")
Set objTimeCol = ctrl.GetTimeColumn("Timecolumn1")
objTimeCol.ShowDate = FALSE
Set objTimeCol = ctrl.GetTimeColumn("Timecolumn2")
objTimeCol.Visible = FALSE
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "TimeColumn" debe escribirse, p. ej., "objTimeColumn.ShowDate" en lugar de
"objTimeColumn.TimeColumnShowDate".
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
Descripción
Devuelve el listado de todos los objetos de columna de tiempo del visor de tablas como tipo
"ICCAxCollection".
Sintaxis
Expresión.GetTimeColumnCollection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetros
--
Ejemplo
'VBS336
Dim ctrl
Dim objTimeCol1
Dim objTimeCol2
Dim coll
Dim timecol
Set ctrl = ScreenItems("TableControl")
Set objTimeCol1 = ctrl.GetTimeColumnCollection.AddItem("TimeColumn2010")
Set objTimeCol2 = ctrl.GetTimeColumnCollection.AddItem("TimeColumn2011")
objTimeCol1.Caption = "2010"
objTimeCol1.RangeType = 1
'The format to be used for date and time entries depends on the
'regional settings and language options in the operating system.
objTimeCol1.BeginTime = "01.01.2010 0:00:00"
'objTimeCol1.BeginTime = "01/01/2010 0:00:00"
objTimeCol1.EndTime = "31.12.2010 11:59:59"
'objTimeCol1.EndTime = "12/31/2010 11:59:59"
objTimeCol2.Caption = "2011"
objTimeCol2.RangeType = 0
objTimeCol2.BeginTime = "01.01.2011 0:00:00"
'objTimeCol2.BeginTime = "01/01/2011 0:00:00"
objTimeCol2.TimeRangeFactor = 1
objTimeCol2.TimeRangeBase = 3600000
Set coll = ctrl.GetTimeColumnCollection
For Each timecol In coll
timecol.Align = 1
timecol.Length = 12
timecol.BackColor = RGB(240,240,0)
timecol.ForeColor = RGB(130,160,255)
Next
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
Descripción
Devuelve la función de tecla designada por nombre o índice de la barra de herramientas del
control como tipo "ICCAxToolbarButton".
Sintaxis
Expresión.GetToolbarButton(ByVal vIndex As Variant)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
VARIANT
Parámetro Descripción
vIndex Índice o nombre de la función de tecla de la barra
de herramientas.
Ejemplo
'VBS337
Dim ctrl
Set ctrl = ScreenItems( "Control1" )
Dim toolbu
Set toolbu = ctrl.GetToolbarButton ("ShowHelp")
HMIRuntime.Trace "Name: " & toolbu.Name & vbCrLf
HMIRuntime.Trace "Index: " & toolbu.Index & vbCrLf
HMIRuntime.Trace "Hotkey: " & toolbu.HotKey & vbCrLf
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "ToolbarButton" debe escribirse, p. ej., "toolbu.Index" en lugar de
"toolbu.ToolbarButtonIndex".
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
TrendRulerControl (Página 1508)
UserArchiveControl (Página 1528)
FunctionTrendControl (Página 1397)
AlarmControl (Página 1338)
Descripción
Devuelve el listado de todas las funciones de tecla de la barra de herramientas del control
como tipo "ICCAxCollection".
Sintaxis
Expresión.GetToolbarButtonCollection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Ejemplo
'VBS338
Dim ctrl
Dim coll
Dim toolbu
Set ctrl = ScreenItems( "Control1" )
Set coll = ctrl.GetToolbarButtonCollection
HMIRuntime.Trace "Number of toolbar buttons:" & coll.Count & vbCrLf
For Each toolbu In coll
HMIRuntime.Trace toolbu.Name & vbCrLf
HMIRuntime.Trace "Hotkey: " & toolbu.HotKey & vbCrLf
HMIRuntime.Trace "Authorization: " & toolbu.PasswordLevel & vbCrLf
Next
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
TrendRulerControl (Página 1508)
UserArchiveControl (Página 1528)
FunctionTrendControl (Página 1397)
AlarmControl (Página 1338)
Descripción
Devuelve la curva designada por nombre o índice del visor de curvas f(t) o f(x) como tipo
"ICCAxTrend" o "ICCAxFunctionTrend".
Sintaxis
Expresión.GetTrend(ByVal vIndex As Variant)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
VARIANT
Parámetro Descripción
vIndex Índice o nombre de la curva.
'VBS339
Dim ctrl
Dim objTrend
Set ctrl = ScreenItems("OnlineTrendControl")
Set objTrend = ctrl.GetTrend( "Trend 1" )
objTrend.PointStyle = 1
objTrend.LineWidth = 4
Set objTrend = ctrl.GetTrend(2)
objTrend.Provider = 1
objTrend.TagName = "Archive\ArchiveTag2"
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "Trend" debe escribirse, p. ej., "objTrend.PointStyle" en lugar de
"objTrend.TrendPointStyle".
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Devuelve el listado de todas las curvas del visor de curvas f(t) o f(x) como tipo
"ICCAxCollection".
Sintaxis
Expresión.GetTrendCollection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
'VBS340
Dim ctrl
Dim objTrendWnd
Dim objTimeAxis
Dim objValAxis
Dim objTrend
Set ctrl = ScreenItems("OnlineTrendControl")
Set objTrendWnd = ctrl.GetTrendWindowCollection.AddItem("myWindow")
Set objTimeAxis = ctrl.GetTimeAxisCollection.AddItem("myTimeAxis")
Set objValAxis = ctrl.GetValueAxisCollection.AddItem("myValueAxis")
objTimeAxis.TrendWindow = objTrendWnd.Name
objValAxis.TrendWindow = objTrendWnd.Name
Set objTrend = ctrl.GetTrendCollection.AddItem("myTrend1")
objTrend.Provider = 1
objTrend.TagName = "Archive\ArchiveTag1"
objTrend.TrendWindow = objTrendWnd.Name
objTrend.TimeAxis = objTimeAxis.Name
objTrend.ValueAxis = objValAxis.Name
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "Trend" debe escribirse, p. ej., "objTrend.TagName" en lugar de
"objTrend.TrendTagName".
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Devuelve el objeto de ventana de curvas designado por nombre o índice del visor de curvas
f(t) o f(x) como tipo "ICCAxTrendWindow".
Sintaxis
Expresión.GetTrendWindow(ByVal vIndex As Variant)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
VARIANT
Parámetro Descripción
vIndex Índice o nombre de la ventana de curva.
'VBS341
Dim ctrl
Dim objTrendWnd
Set ctrl = ScreenItems("OnlineTrendControl")
Set objTrendWnd = ctrl.GetTrendWindow(1)
objTrendWnd.Visible = FALSE
Set objTrendWnd = ctrl.GetTrendWindow("trend window 2")
objTrendWnd.VerticalGrid = TRUE
objTrendWnd.FineGrid = TRUE
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "TrendWindow" debe escribirse, p. ej., "objTrendWnd.Visible" en lugar de
"objTrendWnd.TrendWindowVisible".
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Devuelve el listado de todos los objetos de ventana de curvas del visor de curvas f(t) o f(x)
como tipo "ICCAxCollection".
Sintaxis
Expresión.GetTrendWindowCollection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
'VBS342
Dim ctrl
Dim objTrendWnd
Dim objTimeAxis
Dim objValAxis
Set ctrl = ScreenItems("OnlineTrendControl")
Set objTrendWnd = ctrl.GetTrendWindowCollection.AddItem("myWindow")
Set objTimeAxis = ctrl.GetTimeAxisCollection.AddItem("myTimeAxis")
Set objValAxis = ctrl.GetValueAxisCollection.AddItem("myValueAxis")
objTimeAxis.TrendWindow = objTrendWnd.Name
objValAxis.TrendWindow = objTrendWnd.Name
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Devuelve el objeto de eje de valores designado por nombre o índice del visor de curvas f(t)
como tipo "ICCAxValueAxis".
Sintaxis
Expresión.GetValueAxis(ByVal vIndex As Variant)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
VARIANT
Parámetro Descripción
vIndex Índice o nombre del eje de valores.
Ejemplo
'VBS343
Dim ctrl
Dim objValAxis
Set ctrl = ScreenItems("OnlineTrendControl")
Set objValAxis = ctrl.GetValueAxis(1)
objValAxis.Visible = FALSE
Set objValAxis = ctrl.GetValueAxis("axis 2")
objValAxis.Label = "Value axis 2"
objValAxis.ScalingType = 0
objValAxis.Precisions = 2
objValAxis.AutoRange = TRUE
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "ValueAxis" debe escribirse, p. ej., "objValueAx.Visible" en lugar de
"objValueAx.ValueAxisVisible".
Consulte también
OnlineTrendControl (Página 1443)
Descripción
Devuelve el listado de todos los objetos de eje de valores del visor de curvas f(t) como tipo
"ICCAxCollection".
Sintaxis
Expresión.GetValueAxisCollection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Ejemplo
'VBS344
Dim ctrl
Dim objTrendWnd
Dim objValAxis1
Dim objValAxis2
Dim objTrend
Set ctrl = ScreenItems("OnlineTrendControl")
Set objTrendWnd = ctrl.GetTrendWindowCollection.AddItem("myWindow")
Set objValAxis1 = ctrl.GetValueAxisCollection.AddItem("myValueAxis1")
Set objValAxis2 = ctrl.GetValueAxisCollection.AddItem("myValueAxis2")
objValAxis1.TrendWindow = objTrendWnd.Name
objValAxis1.Label = "Value1"
objValAxis2.TrendWindow = objTrendWnd.Name
objValAxis2.inTrendColor = TRUE
Set objTrend = ctrl.GetTrendCollection.AddItem("myTrend1")
objTrend.TrendWindow = objTrendWnd.Name
objTrend.ValueAxis = objValAxis1.Name
Set objTrend = ctrl.GetTrendCollection.AddItem("myTrend2")
objTrend.TrendWindow = objTrendWnd.Name
objTrend.ValueAxis = objValAxis2.Name
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "ValueAxis" debe escribirse, p. ej., "objValueAxis1.Label" en lugar de
"objValueAxis1.ValueAxisLabel".
Consulte también
OnlineTrendControl (Página 1443)
Descripción
Devuelve el objeto de columna de valores, designado con un nombre o índice, del visor de
tablas como tipo "ICCAxValueColumn".
Sintaxis
Expresión.GetValueColumn(ByVal vIndex As Variant)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetros
VARIANT
Parámetro Descripción
vIndex Índice o nombre de la columna de valores del visor de curvas
f(t).
Ejemplo
'VBS345
Dim ctrl
Dim objValueColumn
Set ctrl = ScreenItems("TableControl")
Set objValueColumn = ctrl.GetValueColumn("Valuecolumn1")
objValueColumn.Precisions = 4
Set objValueColumn = ctrl.GetValueColumn(2)
objValueColumn.ExponentialFormat = TRUE
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "ValueColumn" debe escribirse, p. ej., "objValueColumn.Precisions" en lugar de
"objValueColumn.ValueColumnPrecisions".
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
Descripción
Devuelve el listado de todos los objetos de columna de valores del visor de curvas f(t) como
tipo "ICCAxCollection".
Sintaxis
Expresión.GetValueColulmnCollection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Ejemplo
'VBS346
Dim ctrl
Dim objValCol1
Dim objValCol2
Dim coll
Dim valcol
Set ctrl = ScreenItems("TableControl")
Set objValCol1 = ctrl.GetValueColumnCollection.AddItem("ValueColumn1")
Set objValCol2 = ctrl.GetValueColumnCollection.AddItem("ValueColumn2")
objValCol1.Caption = "Value Archive"
objValCol1.Provider = 1
objValCol1.TagName = "ProcessValueArchive\arch1"
objValCol1.TimeColumn = "TimeColumn1"
objValCol2.Caption = "Value Tag"
objValCol2.Provider = 2
objValCol2.TagName = "tagxx"
objValCol2.TimeColumn = "TimeColumn2"
Set coll = ctrl.GetValueColumnCollection
For Each valcol In coll
valcol.Align = 2
valcol.Length = 10
valcol.AutoPrecisions = TRUE
Next
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
Descripción
Devuelve el objeto de eje X designado por nombre o índice del visor de curvas f(x) como tipo
"ICCAxValueAxis".
Sintaxis
Expresión.GetXAxis(ByVal vIndex As Variant)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
VARIANT
Parámetro Descripción
vIndex Índice o nombre del eje X.
Ejemplo
'VBS347
Dim ctrl
Dim objXAx
Set ctrl = ScreenItems("FunctionTrendControl")
Set objXAx = ctrl.GetXAxis(1)
objXAx.Visible = FALSE
Set objXAx = ctrl.GetXAxis("axis 2")
objXAx.Label = "X axis 2"
objXAx.ScalingType = 0
objXAx.Precisions = 2
objXAx.Color = RGB(109,109,109)
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "XAxis" debe escribirse, p. ej., "objXAx.Visible" en lugar de "objXAx.XAxisVisible".
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Devuelve el listado de todos los objetos de eje X del visor de curvas f(x) como tipo
"ICCAxCollection".
Sintaxis
Expresión.GetXAxisCollection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Ejemplo
'VBS348
Dim ctrl
Dim objXAxis1
Dim objXAxis2
Dim coll
Dim axes
Set ctrl = ScreenItems("FunctionTrendControl")
Set objXAxis1 = ctrl.GetXAxisCollection.AddItem("myXAxis1")
objXAxis1.Label = "temperature"
Set objXAxis2 = ctrl.GetXAxisCollection.AddItem("myXAxis2")
objXAxis2.Label = "pressure"
Set coll = ctrl.GetXAxisCollection
HMIRuntime.Trace "Number of XAxis:" & coll.Count & vbCrLf
For Each axes In coll
HMIRuntime.Trace axes.Name & vbCrLf
HMIRuntime.Trace axes.Label & vbCrLf
Next
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "XAxis" debe escribirse, p. ej., "objXAxis1.Label" en lugar de
"objXAxis1.XAxisLabel".
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Devuelve el objeto de eje Y designado por nombre o índice del visor de curvas f(x) como tipo
"ICCAxValueAxis".
Sintaxis
Expresión.GetYAxis(ByVal vIndex As Variant)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
VARIANT
Parámetro Descripción
vIndex Índice o nombre del eje Y.
Ejemplo
'VBS349
Dim ctrl
Dim objYAx
Set ctrl = ScreenItems("FunctionTrendControl")
Set objYAx = ctrl.GetYAxis(1)
objYAx.Visible = FALSE
Set objYAx = ctrl.GetYAxis("axis 2")
objYAx.Label = "Y axis 2"
objYAx.Align = 0
objYAx.Precisions = 3
objYAx.EndValue = 90.000
objYAx.BeginValue = 10.000
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "YAxis" debe escribirse, p. ej., "objYAx.Visible" en lugar de "objYAx.YAxisVisible".
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Devuelve el listado de todos los objetos de eje Y del visor de curvas f(x) del tipo
"ICCAxCollection".
Sintaxis
Expresión.GetYAxisCollection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Ejemplo
'VBS350
Dim ctrl
Dim objYAxis1
Dim objYAxis2
Dim coll
Dim axes
Set ctrl = ScreenItems("FunctionTrendControl")
Set objYAxis1 = ctrl.GetXAxisCollection.AddItem("myYAxis1")
objYAxis1.Label = "temperature"
Set objYAxis2 = ctrl.GetXAxisCollection.AddItem("myYAxis2")
objYAxis2.Label = "pressure"
Set coll = ctrl.GetYAxisCollection
HMIRuntime.Trace "Number of YAxis:" & coll.Count & vbCrLf
For Each axes In coll
HMIRuntime.Trace axes.Name & vbCrLf
HMIRuntime.Trace axes.Label & vbCrLf
Next
Nota
Si se utilizan Métodos "Get..." para acceder a las propiedades a través del listado del objeto
Control y no a través del objeto Control, debe omitirse el prefijo de la propiedad con el nombre
del listado.
En el listado "YAxis" debe escribirse, p. ej., "objYAxis1.Label" en lugar de
"objYAxis1.YAxisLabel".
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Ejecuta la función del botón "Ocultar aviso" del visor de avisos.
Sintaxis
Expresión.HideAlarm()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Añade datos a la curva solicitada.
Sintaxis
Expresión.InsertData(dblAxisX As Variant, dblAxisY As Variant)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "Trend".
Parámetro
Parámetro Descripción
dblAxisX Valor del eje X
dblAxisY Valor del eje Y
Ejemplo
'VBS300
Dim lngFactor
Dim dblAxisX
Dim dblAxisY
Dim objTrendControl
Dim objTrend
Set objTrendControl = ScreenItems("Control1")
Set objTrend = objTrendControl.GetTrend("Trend 1")
For lngFactor = -100 To 100
dblAxisX = CDbl(lngFactor * 0.02)
dblAxisY = CDbl(dblAxisX * dblAxisX + 2 * dblAxisX + 1)
objTrend.InsertData dblAxisX, dblAxisY
Next
Descripción
Devuelve un elemento de una lista.
Sintaxis
Expression.Item(Index)
Expression
Obligatorio. Expresión que devuelve una lista.
Parámetro
Índice
Nombre o número de índice de un elemento de la lista:
● Lista ScreenItems: Utilice el nombre de objeto, p. ej.
"HmiRuntime.Screens(1).ScreenItems("Circle")", o bien el número de índice.
● Lista Screens: Utilice el nombre o el número de índice.
● Lista SmartTags: En la lista "SmartTags", sólo los nombres de variables se pueden utilizar
como índice. Por tanto, no es posible enumerar todas las variables.
Si el valor indicado no coincide con ningún elemento de la lista, aparecerá un error. El valor
de retorno obtendrá el valor "Nothing".
Ejemplo
El método "Item" es el método estándar para las listas. Por tanto, los dos siguientes ejemplos
ofrecen el mismo resultado:
'VBS_Example_Item
HMIRuntime.Screens.Item(1)
HMIRuntime.Screens(1)
Consulte también
ScreenItems (lista) (Página 1325)
ScreenItem (Página 1323)
Descripción
Ejecuta la función del botón "Bloquear aviso" del visor de avisos.
Sintaxis
Expresión.LockAlarm()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Loop in Alarm" del visor de avisos.
Sintaxis
Expresión.LoopInAlarm()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Desplazar área del eje" de los visores de curvas f(t) y f(x).
Sintaxis
Expresión.MoveAxis()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Ejecuta la función del botón "Primera fila" del control.
Sintaxis
Expresión.MoveToFirst()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetros
--
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
UserArchiveControl (Página 1528)
Descripción
Ejecuta la función del botón "Primer aviso" del visor de avisos.
Sintaxis
Expresión.MoveToFirstLine()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Primera página" del visor de avisos.
Sintaxis
Expresión.MoveToFirstPage()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Último registro" del control.
Sintaxis
Expresión.MoveToLast()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetros
--
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
UserArchiveControl (Página 1528)
Descripción
Ejecuta la función del botón "Último aviso" del visor de avisos.
Sintaxis
Expresión.MoveToLastLine()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Última página" del visor de avisos.
Sintaxis
Expresión.MoveToLastPage()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Registro siguiente" del control.
Sintaxis
Expresión.MoveToNext()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetros
--
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
UserArchiveControl (Página 1528)
Descripción
Ejecuta la función del botón "Aviso siguiente" del visor de avisos.
Sintaxis
Expresión.MoveToNextLine()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Página siguiente" del visor de avisos.
Sintaxis
Expresión.MoveToNextPage()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Registro anterior" del control.
Sintaxis
Expresión.MoveToPrevious()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetros
--
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
UserArchiveControl (Página 1528)
Descripción
Ejecuta la función del botón "Aviso anterior" del visor de avisos.
Sintaxis
Expresión.MoveToPreviousLine()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Página anterior" del visor de avisos.
Sintaxis
Expresión.MoveToPreviousPage()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Columna siguiente" del visor de tablas.
Sintaxis
Expresión.NextColumn()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
OnlineTableControl (Página 1434)
Descripción
Ejecuta la función del botón "Siguiente curva" de los visores de curvas f(t) y f(x).
Sintaxis
Expresión.NextTrend()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Ejecuta la función del botón "Vista original" de los visores de curvas f(t) y f(x).
Sintaxis
Expresión.OneToOneView()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
VARIANT
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Ejecuta la función del botón "Insertar líneas" del visor de recetas.
Sintaxis
Expresión.PasteRows()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
UserArchiveControl (Página 1528)
Descripción
Ejecuta la función del botón "Columna anterior" del visor de tablas.
Sintaxis
Expresión.PreviousColumn()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
OnlineTableControl (Página 1434)
Descripción
Ejecuta la función del botón "Curva anterior" de los visores de curvas f(t) y f(x).
Sintaxis
Expresión.PreviousTrend()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Ejecuta la función del botón "Imprimir" del control.
Sintaxis
Expresión.Print()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetros
--
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
TrendRulerControl (Página 1508)
UserArchiveControl (Página 1528)
FunctionTrendControl (Página 1397)
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Acuse de avisador central" del visor de avisos.
Sintaxis
Expresión.QuitHorn()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Acuse individual" del visor de avisos.
Sintaxis
Expresión.QuitSelected()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Acuse de grupo" del visor de avisos.
Sintaxis
Expresión.QuitVisible()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Leer variables" del visor de recetas.
Sintaxis
Expresión.ReadTags()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
UserArchiveControl (Página 1528)
Propiedad Ocupación
Value Valor de las variables
Nombre Nombre de variable (no modificado)
QualityCode Nivel de calidad
TimeStamp Sello de tiempo actual de las variables
LastError 0
ErrorDescription ""
Si no se lee con éxito el valor de las variables, entonces las propiedades del objeto Tag serán
ocupadas con los siguientes valores:
Propiedad Ocupación
Value VT_Empty
Nombre Nombre de variable (no modificado)
QualityCode Bad Out of Service
TimeStamp 0
LastError Código de error de la operación de lectura
ErrorDescription Descripción del error de LastError
Sintaxis
Expresión.Read([Readmode])
Expresión
Se necesita. Una expresión que retorna un objeto Tag. El valor de retorno del método Read
es el valor de las variables leídas.
Parámetro
Por medio del parámetro opcional "Readmode" se diferencia entre dos tipos de lectura:
Parámetro Descripción
0 El valor de las variables es leído de la imagen del
proceso (cache). 0 es el valor Default.
1 El valor de las variables es leído directamente del
PLC o del canal (sincrónicamente).
variables son solicitadas al mismo tiempo, el canal podrá lograr la mejor optimización posible.
Si dentro de una acción se solicita con Read una variable contenida en un disparador, ya
existirá el valor y será entregado a la llamada. Si se solicita una variable que no está en un
disparador, el comportamiento será como en un disparador estándar (trigger estándar).
Comportamiento en acciones con disparador cíclico
En una primera llamada, la variable será identificada con la mitad del ciclo. En cada llamada
siguiente ya existirá el valor.
Comportamiento en acciones disparadas por eventos
En una primera llamada, la variable será identificada en el modo "Al cambiar". Las variables
de proceso que están identificadas en el modo "Al cambiar" corresponden a una orden de
lectura cíclica con un ciclo de 1s.
Si con un evento (p. ej. clic del ratón) se solicita asincrónicamente un valor, la variable será
aceptada en la imagen de variable. A partir de este momento la variable será solicitada
cíclicamente del PLC y por consiguiente incrementará la carga básica. Para evadir este
incremento de la carga básica, Ud. puede leer el valor también sincrónicamente. La llamada
sincrónica ocasiona, por cierto, una vez una mayor carga de comunicación, pero la variable
no será aceptada en la imagen de variable.
Leer directamente
En una lectura directa se retornará el valor actual. La variable no será identificada
cíclicamente, sino el valor será solicitado una vez del PLC. La lectura directa tiene las
siguientes propiedades:
● El valor será leído explícitamente del PLC
● La ejecución dura más tiempo en comparación a la lectura desde la imagen de proceso
● La duración de la llamada depende, entre otras razones, de lo recargado que esté el bus
o del PLC
Ejemplo
Lectura de una variable directamente desde el PLC o el canal
'VBS100
Dim objTag
Dim vntValue
Set objTag = HMIRuntime.Tags("Tagname")
vntValue = objTag.Read(1) 'Read direct
MsgBox vntValue
'VBS101
Dim objTag
Dim vntValue
Set objTag = HMIRuntime.Tags("Tagname")
vntValue = objTag.Read 'Read from cache
MsgBox vntValue
Expresión
Se necesita. Una expresión que retorna un objeto de tipo "TagSet".
Leer directamente
En una ejecución se pueden procesar varias órdenes de lectura, mejorándose así el
rendimiento en comparación a varias ejecuciones individuales.
Ejemplo
El ejemplo siguiente muestra cómo se introducen variables en el listado TagSet y cómo se
leen después.
'VBS174
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
group.Add "Motor1"
group.Add "Motor2"
group.Read
HMIRuntime.Trace "Motor1: " & group("Motor1").Value & vbNewLine
HMIRuntime.Trace "Motor2: " & group("Motor2").Value & vbNewLine
Si el parámetro opcional "Readmode" se define con 1, las variables de proceso no serán dadas
de alta sino serán leídas directamente desde el PLC o el canal.
group.Read 1
Descripción
Dibuja nuevamente todas las imágenes visibles.
Sintaxis
Expresión.Refresh
Expresión
Obligatorio. Una expresión que retorna un objeto de tipo "Screens" o "Screen".
Parámetro
--
Ejemplos
El primer ejemplo obliga el nuevo dibujo inmediato de todas las imágenes visibles:
'VBS149
HMIRuntime.Screens.Refresh
'VBS150
HMIRuntime.Screens(1).Refresh
Consulte también
Screen (Página 1320)
HMIRuntime (Página 1313)
Sintaxis
Expresión.Remove [Tag]
Expresión
Se necesita. Una expresión que retorna un objeto de tipo "TagSet".
Parámetro
VARIANT
Parámetro Descripción
Variable;Tag Nombre de una variable WinCC o referencia de
un objeto Tag que deberá ser eliminado del lista‐
do.
Ejemplo
El siguiente ejemplo muestra cómo se incluyen varias variables en un listado TagSet y cómo
se elimina luego una variable.
'VBS175
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
group.Add "Motor1"
group.Add "Motor2"
group.Remove "Motor1"
Sintaxis
Expresión.Remove [Name]
Expresión
Se necesita. Una expresión que retorna un objeto de tipo "DataSet".
Parámetro
VARIANT
Parámetro Descripción
Nombre Nombre del objeto que debe ser eliminado del lis‐
tado.
Ejemplo
El ejemplo muestra cómo se elimina del listado el objeto "motor1".
'VBS166
HMIRuntime.DataSet.Remove("motor1")
Nota
La activación del método "Remove" se puede ejecutar actualmente sólo en el servidor. Sin
embargo existe un ejemplo que muestra cómo se puede iniciar el método en el cliente desde
el servidor.
Sintaxis
Expresión
Se necesita. Una expresión que retorna un objeto de tipo "Logging" o "AlarmLogs".
Objeto DataLogs
Expresión.Remove [TimeFrom] [TimeTo] [TimeOut] [Type] [ServerPrefix]
Expresión
Se necesita. Una expresión que retorna un objeto de tipo "DataLogs".
Parámetro
TimeFrom
Momento a partir del cual se deben borrar los ficheros.
Al indicar el instante, es posible también una forma abreviada, como se describe en el apartado
"Formato de los datos de tiempo".
TimeTo
Momento hasta el que se deben borrar los segmentos de fichero.
Al indicar el instante, es posible también una forma abreviada, como se describe en el apartado
"Formato de los datos de tiempo".
Timeout
Timeout en milisegundos.
Si introduce "-1" como valor, se esperará de manera infinita (infinite). Si introduce el valor "0",
no se esperará
Tipos
Tipo de fichero.
Este parámetro se puede utilizar (opcional) únicamente para borrar segmentos de ficheros de
Tag Logging.
Pueden introducirse estos valores:
ServerPrefix
Reservado para versiones futuras.
Valor de retorno
Si se ha presentado un error durante el borrado de los segmentos de fichero, el método retorna
un mensaje de error. Para más información consultar el tema "Avisos de fallos del área de
bases de datos".
"TimeTo" = "2004-10-04" se almacenan todos los segmentos de fichero desde septiembre del
2004 hasta el 4 de octubre inclusive.
Ejemplo
En el siguiente ejemplo se eliminarán posteriormente (otra vez) segmentos de fichero
almacenados de un intervalo de tiempo determinado, y el valor de retorno será emitido como
Trace.
'VBS182
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.Remove("2004-08-22","2004-09-22",-1) &
vbNewLine
'VBS183
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.Remove("","",-1) & vbNewLine
Consulte también
Logging (Página 1318)
DataSet (lista) (Página 1311)
DataLogs (lista) (Página 1309)
AlarmLogs (lista) (Página 1306)
Sintaxis
Expresión.RemoveAll
Expresión
Se necesita. Una expresión que retorna un objeto de tipo "TagSet".
Parámetros
--
Ejemplo
El siguiente ejemplo muestra cómo se incluyen varias variables en un listado TagSet y cómo
todas se eliminan luego.
'VBS176
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
group.Add "Motor1"
group.Add "Motor2"
group.RemoveAll
Sintaxis
Expresión.RemoveAll
Expresión
Se necesita. Una expresión que retorna un objeto de tipo "DataSet".
Parámetros
--
Ejemplo
El ejemplo muestra cómo se eliminan todos los objetos del listado.
'VBS167
HMIRuntime.DataSet.RemoveAll
Consulte también
DataSet (lista) (Página 1311)
La ejecución pude durar un tiempo prolongado dependiendo de los datos de fichero. Esto
puede bloquear el procesamiento de los siguientes scripts. Se puede evitar un bloqueo de las
acciones en la imagen iniciando la llamada en una acción en el Global Scripting, por ejemplo
iniciando la acción por medio de una variable de disparador.
Durante la conexión / copia de ficheros se carga la CPU, ya que el servidor SQL se recarga
más al estar activado especialmente el control de firma. Durante la copia de los segmentos
de fichero se vuelve más lento el acceso al disco duro.
Cuando el control de firma está conectado se retornará un mensaje de error en el caso de
que se tenga que almacenar un fichero sin firma o un fichero que ha sido modificado. Siempre
se retornará un mensaje de error, incluso cuando se presenten varios errores durante un
proceso de almacenamiento. Adicionalmente se genera un mensaje de sistema WinCC para
cada segmento de fichero. En el indicador de eventos de Windows se añade una entrada bajo
el punto "Aplicación". De este modo se tiene la posibilidad de comprobar qué segmentos de
fichero producen el error.
● En el caso de un fichero sin signatura se retorna el valor "0x8004720F". En el indicador de
eventos se introduce la entrada "Validation of database <db_name> failed ! No signature
found !".
El fichero es almacenado.
● En el caso de un fichero modificado se retorna el valor "0x80047207". En el indicador de
eventos aparece la entrada "Validation of database <db_name> failed !.
El fichero no es almacenado.
Nota
La activación del método "Restore" se puede ejecutar actualmente sólo en el servidor. Sin
embargo existe un ejemplo que muestra cómo se puede iniciar el método en el cliente
desde el servidor.
Sintaxis
Expresión
Se necesita. Una expresión que retorna un objeto de tipo "Logging" o "AlarmLogs".
Objeto DataLogs
Expresión.Restore [SourcePath] [TimeFrom] [TimeTo] [TimeOut] [Type]
[ServerPrefix]
Expresión
Se necesita. Una expresión que retorna un objeto de tipo "DataLogs".
Parámetro
SourcePath
Ruta para los datos de fichero.
TimeFrom
Momento a partir del cual se deben almacenar los ficheros.
Al indicar el instante, es posible también una forma abreviada, como se describe en el apartado
"Formato de los datos de tiempo".
TimeTo
Momento hasta el que se deben almacenar los segmentos de fichero.
Al indicar el instante, es posible también una forma abreviada, como se describe en el apartado
"Formato de los datos de tiempo".
Timeout
Timeout en milisegundos.
Si introduce "-1" como valor, se esperará de manera infinita (infinite). Si introduce el valor "0",
no se esperará.
Tipos
Tipo de fichero.
Este parámetro se puede utilizar (opcional) únicamente para archivar segmentos de ficheros
de Tag Logging.
Pueden introducirse estos valores:
ServerPrefix
Reservado para versiones futuras.
Valor de retorno
Si se ha presentado un error durante el almacenamiento de los segmentos de fichero, el
método retorna un mensaje de error. Para más información consultar el tema "Avisos de fallos
del área de bases de datos".
significa que en la indicación de fecha/hora se pueden suprimir uno o varios parámetros que
comienzan con el valor de segundos. Según esto, la indicación podría realizarse, p. ej., en los
formatos "YYYY-MM" o "YYYY-MM-DD hh". Con la indicación "TimeFrom" = "2004-09" y
"TimeTo" = "2004-10-04" se almacenan todos los segmentos de fichero desde septiembre de
2004 hasta el 4 de octubre inclusive.
Ejemplo
En el siguiente ejemplo se almacenarán otra vez todos los segmentos de fichero a partir del
período indicado, y el valor de retorno será emitido como Trace.
'VBS184
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.Restore("D:\Folder","2004-09-14","",-1) &
vbNewLine
En el siguiente ejemplo se almacenarán otra vez todos los segmentos de fichero de Tag
Logging Slow del período indicado, y el valor de retorno será emitido como Trace.
'VBS185
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.DataLogs.Restore("D:\Folder","2004-09-14
12:30:05","2004-09-20 18:30",-1,2) & vbNewLine
En el siguiente ejemplo se almacenarán otra vez todos los segmentos de fichero de Alarm
Logging hasta el período indicado, y el valor de retorno será emitido como Trace.
'VBS186
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.AlarmLogs.Remove("","2004-09-20",-1) &
vbNewLine
Consulte también
Logging (Página 1318)
DataLogs (lista) (Página 1309)
AlarmLogs (lista) (Página 1306)
Descripción
Selecciona todas las filas en un control basado en tablas.
Sintaxis
Expresión.SelectAll()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
OnlineTableControl (Página 1434)
TrendRulerControl (Página 1508)
UserArchiveControl (Página 1528)
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Definir área estadística" del visor de tablas.
Sintaxis
Expresión.SelectedStatisticArea()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
OnlineTableControl (Página 1434)
Descripción
Selecciona una determinada fila en un control basado en tablas.
Sintaxis
Expresión.SelectRow(ByVal IRow As Long, Optional bExtendSelection As
Boolean)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
Parámetro Descripción
IRow Número de fila que se ha de seleccionar.
bExtendSelection Opción que especifica si se amplía la selección actual. Es relevante sólo si se
permite selección múltiple.
Ejemplo
● Actualmente está marcada la fila 1. Si se llama SelectRow( 2, True ), se marcarán las filas
1 y 2.
● Actualmente está marcada la fila 1. Si se llama SelectRow( 2, False ) o SelectRow( 2 ) sin
parámetros opcionales, se marca solo la fila 2.
Consulte también
OnlineTableControl (Página 1434)
TrendRulerControl (Página 1508)
UserArchiveControl (Página 1528)
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Exportar fichero" del visor de recetas.
Sintaxis
Expresión.ServerExport()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
UserArchiveControl (Página 1528)
Descripción
Ejecuta la función del botón "Importar fichero" del visor de recetas.
Sintaxis
Expresión.ServerImport()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
UserArchiveControl (Página 1528)
Descripción
Ejecuta la función del botón "Seleccionar columnas" del visor de tablas.
Sintaxis
Expresión.ShowColumnSelection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
OnlineTableControl (Página 1434)
Descripción
Ejecuta la función del botón "Diálogo de comentario" del visor de avisos.
Sintaxis
Expresión.ShowComment()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Diálogo de opciones de visualización" del visor de avisos.
Sintaxis
Expresión.ShowDisplayOptionsDialog()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Acuse de emergencia" del visor de avisos.
Sintaxis
Expresión.ShowEmergencyQuitDialog()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Ayuda" del control.
Sintaxis
Expresión.ShowHelp()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetros
VARIANT
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
TrendRulerControl (Página 1508)
UserArchiveControl (Página 1528)
Descripción
Ejecuta la función del botón "Lista de los avisos a ocultar" del visor de avisos.
Sintaxis
Expresión.ShowHideList()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Lista de aciertos" del visor de avisos.
Sintaxis
Expresión.ShowHitList()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Diálogo de texto informativo" del visor de avisos.
Sintaxis
Expresión.ShowInfoText()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Diálogo de bloqueos" del visor de avisos.
Sintaxis
Expresión.ShowLockDialog()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Lista de inhibiciones" del visor de avisos.
Sintaxis
Expresión.ShowLockList()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Lista de ficheros de largo plazo" del visor de avisos.
Sintaxis
Expresión.ShowLongTermArchiveList()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Lista de avisos" del visor de avisos.
Sintaxis
Expresión.ShowMessageList()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Eje relativo" del visor de curvas f(t).
Sintaxis
Expresión.ShowPercentageAxis()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
OnlineTrendControl (Página 1443)
Descripción
Ejecuta la función del botón "Diálogo de configuración" del control.
Sintaxis
Expresión.ShowPropertyDialog()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetros
VARIANT
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
TrendRulerControl (Página 1508)
UserArchiveControl (Página 1528)
FunctionTrendControl (Página 1397)
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Seleccionar conexión de datos" del visor de recetas.
Sintaxis
Expresión.ShowSelectArchive()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
UserArchiveControl (Página 1528)
Descripción
Ejecuta la función del botón "Diálogo de selección" del visor de recetas.
Sintaxis
Expresión.ShowSelection ()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
UserArchiveControl (Página 1528)
Descripción
Ejecuta la función del botón "Diálogo de selección" del visor de avisos.
Sintaxis
Expresión.ShowSelectionDialog()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Diálogo de base de tiempo" del visor de recetas.
Sintaxis
Expresión.ShowSelectTimeBase()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
UserArchiveControl (Página 1528)
Descripción
Ejecuta la función del botón "Lista de ficheros de corto plazo" del visor de avisos.
Sintaxis
Expresión.ShowShortTermArchiveList()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Diálogo de ordenación" del visor de recetas.
Sintaxis
Expresión.ShowSort()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
UserArchiveControl (Página 1528)
Descripción
Ejecuta la función del botón "Diálogo de ordenación" del visor de avisos.
Sintaxis
Expresión.ShowSortDialog()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Seleccionar conexión de datos" del control.
Sintaxis
Expresión.ShowTagSelection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetros
--
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
FunctionTrendControl (Página 1397)
Descripción
Ejecuta la función del botón "Diálogo de base de tiempo" del visor de avisos.
Sintaxis
Expresión.ShowTimebaseDialog()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Rango de tiempo Seleccionar" del control.
Sintaxis
Expresión.ShowTimeSelection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetros
--
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
FunctionTrendControl (Página 1397)
Descripción
Ejecuta la función del botón "Seleccionar curvas" de los visores de curvas f(t) y f(x).
Sintaxis
Expresión.ShowTrendSelection()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
-- -
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
FunctionTrendControl (Página 1397)
Descripción
Ejecuta la función del botón "Iniciar" o "Detener" del control.
Sintaxis
Expresión.StartStopUpdate()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetros
--
Consulte también
OnlineTrendControl (Página 1443)
OnlineTableControl (Página 1434)
FunctionTrendControl (Página 1397)
Descripción
Finaliza WinCC Runtime.
Sintaxis
Expression.Stop
Expression
Obligatorio. Expresión que devuelve un objeto del tipo "HMIRuntime".
Parámetro
--
Consulte también
HMIRuntime (Página 1313)
Descripción
Retorna un texto personalizado a través del canal del sistema operativo para avisos de
depuración.
El método HMIRuntime.Trace sólo funciona en el entorno basado en PC. El texto transferido
como parámetro puede visualizarse con las herramientas de diagnóstico "Diagnóstico de
GSC" o "ApDiag". Si se requiere un "trace" sin herramientas externas es posible utilizar la
función de sistema "MostrarAvisoDeSistema".
Sintaxis
Expression.Trace"STRING"
Expression
Obligatorio. Expresión que devuelve un objeto del tipo "HMIRuntime".
Parámetro
STRING
Texto que se emitirá como aviso de depuración. El texto transferido puede visualizarse con
las herramientas de diagnóstico "Diagnóstico de GSC" o "ApDiag". Si se requiere un "trace"
sin herramientas externas es posible utilizar la función de sistema "MostrarAvisoDeSistema".
Ejemplo
En el siguiente ejemplo se emite un aviso de depuración:
'VBS_Example_Trace
HMIRuntime.Trace "Customized error message"
Consulte también
HMIRuntime (Página 1313)
Descripción
Ejecuta la función del botón "Mostrar aviso" del visor de avisos.
Sintaxis
Expresión.UnhideAlarm()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Ejecuta la función del botón "Habilitar aviso" del visor de avisos.
Sintaxis
Expresión.UnlockAlarm()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
AlarmControl (Página 1338)
Descripción
Elimina todas las marcas de las celdas de un control basado en tablas.
Sintaxis
Expresión.UnselectAll()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
OnlineTableControl (Página 1434)
TrendRulerControl (Página 1508)
UserArchiveControl (Página 1528)
AlarmControl (Página 1338)
Descripción
Elimina las marcas de una determinada celda de un control basado en tablas.
Sintaxis
Expresión.UnselectRow(ByVal IRow As Long)
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
Long
Parámetro Descripción
IRow Número de fila que se ha de seleccionar.
Consulte también
OnlineTableControl (Página 1434)
TrendRulerControl (Página 1508)
UserArchiveControl (Página 1528)
AlarmControl (Página 1338)
Si se activa con éxito el valor de las variables, entonces las propiedades del objeto Tag serán
ocupadas con los siguientes valores:
Propiedad Ocupación
Value Valor de las variables definido por el usuario (no
modificado)
Name Nombre de variable (no modificado)
QualityCode Bad Out of Service
TimeStamp 0
LastError 0
ErrorDescription ""
Si no se activa con éxito el valor de las variables, entonces las propiedades del objeto Tag
serán ocupadas con los siguientes valores:
Propiedad Ocupación
Value Valor de las variables definido por el usuario (no
modificado)
Name Nombre de variable (no modificado)
QualityCode Bad Out of Service
TimeStamp 0
LastError Código de error de la operación de escritura
ErrorDescription Descripción del error de LastError
Sintaxis
Expresión.Write [Value],[Writemode]
Expresión
Obligatorio. Una expresión que devuelve un objeto Tags.
Parámetros
El valor que se va a escribir puede ser entregado como parámetro directamente al método.
Si el parámetro no se indica, se utilizará el valor de la propiedad "Value". Con el parámetro
opcional "Writemode" Ud. puede elegir si el valor de la variable se debe escribir sincrónica o
asincrónicamente. Si no se utiliza el parámetro "Writemode" se escribirá asincrónicamente
como valor Default.
Durante un proceso de escritura no se suministra ninguna información referente al estado de
las variables.
En la propiedad "Value" está el valor que se definió antes o durante la operación de escritura,
es decir, él no tiene entonces que corresponder al valor actual real de la variable. Si Ud. desea
actualizar las informaciones referentes a la variable, utilice el método Read.
Parámetros Descripción
Value (opcional) Se indica el valor de las variables. El valor indicado
sobrescribe el valor de la propiedad "Value" en un
objeto Tag.
No se indica el valor de las variables. La variable
recibe el valor actual de la propiedad "Value" del
objeto Tag.
Writemode (opcional) 0 o vacío: El valor de la variable se escribe asin‐
crónicamente. 0 es el valor Default.
1: El valor de la variable se escribe sincrónicamen‐
te.
Ejemplo
Escritura asincrónica
'VBS104
Dim objTag
Set objTag = HMIRuntime.Tags("Var1")
objTag.Value = 5
objTag.Write
MsgBox objTag.Value
'VBS105
Dim objTag
Set objTag = HMIRuntime.Tags("Var1")
objTag.Write 5
MsgBox objTag.Value
Escritura sincrónica
'VBS106
Dim objTag
Set objTag = HMIRuntime.Tags("Var1")
objTag.Value = 5
objTag.Write ,1
MsgBox objTag.Value
'VBS107
Dim objTag
Set objTag = HMIRuntime.Tags("Var1")
objTag.Write 5, 1
MsgBox objTag.Value
Expresión
Obligatorio. Una expresión que devuelve un objeto de tipo "TagSet".
Parámetros
Para escribir valores diferentes hay que definir la propiedad "Value" de cada uno de los objetos
Tag, y luego hay que ejecutar Write sin el parámetro "Value". La agrupación de órdenes de
escritura en una ejecución arroja un mejor rendimiento en comparación a las ejecuciones
individuales.
En un objeto TagSet no es posible asignar un valor con el método "Write". Cada uno de los
valores debe ser definido a través de la propiedad "Value" de cada objeto Tag.
Ejemplo
El siguiente ejemplo muestra cómo se agregan variables en la TagSet Collection, cómo se
definen los valores de variables, y cómo se escriben posteriormente.
'VBS173
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
group.Add "Valor1"
group.Add "Valor2"
group("Valor1").Value = 3
group("Valor2").Value = 9
group.Write
group.Write 1
Descripción
Ejecuta la función del botón "Escribir variables" del visor de recetas.
Sintaxis
Expresión.WriteTags()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
UserArchiveControl (Página 1528)
Descripción
Ejecuta la función del botón "Ampliar sección" de los visores de curvas f(t) y f(x).
Sintaxis
Expresión.ZoomArea()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Ejecuta la función del botón "Zoom +/-" de los visores de curvas f(t) y f(x).
Sintaxis
Expresión.ZoomInOut()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
OnlineTrendControl (Página 1443)
FunctionTrendControl (Página 1397)
Descripción
Ejecuta la función del botón "Zoom eje de tiempos +/-" del visor de curvas f(t).
Sintaxis
Expresión.ZoomInOutTime()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
OnlineTrendControl (Página 1443)
Descripción
Ejecuta la función del botón "Zoom eje de valores +/-" del visor de curvas f(t).
Sintaxis
Expresión.ZoomInOutValues()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
OnlineTrendControl (Página 1443)
Descripción
Ejecuta la función del botón "Zoom eje X +/-" del visor de curvas f(x).
Sintaxis
Expresión.ZoomInOutX()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Ejecuta la función del botón "Zoom eje Y +/-" del visor de curvas f(x).
Sintaxis
Expresión.ZoomInOutY()
Expresión
Obligatorio. Una expresión que devuelve un objeto del tipo "ScreenItem".
Parámetro
--
Consulte también
FunctionTrendControl (Página 1397)
Descripción
Ejecuta la función del botón "Desplazar área de curva" de los visores de curvas f(t) y f(x).
Sintaxis
Expresión.ZoomMove()
Expresión
Obligatorio. Una expresión que dev