IOPCGroupStateMgt::GetState
Previous  Top  Next

HRESULT GetState(  
   [out] DWORD * pUpdateRate,  
   [out] BOOL * pActive,  
   [out, string] LPWSTR * ppName,  
   [out] LONG * pTimeBias,  
   [out] FLOAT * pPercentDeadband,  
   [out] DWORD * pLCID,  
   [out] OPCHANDLE * phClientGroup,  
   [out] OPCHANDLE * phServerGroup  
   );  
 
Descrizione
Restituisce lo stato corrente di un gruppo.

Parametri
Descrizione
pUpdateRate
L'update rate corrente espressa in millisecondi.
pActive
Il corrente stato attivo del gruppo.
ppName
Il nome corrente del gruppo.
pTimeBias
La TimeZone del gruppo (in minuti)
pPercentDeadband
Il cambiamento percentuale nel valore di un item che potrebbe causare un exception report di quel valore ad un client. Questo parametro si applica agli item nei gruppi che hanno un dwEUType Analog.
pLCID
Il corrente LCID per il gruppo.
phClientGroup
Il group handle del client passato
phServerGroup
Il group handle del server generato


Codici Restituiti

Codici Restituiti
Descrizione
E_FAIL
L'operazione è fallita.
E_OUTOFMEMORY
Memoria insufficiente.
E_INVALIDARG
Un argomento della funzione era non valido.
S_OK
L'operazione ha avuto successo.


Commenti
Questa funzione è chiamata tipicamente per ottenere il valore corrente delle informazioni settate chiamando la funzione SetState. Queste informazioni vengono restituite al client quando il gruppo viene creato. Questa funzione viene anche usata per il debugging.
Tutti gli argomenti d'uscita devono essere puntatori validi. Il meccanismo di ordinamento richiede puntatori validi per un funzionamento appropriato. Un puntatore nullo genererà un RPC exception.
Il client deve liberare la stringa ppName ritornata.