.. _program_listing_file_include_rcl_validate_enclave_name.h:

Program Listing for File validate_enclave_name.h
================================================

|exhale_lsh| :ref:`Return to documentation for file <file_include_rcl_validate_enclave_name.h>` (``include/rcl/validate_enclave_name.h``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   // Copyright 2020 Open Source Robotics Foundation, Inc.
   //
   // Licensed under the Apache License, Version 2.0 (the "License");
   // you may not use this file except in compliance with the License.
   // You may obtain a copy of the License at
   //
   //     http://www.apache.org/licenses/LICENSE-2.0
   //
   // Unless required by applicable law or agreed to in writing, software
   // distributed under the License is distributed on an "AS IS" BASIS,
   // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   // See the License for the specific language governing permissions and
   // limitations under the License.
   
   
   #ifndef RCL__VALIDATE_ENCLAVE_NAME_H_
   #define RCL__VALIDATE_ENCLAVE_NAME_H_
   
   #ifdef __cplusplus
   extern "C"
   {
   #endif
   
   #include "rmw/validate_namespace.h"
   #include "rmw/validate_node_name.h"
   
   #include "rcl/macros.h"
   #include "rcl/types.h"
   #include "rcl/visibility_control.h"
   
   #define RCL_ENCLAVE_NAME_VALID RMW_NAMESPACE_VALID
   
   #define RCL_ENCLAVE_NAME_INVALID_IS_EMPTY_STRING RMW_NAMESPACE_INVALID_IS_EMPTY_STRING
   
   #define RCL_ENCLAVE_NAME_INVALID_NOT_ABSOLUTE RMW_NAMESPACE_INVALID_NOT_ABSOLUTE
   
   #define RCL_ENCLAVE_NAME_INVALID_ENDS_WITH_FORWARD_SLASH \
     RMW_NAMESPACE_INVALID_ENDS_WITH_FORWARD_SLASH
   
   #define RCL_ENCLAVE_NAME_INVALID_CONTAINS_UNALLOWED_CHARACTERS \
     RMW_NAMESPACE_INVALID_CONTAINS_UNALLOWED_CHARACTERS
   
   #define RCL_ENCLAVE_NAME_INVALID_CONTAINS_REPEATED_FORWARD_SLASH \
     RMW_NAMESPACE_INVALID_CONTAINS_REPEATED_FORWARD_SLASH
   
   #define RCL_ENCLAVE_NAME_INVALID_NAME_TOKEN_STARTS_WITH_NUMBER \
     RMW_NAMESPACE_INVALID_NAME_TOKEN_STARTS_WITH_NUMBER
   
   #define RCL_ENCLAVE_NAME_INVALID_TOO_LONG RMW_NAMESPACE_INVALID_TOO_LONG
   
   #define RCL_ENCLAVE_NAME_MAX_LENGTH RMW_NODE_NAME_MAX_NAME_LENGTH
   
   
   RCL_PUBLIC
   RCL_WARN_UNUSED
   rcl_ret_t
   rcl_validate_enclave_name(
     const char * enclave,
     int * validation_result,
     size_t * invalid_index);
   
   
   RCL_PUBLIC
   RCL_WARN_UNUSED
   rcl_ret_t
   rcl_validate_enclave_name_with_size(
     const char * enclave,
     size_t enclave_length,
     int * validation_result,
     size_t * invalid_index);
   
   
   RCL_PUBLIC
   RCL_WARN_UNUSED
   const char *
   rcl_enclave_name_validation_result_string(int validation_result);
   
   #ifdef __cplusplus
   }
   #endif
   
   #endif  // RCL__VALIDATE_ENCLAVE_NAME_H_