FreeRTOS_CLIGetParameter()
FreeRTOS_CLI.h
const char *FreeRTOS_CLIGetParameter( const char *pcCommandString,
UBaseType_t uxWantedParameter,
BaseType_t *pxParameterStringLength )
FreeRTOS-Plus-CLI 是一个可扩展的框架,
应用程序编写者可以通过该框架定义并注册自己的命令行输入命令。 实现用户定义命令的行为的函数必须使用特定接口
,
如另一页面的描述所示。
有些命令需要参数。例如,文件系统的“复制”命令需要源文件的名称和目标
文件的名称
。此页面描述了名为 FreeRTOS_CLIGetParameter()
的辅助函数,
此函数由 FreeRTOS-Plus-CLI 提供,用于简化输入参数解析。
FreeRTOS_CLIGetParameter()
将完整的命令字符串和所请求参数的位置作为输入,
并生成指向所请求参数开始的指针和
以字节为单位的参数字符串长度
作为输出。
参数:
pcCommandString
|
指向由用户输入的整个命令字符串的指针
。
|
ucWantedParameter
|
所请求的参数在命令字符串中的位置
。 例如,
如果输入命令是 "copy [source_file] [destination_file]",
将 ucWantedParameter 设置为 1
可以请求 source_file 参数的名称和长度。 将 ucWantedParameter
设置为 2 可以请求 destination_file 参数的名称和长度
。
|
pucParameterStringLength
|
被请求的参数的字符串长度在
*pucParameterStringLength 中返回。 例如,
例如,如果参数文本是 "filename.txt",
那么 *pucParameterStringLength 将被设置为 12,
因为该字符串中有 12 个字符。
|
返回:
指向返回所请求的参数开头的指针。
例如,如果完整的命令字符串为“copy file1.txt file2.txt”,
且 ucWantedParameter
的值为 2,则 FreeRTOS_CLIGetParameter()
将返回指向“file2.txt”中的“f”的指针。
示例
有关示例,可参阅
实现命令
页面。
Copyright (C) Amazon Web Services, Inc. or its affiliates. All rights reserved.