UserMgrUserGetFirst (FUN) ¶ FUNCTION UserMgrUserGetFirst : RTS_IEC_RESULT Iteration interface to get the first user InOut: Scope Name Type Comment Return UserMgrUserGetFirst RTS_IEC_RESULT Error code ERR_OK: First user available ERR_NO_OBJECT: No user configured ERR_NO_ACCESS_RIGHTS: User not authorized Input hUser RTS_IEC_HANDLE Handle to authorized user Inout phIterator RTS_IEC_HANDLE Iteration handle to use with UserMgrUserGetNext() pszUsername STRING(59) Buffer to store the name, 59 chars max Output UserProperty DWORD User properties. See category ‘User and group properites’
UserMgrUserGetInfoOfUser (FUN) ¶ FUNCTION UserMgrUserGetInfoOfUser : DWORD Retrieves the value cached using UserMgrAddInfoToUser. InOut: Scope Name Type Comment Return UserMgrUserGetInfoOfUser DWORD ERR_OK: Retrieving cache value successful; ERR_PARAMETER: Some parameter is invalid; ERR_NO_OBJECT: No cache value with this key available. Input hUser RTS_IEC_HANDLE Handle to authorized user key __XWORD Key of the cache value. Output value UserMgrCacheValue Value from the cache
UserMgrUserGetName (FUN) ¶ FUNCTION UserMgrUserGetName : RTS_IEC_RESULT Get user name from a user handle InOut: Scope Name Type Comment Return UserMgrUserGetName RTS_IEC_RESULT Error code ERR_OK: User name copied ERR_INVALID_HANDLE: hUser not a valid user handle. Input hUser RTS_IEC_HANDLE Handle to authorized user Inout pszUsername STRING(59) Buffer to store the name, 59 chars max
UserMgrUserGetNext (FUN) ¶ FUNCTION UserMgrUserGetNext : RTS_IEC_RESULT Iteration interface to get next user. Must be started with UserMgrUserGetFirst() InOut: Scope Name Type Comment Return UserMgrUserGetNext RTS_IEC_RESULT Error code ERR_OK: Next user available ERR_NO_OBJECT: No next user available ERR_PARAMETER: Invalid iterator handle ERR_NO_ACCESS_RIGHTS: User not authorized Input hUser RTS_IEC_HANDLE Handle to authorized user Inout phIterator RTS_IEC_HANDLE Iteration handle to use with next call to UserMgrUserGetNext() pszUsername STRING(59) Buffer to store the name, 59 chars max Output UserProperty DWORD User properties. See category ‘User and group properites’
UserMgrUserGetProperty (FUN) ¶ FUNCTION UserMgrUserGetProperty : DWORD Get properties of a user InOut: Scope Name Type Comment Return UserMgrUserGetProperty DWORD The users properties. See category ‘User and group properites’ Input hUser RTS_IEC_HANDLE Handle to authorized user Inout Const pszUser STRING User name, limited to 59 chars Output Result RTS_IEC_RESULT Error code ERR_OK: Properties could be retrieved ERR_NO_ACCESS_RIGHTS: User not authorized
UserMgrUserRemove (FUN) ¶ FUNCTION UserMgrUserRemove : RTS_IEC_RESULT Remove user from the user database InOut: Scope Name Type Comment Return UserMgrUserRemove RTS_IEC_RESULT Error code ERR_OK: User could be removed ERR_PARAMETER: Invalid parameter. pszUser empty ERR_NO_ACCESS_RIGHTS: User not authorized Input hUser RTS_IEC_HANDLE Handle to authorized user Inout Const pszUser STRING User name, limited to 59 chars
X509CertStoreOpen (FUN) ¶ FUNCTION X509CertStoreOpen : RTS_IEC_HANDLE Open the certificate store. InOut: Scope Name Type Comment Return X509CertStoreOpen RTS_IEC_HANDLE Handle to the certificate store Input componentID UDINT ID of the component opening the certificate store. pResult POINTER TO RTS_IEC_RESULT Result of the operation.
X509CertStoreRegister (FUN) ¶ FUNCTION X509CertStoreRegister : RTS_IEC_HANDLE Register your certificate at the certificate store. This has to be done in order to allow the user the view the different configured certificates and to generate missing certificates or to renew outdated certificates. Register the same information you are using in the X509CertStoreSearch function. InOut: Scope Name Type Comment Return X509CertStoreRegister RTS_IEC_HANDLE Input hCertStore RTS_IEC_HANDLE Handle of to certificate store. cmpID UDINT Component ID which registered the certificate pCertInfo POINTER TO RtsX509CertInfo Certificate information to be registered. Should match the information needed to use the Search function. pResult POINTER TO RTS_IEC_RESULT Pointer to error code
X509CertStoreRemoveCert (FUN) ¶ FUNCTION X509CertStoreRemoveCert : RTS_IEC_RESULT Remove the certificate from the store. InOut: Scope Name Type Comment Return X509CertStoreRemoveCert RTS_IEC_RESULT Input hCertStore RTS_IEC_HANDLE Handle of to certificate store. hBackend RTS_IEC_HANDLE Handle to the back-end where to store the generated certificate. RTS_INVALID_HANDLE should be used if no back- end is specified. hCert RTS_IEC_HANDLE Handle of the certificate to remove. xRemovePrivateKey BOOL Select if the private key of the certificate should be deleted too. If the certificate is renewed the same private key the key shouldn’t be deleted.
X509CertStoreSearchGetFirst (FUN) ¶ FUNCTION X509CertStoreSearchGetFirst : RTS_IEC_HANDLE Search for the given certificate in the cert store. InOut: Scope Name Type Comment Return X509CertStoreSearchGetFirst RTS_IEC_HANDLE Handle to the first certificate matching the filter criteria. Input hCertStore RTS_IEC_HANDLE Handle of to certificate store. pFilters POINTER TO RtsX509CertFilter Pointer to array of filters to be applied. ui32NumOfFilters UDINT Number of applied filters. pResult POINTER TO RTS_IEC_RESULT