IO | C4D R23.110 C++ SDK - 中文文档编制,帮助,手册,教程

详细描述

Namespaces
	maxon::ReadArchiveClasses
	maxon::WriteArchiveClasses
	maxon::URLFLAGS
	maxon::STREAMFLAGS
	maxon::StringEncodings
	maxon::StringDecodings
	maxon::StreamConversions

Classes
class	ReadArchiveInterface
class	WriteArchiveInterface
class	IoBrowseInterface
class	ResolveInterface
class	IoConnectionInterface
class	IoHandlerInterface
class	IoMemoryInterface
class	IoDualInOutputStreamInterface
class	IoPipeInOutputStreamInterface
class	UrlOrStream< STREAM >
class	IoErrorInterface
class	FileFormatErrorInterface
class	UnknownFileSizeErrorInterface
class	BaseStreamInterface
class	InputStreamInterface
class	OutputStreamInterface
class	InOutputStreamInterface
class	LexerInterface
class	StringEncodingInterface
class	StringDecodingInterface
class	UrlInterface
class	Url
class	IoFileOutputHelper
class	IoFileInputHelper
class	IoXmlNodeInterface
class	IoXmlParser
class	SourceControlChangeEntry
class	SourceControlInterface
class	SmtpErrorInterface
struct	SmtpReceiver
class	SmtpMailInterface

Macros
#define	REGISTER_STRINGENCODING ( EXTENSION , CATEGORY, IDSYM, IMPLCLASS)
#define	REGISTER_STRINGENCODING_TEMPLATE ( EXTENSION , CATEGORY, IDSYM, IMPLCLASS)
#define	MAXON_DECLARATION_STRINGENCODING (IDSTR, IDSYM)
#define	MM_MediaText
#define	MM_MediaImage
#define	MM_MediaAudio
#define	MM_MediaVideo
#define	MM_MediaApplication
#define	MM_MediaMultiPart
#define	MM_MediaMessage
#define	MM_SubHtml
#define	MM_SubPlain
#define	MM_SubRtf
#define	MM_SubBinhex
#define	MM_SubStuffit
#define	MM_SubZip
#define	MM_SubOctet
#define	MM_SubPS
#define	MM_SubPdf
#define	MM_SubGif
#define	MM_SubJpeg
#define	MM_SubPng
#define	MM_SubTiff
#define	MM_SubMpeg
#define	MM_SubMov
#define	MM_SubAVI
#define	MM_EncodingBase64

Typedefs
using	ExtractCallback = Delegate < Result < Bool >(const String &inputName, Url &outputName, IOATTRIBUTES &fileAttributes)>
using	PIPEHANDLE = int
using	UrlOrInputStream = UrlOrStream < InputStreamRef >
using	UrlOrOutputStream = UrlOrStream < OutputStreamRef >
using	UrlScheme = Id
using	SCConversionFunction = Delegate < Result < 数据 >(const CString &val)>
using	SCTypeConversion = HashMap < CString , SCConversionFunction >

Enumerations
enum	IOARCHIVESTOREMETHOD { STORE , DEFLATE }
enum	IOARCHIVEEXTRACTFLAGS { NONE , OVERWRITE_EXISTING_FILE }
enum	IOBROWSEFLAGS { NONE , IS_DIRECTORY , IS_BUNDLE , IS_READONLY , IS_HIDDEN , SUPPORT_REVISIONS , IS_LINK , IS_ENCRYPTED , IS_DELETED , IS_INVISIBLE }
enum	LEXERSYMBOL : UChar { NONE , ILLEGAL , ENDOFFILE , IDENTIFIER , STRING , STRINGCHR , NUMBER , NEWLINE , CURLYBRACKET_OPEN , CURLYBRACKET_CLOSE , PARENTHESE_OPEN , PARENTHESE_CLOSE , SQUAREBRACKET_OPEN , SQUAREBRACKET_CLOSE , SLASH , EQUAL , COMMA , SEMICOLON , COLON , PLUS , TILDE , PREPROCESSOR , MULTIPLY , PIPE , AMPERSAND , OPERATOR }
enum	LEXERSYMBOLFLAGS { NONE , NO_NUMBER , ALLOWSTRINGS , MINUS_OPERATOR }
enum	LEXERINITFLAGS { NONE , NEED_EOL , REWIND_WHEN_DONE , ALLOW_DOLLAR_IDENT , ALLOW_AT_IDENT , NON_ASCII_IS_IDENT , HASH_COMMENTS , ESCAPE_IN_SINGLE_QUOTED , C_ESCAPE_SEQUENCES , SPACESCOMPATIBILITY , C4DSTRCOMPATIBILITY }
enum	GETBROWSEITERATORFLAGS { NONE , NOERRORONOPEN , RESOLVEPATHS }
enum	MEDIA { UNKNOWN , TEXT , IMAGE , AUDIO , VIDEO , APP , MULTI }
enum	MEDIASUB { UNKNOWN , HTML , HTML_PLAIN , GIF , JPEG , PNG , TIFF , MPEG , QUICKTIME , X_MSVIDEO , RTF , MAC_BINHEX40 , X_STUFFIT , ZIP , OCTET_STREAM , POSTSCRIPT , PDF }
enum	SMTPRECEIVERFIELD : UChar { TO , CC , BCC }

函数
enum maxon::IOARCHIVESTOREMETHOD	MAXON_ENUM_LIST ( IOARCHIVESTOREMETHOD )
enum maxon::IOARCHIVEEXTRACTFLAGS	MAXON_ENUM_FLAGS ( IOARCHIVEEXTRACTFLAGS )
	MAXON_REGISTRY ( Class < ReadArchiveRef >, ReadArchiveClasses, "net.maxon.registry.readarchiveclasses")
	MAXON_REGISTRY ( Class < WriteArchiveRef >, WriteArchiveClasses, "net.maxon.registry.writearchiveclasses")
enum maxon::IOBROWSEFLAGS	MAXON_ENUM_FLAGS ( IOBROWSEFLAGS , "net.maxon.datatype.enum.iobrowseflags")
	MAXON_DECLARATION ( Class < IoBrowseRef >, IoBrowseBaseClass, "net.maxon.class.iobrowsebase")
	MAXON_DECLARATION ( Class < IoConnectionRef >, IoConnectionBaseClass, "net.maxon.class.ioconnectionbase")
	MAXON_DECLARATION ( Class < IoConnectionRef >, IoConnectionFileClass, "net.maxon.class.ioconnectionfile")
	MAXON_REGISTRY (IoHandler, IoHandlers, "net.maxon.registry.iohandlers")
	MAXON_DECLARATION ( Class < IoHandler >, IoHandlerObjectBaseClass, "net.maxon.class.iohandlerobjectbase")
	MAXON_DECLARATION ( Class < IoHandler >, IoHandlerObjectFileClass, "net.maxon.class.iohandlerobjectfile")
	MAXON_DECLARATION ( Class < IoDualInOutputStreamRef >, InOutputStreamDualClass, "net.maxon.class.inoutputstreamdual")
	MAXON_DECLARATION ( Class < IoError >, IoErrorObjectClass, "net.maxon.class.ioerrorobject")
	MAXON_DECLARATION ( Class < InputStreamRef >, InputStreamBaseClass, "net.maxon.class.inputstreambase")
	MAXON_DECLARATION ( Class < OutputStreamRef >, OutputStreamBaseClass, "net.maxon.class.outputstreambase")
	MAXON_DECLARATION ( Class < InOutputStreamRef >, InOutputStreamBaseClass, "net.maxon.class.inoutputstreambase")
	MAXON_DECLARATION ( Class < InputStreamRef >, InputStreamDecoratorBaseClass, "net.maxon.class.inputstreamdecorator")
	MAXON_DECLARATION ( Class < OutputStreamRef >, OutputStreamDecoratorBaseClass, "net.maxon.class.outputstreamdecorator")
	MAXON_DECLARATION ( Class < InOutputStreamRef >, InOutputStreamDecoratorBaseClass, "net.maxon.class.inoutputstreamdecorator")
Result < Int >	Int64ToInt ( Int64 value)
enum maxon::LEXERSYMBOL UChar	MAXON_ENUM_LIST ( LEXERSYMBOL )
enum maxon::LEXERSYMBOLFLAGS	MAXON_ENUM_FLAGS ( LEXERSYMBOLFLAGS )
enum maxon::LEXERINITFLAGS	MAXON_ENUM_FLAGS ( LEXERINITFLAGS )
	MAXON_REGISTRY (StringEncodingRef, StringEncodings, "net.maxon.registry.stringencodings")
	MAXON_REGISTRY (StringDecodingRef, StringDecodings, "net.maxon.registry.stringdecodings")
enum maxon::GETBROWSEITERATORFLAGS	MAXON_ENUM_FLAGS ( GETBROWSEITERATORFLAGS )
	MAXON_DATATYPE ( SourceControlChangeEntry , "net.maxon.sourcecontrolchangeentry")
enum maxon::MEDIA	MAXON_ENUM_LIST ( MEDIA )
enum maxon::MEDIASUB	MAXON_ENUM_LIST ( MEDIASUB )
enum maxon::SMTPRECEIVERFIELD UChar	MAXON_ENUM_LIST ( SMTPRECEIVERFIELD )
MAXON_FUNCTION Result < Url >	operator+ (const String &s) const
MAXON_FUNCTION Result < Url >	operator+ (const Url &s) const

变量
static const Id	URLSCHEME_HANDLER
static const Id	URLSCHEME_FILESYSTEM
static const Id	URLSCHEME_AUTHORITY
static const Id	URLSCHEME_RELATIVE
static const Id	URLSCHEME_VOLUME
static const Id	URLSCHEME_NETWORK
static const Id	URLSCHEME_STORAGE
static const Id	URLSCHEME_ZIPFILE
static const Id	URLSCHEME_GZIPFILE
static const Id	URLSCHEME_MEMORY
static const Id	URLSCHEME_TCP
static const Id	URLSCHEME_WS
static const Id	URLSCHEME_WSS
static const Id	URLSCHEME_HTTP
static const Id	URLSCHEME_HTTPS
static const Id	URLSCHEME_FTP
static const Id	URLSCHEME_SFTP
static const Id	URLSCHEME_PERFORCE
static const Id	URLSCHEME_CRYPTOFILE
static const Id	URLSCHEME_CACHE
static const Id	URLSCHEME_PIPE
static const Id	URLSCHEME_STDOUT
static const Id	URLSCHEME_STDERR
static const Id	URLSCHEME_STDIN
static const Id	URLSCHEME_APK_ASSET

Macro Definition Documentation

◆ REGISTER_STRINGENCODING

#define REGISTER_STRINGENCODING	(	EXTENSION ,
		CATEGORY,
		IDSYM,
		IMPLCLASS
	)

This Macro can be used to register an implementation of a stream en-/decoder.

参数

[in]	EXTENSION	Registry to extend. (e.g. StringEncodings or StringDecodings).
[in]	CATEGORY	Encoder or Decoder.
[in]	IDSTR	Lowercase string with the id to be registered. e.g. "utf8".
[in]	IDSYM	Mixed case id with the id to be registered. e.g. Utf8.
[in]	IMPLCLASS	Implementation class name.

Enumerator
STORE	Simply store the file without compression.
DEFLATE	Deflates the file in the archive.

Enumerator
NONE	No flags.
OVERWRITE_EXISTING_FILE	Overwrites the file silently if it already exists in the directory.

Enumerator
NONE	No bit set.
IS_DIRECTORY	Browsed file is a directory.
IS_BUNDLE	Browsed file is a bundle (osx/ios).
IS_READONLY	Browsed file is read only.
IS_HIDDEN	Browsed file is hidden.
SUPPORT_REVISIONS	Browsed file supports file revisions. This means requesting a browseiterator allows to browse through all revisions of the file.
IS_LINK	Browsed file is a link.
IS_ENCRYPTED	Browsed file is encrypted within an archive.
IS_DELETED	Browsed file is deleted. E.g. when browsing a perforce depot with deleted files.
IS_INVISIBLE	Browsed file should be treated as invisible for the app; this is set for any file that starts with '.' under OSX/Linux or '._' under Windows. Under Windows files can be invisible, but not hidden.

Enumerator
NONE	No flags specified.
NOERRORONOPEN	Will return no error when opening a non existing directory but will return an empty browse handler with no entries.
RESOLVEPATHS	TODO: (Sebastian) please add documentation on this.

Enumerator
UNKNOWN	unknown media
TEXT	mediatype text
IMAGE	mediatype image
AUDIO	mediatype audio
VIDEO	mediatype video
APP	mediatype application
MULTI	mediatype multipart

#define REGISTER_STRINGENCODING_TEMPLATE	(	EXTENSION ,
		CATEGORY,
		IDSYM,
		IMPLCLASS
	)

Enumerator
NONE
ILLEGAL
ENDOFFILE	The end of file or stream was reached.
IDENTIFIER	An arbitrary symbol that is neither a string, nor a value. It may contain unicode characters.
STRING	A double-quoted string.
STRINGCHR	A single-quoted string.
NUMBER	A numerical value.
NEWLINE	'\r', '\n' or a combination of both.
CURLYBRACKET_OPEN	'{' symbol.
CURLYBRACKET_CLOSE	'}' symbol.
PARENTHESE_OPEN	'(' symbol.
PARENTHESE_CLOSE	')' symbol.
SQUAREBRACKET_OPEN	'[' symbol.
SQUAREBRACKET_CLOSE	']' symbol.
SLASH	'/' symbol.
EQUAL	'=' symbol.
COMMA	',' symbol.
SEMICOLON	';' symbol.
COLON	':' symbol.
PLUS	'+' symbol.
TILDE	'~' symbol.
PREPROCESSOR	'#' symbol.
MULTIPLY	'*' symbol.
PIPE	'\|' symbol.
AMPERSAND	'&' symbol.
OPERATOR	One of the operator symbols added by LexerInterface::AddOperator .

Enumerator
NONE
NO_NUMBER	If set, numbers (and characters as '.' or '-') are not recognized as numbers. Instead either an LEXERSYMBOL::IDENTIFIER or LEXERSYMBOL::ILLEGAL will be generated (and GetIdent() returns the symbol).
ALLOWSTRINGS	If set, strings starting with " or ' will be detected and LEXERSYMBOL::STRING is returned. GetIdent() returns the content of the string.
MINUS_OPERATOR	If set, the minus symbol in front of a number will be reported as own token.

Enumerator
NONE
NEED_EOL	The lexer stops at each end of line and returns LEXERSYMBOL::OPERATOR_NEWLINE whenever a newline appears.
REWIND_WHEN_DONE	The lexer will rewind the stream to the last interpreted character when it is done. Only set this if you want to continue scanning the open stream. It will only work if the stream supports seeking. Also a string decoding that has an exact counterpart (e.g. StringEncodings::Utf8) needs to be passed to the lexer.
ALLOW_DOLLAR_IDENT	Allow $ as part of identifiers.
ALLOW_AT_IDENT	Allow @ as part of identifiers (but not as start).
NON_ASCII_IS_IDENT	If set, non-ASCII characters (code > 127) are considered to be part of identifiers.
HASH_COMMENTS	If set, comments are introduced by the hash character (instead of C++-like comments).
ESCAPE_IN_SINGLE_QUOTED	If set, escape characters are also considered in single-quoted-strings.
C_ESCAPE_SEQUENCES	If set, a subset of C escape sequences is recognized in strings (\n, \t and \r).
SPACESCOMPATIBILITY	If set, a newline character will be included in the result of LexerInterface::GetLeadingSpaces.
C4DSTRCOMPATIBILITY	If set, the lexer will handle the escape character in a special manner. Then the escape character works only for the following character if it matches ".

Enumerator
UNKNOWN
HTML
HTML_PLAIN
GIF
JPEG
PNG
TIFF
MPEG
QUICKTIME
X_MSVIDEO
RTF
MAC_BINHEX40
X_STUFFIT
ZIP
OCTET_STREAM
POSTSCRIPT
PDF

maxon::MAXON_REGISTRY	(	Class < ReadArchiveRef >	,
		ReadArchiveClasses	,
		"net.maxon.registry.readarchiveclasses"
	)

maxon::MAXON_REGISTRY	(	Class < WriteArchiveRef >	,
		WriteArchiveClasses	,
		"net.maxon.registry.writearchiveclasses"
	)

enum maxon::IOBROWSEFLAGS maxon::MAXON_ENUM_FLAGS	(	IOBROWSEFLAGS	,
		"net.maxon.datatype.enum.iobrowseflags"
	)

maxon::MAXON_DECLARATION	(	Class < IoBrowseRef >	,
		IoBrowseBaseClass	,
		"net.maxon.class.iobrowsebase"
	)

maxon::MAXON_DECLARATION	(	Class < IoConnectionRef >	,
		IoConnectionBaseClass	,
		"net.maxon.class.ioconnectionbase"
	)

maxon::MAXON_DECLARATION	(	Class < IoConnectionRef >	,
		IoConnectionFileClass	,
		"net.maxon.class.ioconnectionfile"
	)

maxon::MAXON_REGISTRY	(	IoHandler	,
		IoHandlers	,
		"net.maxon.registry.iohandlers"
	)

maxon::MAXON_DECLARATION	(	Class < IoHandler >	,
		IoHandlerObjectBaseClass	,
		"net.maxon.class.iohandlerobjectbase"
	)

maxon::MAXON_DECLARATION	(	Class < IoHandler >	,
		IoHandlerObjectFileClass	,
		"net.maxon.class.iohandlerobjectfile"
	)

maxon::MAXON_DECLARATION	(	Class < IoDualInOutputStreamRef >	,
		InOutputStreamDualClass	,
		"net.maxon.class.inoutputstreamdual"
	)

maxon::MAXON_DECLARATION	(	Class < IoError >	,
		IoErrorObjectClass	,
		"net.maxon.class.ioerrorobject"
	)

maxon::MAXON_DECLARATION	(	Class < InputStreamRef >	,
		InputStreamBaseClass	,
		"net.maxon.class.inputstreambase"
	)

maxon::MAXON_DECLARATION	(	Class < OutputStreamRef >	,
		OutputStreamBaseClass	,
		"net.maxon.class.outputstreambase"
	)

maxon::MAXON_DECLARATION	(	Class < InOutputStreamRef >	,
		InOutputStreamBaseClass	,
		"net.maxon.class.inoutputstreambase"
	)

maxon::MAXON_DECLARATION	(	Class < InputStreamRef >	,
		InputStreamDecoratorBaseClass	,
		"net.maxon.class.inputstreamdecorator"
	)

详细描述

Namespaces

Classes

Macros

Typedefs

Enumerations

函数

变量

Macro Definition Documentation

◆ REGISTER_STRINGENCODING

◆ REGISTER_STRINGENCODING_TEMPLATE

◆ MAXON_DECLARATION_STRINGENCODING

◆ MM_MediaText

◆ MM_MediaImage

◆ MM_MediaAudio

◆ MM_MediaVideo

◆ MM_MediaApplication

◆ MM_MediaMultiPart

◆ MM_MediaMessage

◆ MM_SubHtml

◆ MM_SubPlain

◆ MM_SubRtf

◆ MM_SubBinhex

◆ MM_SubStuffit

◆ MM_SubZip

◆ MM_SubOctet

◆ MM_SubPS

◆ MM_SubPdf

◆ MM_SubGif

◆ MM_SubJpeg

◆ MM_SubPng

◆ MM_SubTiff

◆ MM_SubMpeg

◆ MM_SubMov

◆ MM_SubAVI

◆ MM_EncodingBase64

Typedef Documentation

◆ ExtractCallback

◆ PIPEHANDLE

◆ UrlOrInputStream

◆ UrlOrOutputStream

◆ UrlScheme

◆ SCConversionFunction

◆ SCTypeConversion

Enumeration Type Documentation

◆ IOARCHIVESTOREMETHOD

◆ IOARCHIVEEXTRACTFLAGS

◆ IOBROWSEFLAGS

◆ LEXERSYMBOL

◆ LEXERSYMBOLFLAGS

◆ LEXERINITFLAGS

◆ GETBROWSEITERATORFLAGS

◆ MEDIA

◆ MEDIASUB

◆ SMTPRECEIVERFIELD

Function Documentation

◆ MAXON_ENUM_LIST() [1/5]

◆ MAXON_ENUM_FLAGS() [1/5]

◆ MAXON_REGISTRY() [1/5]

◆ MAXON_REGISTRY() [2/5]

◆ MAXON_ENUM_FLAGS() [2/5]

◆ MAXON_DECLARATION() [1/13]

◆ MAXON_DECLARATION() [2/13]

◆ MAXON_DECLARATION() [3/13]

◆ MAXON_REGISTRY() [3/5]

◆ MAXON_DECLARATION() [4/13]

◆ MAXON_DECLARATION() [5/13]

◆ MAXON_DECLARATION() [6/13]

◆ MAXON_DECLARATION() [7/13]

◆ MAXON_DECLARATION() [8/13]

◆ MAXON_DECLARATION() [9/13]

◆ MAXON_DECLARATION() [10/13]

◆ MAXON_DECLARATION() [11/13]

◆ MAXON_DECLARATION() [12/13]

◆ MAXON_DECLARATION() [13/13]

◆ Int64ToInt()

◆ MAXON_ENUM_LIST() [2/5]

◆ MAXON_ENUM_FLAGS() [3/5]

◆ MAXON_ENUM_FLAGS() [4/5]

◆ MAXON_REGISTRY() [4/5]

maxon::MAXON_DECLARATION	(	Class < OutputStreamRef >	,
		OutputStreamDecoratorBaseClass	,
		"net.maxon.class.outputstreamdecorator"
	)

maxon::MAXON_DECLARATION	(	Class < InOutputStreamRef >	,
		InOutputStreamDecoratorBaseClass	,
		"net.maxon.class.inoutputstreamdecorator"
	)

maxon::MAXON_REGISTRY	(	StringEncodingRef	,
		StringEncodings	,
		"net.maxon.registry.stringencodings"
	)

maxon::MAXON_REGISTRY	(	StringDecodingRef	,
		StringDecodings	,
		"net.maxon.registry.stringdecodings"
	)

maxon::MAXON_DATATYPE	(	SourceControlChangeEntry	,
		"net.maxon.sourcecontrolchangeentry"
	)