Up: GEOS SDK TechDocs | Up | Prev: TokenDefineToken() ... | Next: TokenLoadTokenChunk() ...

TokenLoadMonikerBuffer()

Boolean	TokenLoadMonikerBuffer(
        dword		tokenChars,					/* four characters of token */
        ManufacturerID		manufacturerID,					/* manufacturer ID of token */
        DisplayType		displayType,					/* type of display for token */
        VisMonikerSearchFlags searchFlags,							/* flags for finding token */
        void		* buffer,					/* pointer to buffer for token */
        word		bufSize,					/* size of passed buffer */
        word		* bytesReturned);						/* number of bytes returned */

This routine loads a specified token's moniker into a provided buffer. The return value will be false if the moniker was found, true otherwise. The size of the returned moniker will be returned in the word pointed to by the bytesReturned parameter.

Pass this routine the following:

tokenChars
The four token characters that identify the token database entry. Create this dword from the four characters with the macro TOKEN_CHARS.
manufacturerID
The manufacturer ID number of the manufacturer responsible for the token database entry.
displayType
A value of DisplayType indicating the size of the display (used to indicate small-screen devices, primarily).
searchFlags
A record of VisMonikerSearchFlags indicating what type of moniker is being requested.
buffer
A pointer to a locked or fixed buffer into which the moniker will be copied.
bufSize
The size of the passed buffer; also the maximum size of the moniker that may be returned.
bytesReturned
The size of the moniker actually returned in the buffer.

Include: token.h

TokenLoadMonikerChunk()

Boolean	TokenLoadMonikerChunk(
        dword		tokenChars,					/* four characters of token */
        ManufacturerID		manufacturerID,					/* manufacturer ID of token */
        DisplayType		displayType,					/* type of display for token */
        VisMonikerSearchFlags searchFlags,							/* flags for finding token */
        MemHandle		lmemBlock,					/* locked block for new chunk */
        word		* chunkSize,					/* returned new chunk size */
        ChunkHandle		* chunkHandle);					/* returned new chunk handle */

This routine loads a specified token's moniker, allocating a new chunk in a local memory block for the moniker. The returned error flag will be true if the moniker was not found, false otherwise.

Pass this routine the following:

tokenChars
The four token characters that identify the token database entry. Create this dword from the four characters with the macro TOKEN_CHARS.
manufacturerID
The manufacturer ID number of the manufacturer responsible for the token database entry.
displayType
A value of DisplayType indicating the size of the display (used to indicate small-screen devices, primarily).
searchFlags
A record of VisMonikerSearchFlags indicating what type of moniker is being requested.
lmemBlock
The MemHandle of the local memory block in which the new chunk will be allocated. If the block is locked, you must dereference the global handle after calling this routine.
chunkSize
A pointer to a word in which the size of the allocated chunk will be returned.
chunkhandle
A pointer to a chunk handle in which the handle of the newly allocated chunk will be returned.

Warnings: This routine can move chunks in the passed block, thereby invalidating pointers to any chunk in the block.

Include: token.h

TokenLoadTokenBlock()

Boolean	TokenLoadTokenBlock(
        dword		tokenChars,					/* four characters of token */
        ManufacturerID		manufacturerID,					/* manufacturer ID of token */
        word		* blockSize,					/* returned size of new block */
        MemHandle		* blockHandle);					/* returned handle of block */

This routine loads the specified token's TokenEntry structure into a newly-allocated global memory block. If the token is not found, the returned error flag will be true ; otherwise, it will be false .

Pass this routine the following:

tokenChars
The four token characters that identify the token database entry. Create this dword from the four characters with the macro TOKEN_CHARS.
manufacturerID
The manufacturer ID number of the manufacturer responsible for the token database entry.
blockSize
A pointer to a word in which the size of the newly-allocated block will be returned.
blockHandle
A pointer to a global handle in which the handle of the newly-allocated block will be returned.

Include: token.h

TokenLoadTokenBuffer()

Boolean	TokenLoadTokenBuffer(
        dword		tokenChars,					/* four characters of token */
        ManufacturerID		manufacturerID,					/* manufacturer ID of token */
        TokenEntry		* buffer);					/* buffer for returned token */

This routine loads the specified token's TokenEntry structure into a passed buffer. The returned error flag will be true if the token was not found, false otherwise. Pass this routine the following:

tokenChars
The four token characters that identify the token database entry. Create this dword from the four characters with the macro TOKEN_CHARS.
manufacturerID
The manufacturer ID number of the manufacturer responsible for the token database entry.
buffer
A pointer to a locked or fixed buffer into which the token entry will be copied.

Include: token.h


Up: GEOS SDK TechDocs | Up | Prev: TokenDefineToken() ... | Next: TokenLoadTokenChunk() ...