sasstringbtreeenum_8h_source.html

 /*

  * Copyright (c) 2005-2014 IBM Corporation.

  * All rights reserved. This program and the accompanying materials

  * are made available under the terms of the Eclipse Public License v1.0

  * which accompanies this distribution, and is available at

  * http://www.eclipse.org/legal/epl-v10.html

  *

  * Contributors:

  *     IBM Corporation, Steven Munroe - initial API and implementation

  */


 #ifndef __SAS_STRINGBTREEENUM_H

 #define __SAS_STRINGBTREEENUM_H


 #include "sastype.h"

 #include "sasstringbtree.h"


 typedef void *SASStringBTreeEnum_t;


 #ifdef __cplusplus

 #define __C__ "C"

 #else

 #define __C__

 #endif


 extern __C__ SASStringBTreeEnum_t

 SASStringBTreeEnumCreate (SASStringBTree_t btree);


 extern __C__ SASStringBTreeEnum_t

 SASStringBTreeEnumCreateStartAt (SASStringBTree_t btree, char *start_key);


 extern __C__ void SASStringBTreeEnumDestroy (SASStringBTreeEnum_t sbtenum);


 extern __C__ int SASStringBTreeEnumHasMore (SASStringBTreeEnum_t sbtenum);


 extern __C__ long SASStringBTreeEnumCount (SASStringBTreeEnum_t sbtenum);


 extern __C__ char *SASStringBTreeEnumCurrent (SASStringBTreeEnum_t sbtenum);


 extern __C__ void *SASStringBTreeEnumNext (SASStringBTreeEnum_t sbtenum);


 extern __C__ void *SASStringBTreeEnumNext_nolock (SASStringBTreeEnum_t sbtenum);


 #endif /* __SAS_STRINGBTREEENUM_H */

SASStringBTreeEnum_t
void * SASStringBTreeEnum_t
Handle to an instance of String BTree Enumeration.
Definition: sasstringbtreeenum.h:113

SASStringBTreeEnumHasMore
__C__ int SASStringBTreeEnumHasMore(SASStringBTreeEnum_t sbtenum)
Return status of a SASStringBTreeEnum_t enumeration.

SASStringBTreeEnumDestroy
__C__ void SASStringBTreeEnumDestroy(SASStringBTreeEnum_t sbtenum)
Destroy an instance of SASStringBTreeEnum_t enumeration.

SASStringBTree_t
void * SASStringBTree_t
Handle to an instance of String B-tree.
Definition: sasstringbtree.h:102

SASStringBTreeEnumCreateStartAt
__C__ SASStringBTreeEnum_t SASStringBTreeEnumCreateStartAt(SASStringBTree_t btree, char *start_key)
Create a SASStringBTreeEnum_t enumeration that can be used to iterate over the name space of a String...

__C__
#define __C__
ignore this macro behind the curtain
Definition: sasmsync.h:32

SASStringBTreeEnumCreate
__C__ SASStringBTreeEnum_t SASStringBTreeEnumCreate(SASStringBTree_t btree)
Create a SASStringBTreeEnum_t enumeration that can be used to iterate over the name space of a String...

SASStringBTreeEnumCount
__C__ long SASStringBTreeEnumCount(SASStringBTreeEnum_t sbtenum)
Return number of entries a SASStringBTreeEnum_t enumeration contains.

SASStringBTreeEnumNext_nolock
__C__ void * SASStringBTreeEnumNext_nolock(SASStringBTreeEnum_t sbtenum)
Move the enumeration to the next String BTree key entry and return the associated address value...

sasstringbtree.h
Shared Address Space B-tree.

SASStringBTreeEnumCurrent
__C__ char * SASStringBTreeEnumCurrent(SASStringBTreeEnum_t sbtenum)
Return the C string pointer for the current enumeration key value.

SASStringBTreeEnumNext
__C__ void * SASStringBTreeEnumNext(SASStringBTreeEnum_t sbtenum)
Move the enumeration to the next String BTree key entry and return the associated address value...