Calls the given closure with a pointer to the contents of the string, represented as a null-terminated sequence of code units.
Required.
SDK
- Xcode 9.0+
Framework
- Swift Standard Library
Declaration
func withCString<Result, Encoding>(encodedAs targetEncoding: Encoding.Type, _ body: (UnsafePointer <Encoding.CodeUnit>) throws -> Result) rethrows -> Result where Encoding : _UnicodeEncoding
Parameters
bodyA closure with a pointer parameter that points to a null-terminated sequence of code units. If
bodyhas a return value, that value is also used as the return value for thewithmethod. The pointer argument is valid only for the duration of the method’s execution.CString(encoded As: _:) targetEncodingThe encoding in which the code units should be interpreted.
Return Value
The return value, if any, of the body closure parameter.
Discussion
The pointer passed as an argument to body is valid only during the execution of with. Do not store or return the pointer for later use.