Add 'exists' to win_stat return docs (#25146)
* Add 'exists' to win_stat return docs Fix 25107 by adding documentation for 'exists' return value in win_stat module * Added missing filename attribute to RETURN Also made the path and filename sample values consistent.pull/4420/head
parent
3e02b19b98
commit
de8c7c22d2
|
@ -130,11 +130,21 @@ stat:
|
||||||
returned: success, path exists
|
returned: success, path exists
|
||||||
type: float
|
type: float
|
||||||
sample: 1477984205.15
|
sample: 1477984205.15
|
||||||
|
exists:
|
||||||
|
description: if the path exists or not
|
||||||
|
returned: success
|
||||||
|
type: boolean
|
||||||
|
sample: True
|
||||||
extension:
|
extension:
|
||||||
description: the extension of the file at path
|
description: the extension of the file at path
|
||||||
returned: success, path exists, path is a file
|
returned: success, path exists, path is a file
|
||||||
type: string
|
type: string
|
||||||
sample: ".ps1"
|
sample: ".ps1"
|
||||||
|
filename:
|
||||||
|
description: the name of the file (without path)
|
||||||
|
returned: success, path exists, path is a file
|
||||||
|
type: string
|
||||||
|
sammple: foo.ini
|
||||||
isarchive:
|
isarchive:
|
||||||
description: if the path is ready for archiving or not
|
description: if the path is ready for archiving or not
|
||||||
returned: success, path exists
|
returned: success, path exists
|
||||||
|
@ -192,9 +202,9 @@ stat:
|
||||||
sample: BUILTIN\Administrators
|
sample: BUILTIN\Administrators
|
||||||
path:
|
path:
|
||||||
description: the full absolute path to the file
|
description: the full absolute path to the file
|
||||||
returned: success, path exists
|
returned: success, path exists, file exists
|
||||||
type: string
|
type: string
|
||||||
sample: BUILTIN\Administrators
|
sample: C:\foo.ini
|
||||||
sharename:
|
sharename:
|
||||||
description: the name of share if folder is shared
|
description: the name of share if folder is shared
|
||||||
returned: success, path exists, file is a directory and isshared == True
|
returned: success, path exists, file is a directory and isshared == True
|
||||||
|
|
Loading…
Reference in New Issue