User Tools


Differences

This shows you the differences between two versions of the page.

Link to this comparison view

cl:functions:logical-pathname [2019/06/15 02:00]
cl:functions:logical-pathname [2019/06/16 07:00] (current)
Line 1: Line 1:
 +====== Function LOGICAL-PATHNAME ======
 +
 +====Syntax====
 +  * **logical-pathname** //​pathspec//​ → //​logical-pathname//​
 +
 +====Arguments and Values====
 +  * //​pathspec//​ - a //​[[CL:​Glossary:​logical pathname]]//,​ a //​[[CL:​Glossary:​logical pathname]]//​ //​[[CL:​Glossary:​namestring]]//,​ or a //​[[CL:​Glossary:​stream]]//​.
 +  * //​logical-pathname//​ - a //​[[CL:​Glossary:​logical pathname]]//​.
 +
 +====Description====
 +**logical-pathname** converts //​pathspec//​ to a //​[[CL:​Glossary:​logical pathname]]//​ and returns the new //​[[CL:​Glossary:​logical pathname]]//​. If //​pathspec//​ is a //​[[CL:​Glossary:​logical pathname]]//​ //​[[CL:​Glossary:​namestring]]//,​ it should contain a host component and its following //​[[CL:​Glossary:​colon]]//​. If //​pathspec//​ is a //​[[CL:​Glossary:​stream]]//,​ it should be one for which **[[CL:​Functions:​pathname]]** returns a //​[[CL:​Glossary:​logical pathname]]//​.
 +
 +If //​pathspec//​ is a //​[[CL:​Glossary:​stream]]//,​ the //​[[CL:​Glossary:​stream]]//​ can be either open or closed. **logical-pathname** returns the same //​[[CL:​Glossary:​logical pathname]]//​ after a file is closed as it did when the file was open.
 +
 +It is an error if //​pathspec//​ is a //​[[CL:​Glossary:​stream]]//​ that is created with **[[CL:​Functions:​make-two-way-stream]]**,​ **[[CL:​Functions:​make-echo-stream]]**,​ **[[CL:​Functions:​make-broadcast-stream]]**,​ **[[CL:​Functions:​make-concatenated-stream]]**,​ **[[CL:​Functions:​make-string-input-stream]]**,​ or **[[CL:​Functions:​make-string-output-stream]]**.
 +
 +====Examples====
 +None.
 +
 +====Affected By====
 +None.
 +
 +====Exceptional Situations====
 +Signals an error of type **[[CL:​Types:​type-error]]** if //​pathspec//​ isn't supplied correctly.
 +
 +====See Also====
 +  * **[[CL:​Types:​logical-pathname|System Class LOGICAL-PATHNAME]]**
 +  * **[[CL:​Functions:​translate-logical-pathname|Function TRANSLATE-LOGICAL-PATHNAME]]**
 +  * {\secref\LogicalPathnames}
 +
 +====Notes====
 +None.
 +
 +\issue{PATHNAME-LOGICAL:​ADD} \issue{CLOSED-STREAM-FUNCTIONS:​ALLOW-INQUIRY} \issue{PATHNAME-STREAM}