FreeRTOS_CLIProcessCommand()
FreeRTOS_CLI.h
BaseType_t FreeRTOS_CLIProcessCommand( char *pcCommandInput,
char *pcWriteBuffer,
size_t xWriteBufferLen );
FreeRTOS-Plus-CLI 是一个可扩展的框架,
应用程序编写者可以通过该框架定义并注册自己的命令行输入命令。 此框架提供了单独的
文档页面,描述了
如何编写函数
以实现用户定义命令这一行为,
如何使用 FreeRTOS-Plus-CLI 注册用户定义的命令,
以及如何实现 FreeRTOS-Plus-CLI 任务。
此页面描述了 FreeRTOS_CLIProcessCommand() 函数。
FreeRTOS_CLIProcessCommand() 是获取用户在命令提示符处输入的字符串的 API 函数,
如果字符串与注册的命令匹配,
则执行实现命令行为的函数。
参数:
pcCommandInput
|
完整的输入字符串,与用户在命令提示符(可能是
UART 控制台、键盘、Telnet 客户端或其他用户输入客户端)中输入的字符串完全相同。
|
pcWriteBuffer
|
如果 pcCommandInput 包含的命令格式
不正确,则 FreeRTOS_CLIProcessCommand() 将
向 pcWriteBuffer 缓冲区输出以 NULL 结尾的错误消息。
如果 pcCommandInput 包含的命令格式
正确,则 FreeRTOS_CLIProcessCommand() 将执行
实现命令行为的函数,
该函数会将其生成的输出
放入 pcWriteBuffer 缓冲区。
|
xWriteBufferLen
|
pcWriteBuffer 参数所指向的缓冲区大小
。向 pcWriteBuffer 写入超过 xWriteBufferLen 个字符
将导致缓冲区溢出。
|
返回:
FreeRTOS_CLIProcessCommand() 执行实现命令行为的函数,
并返回所执行函数的
返回值。 在
实施命令
页面上对这些值进行了描述。
示例
此函数的
FreeRTOS-Plus-CLI 任务实现
页面包含示例代码,其中包含如何使用 FreeRTOS_CLIProcessCommand() 的演示。
Copyright (C) Amazon Web Services, Inc. or its affiliates. All rights reserved.